Skip to content

Views

hypha.apply.api.v1.reminder.views

SubmissionReminderViewSet

Bases: SubmissionNestedMixin, ListModelMixin, CreateModelMixin, GenericViewSet

permission_classes class-attribute instance-attribute 

permission_classes = (IsAuthenticated, IsApplyStaffUser)

serializer_class class-attribute instance-attribute 

serializer_class = SubmissionReminderSerializer

pagination_class class-attribute instance-attribute 

pagination_class = None

get_submission_object 

get_submission_object()
Source code in hypha/apply/api/v1/mixin.py 
8
9
def get_submission_object(self):
    return get_object_or_404(ApplicationSubmission, id=self.kwargs["submission_pk"])

get_queryset 

get_queryset()
Source code in hypha/apply/api/v1/reminder/views.py 
25
26
27
def get_queryset(self):
    submission = self.get_submission_object()
    return Reminder.objects.filter(submission=submission).order_by("-time")

perform_create 

perform_create(serializer)
Source code in hypha/apply/api/v1/reminder/views.py 
29
30
def perform_create(self, serializer):
    serializer.save(user=self.request.user, submission=self.get_submission_object())

destroy 

destroy(request, *args, **kwargs)
Source code in hypha/apply/api/v1/reminder/views.py 
32
33
34
35
36
def destroy(self, request, *args, **kwargs):
    reminder = self.get_object()
    reminder.delete()
    ser = self.get_serializer(self.get_queryset(), many=True)
    return Response(ser.data)

fields 

fields(request, *args, **kwargs)

List details of all the form fields that were created by admin for adding reminders.

These field details will be used in frontend to render the reminder form.

Source code in hypha/apply/api/v1/reminder/views.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
@action(detail=False, methods=["get"])
def fields(self, request, *args, **kwargs):
    """
    List details of all the form fields that were created by admin for adding reminders.

    These field details will be used in frontend to render the reminder form.
    """
    fields = [
        {
            "id": "title",
            "kwargs": {"required": True, "label": "Title", "max_length": 60},
            "type": "TextInput",
        },
        {
            "id": "description",
            "type": "textArea",
            "kwargs": {"label": "Description"},
            "widget": {"attrs": {"cols": 40, "rows": 5}, "type": "Textarea"},
        },
        {
            "id": "time",
            "kwargs": {"label": "Time", "required": True},
            "type": "DateTime",
        },
        {
            "id": "action",
            "kwargs": {
                "label": "Action",
                "required": True,
                "choices": Reminder.ACTIONS.items(),
                "initial": Reminder.REVIEW,
            },
            "type": "Select",
        },
    ]
    return Response(fields)