Defines an API request.
constructFormdata() Constructs a FormData instance from an object.
the object to generate the FormData from
delete() DELETE request
DELETE /api/notifications/:id/ - promises to delete a notification
The ID of the notification
DELETE /api/notifications/ - promises to delete all notifications
generateHeaders() A function used to generate the headers that need to be passed to the request performee.
get() GET request
GET /api/notifications/:id/ - promises to get a notification
The ID of the notification
GET /api/notifications/ - promises to retrieve the user's notifications
The limitation rules
GET /api/notifications/unread/count - promises to get the count of the user's unread notifications
The limitation rules
patch() PATCH request
Request body
patchFormdata() PATCH request (multipart/form-data, application/x-www-form-urlencoded)
post() POST request
Request body
postFormdata() POST request (multipart/form-data, application/x-www-form-urlencoded)
put() PUT request
Request body
putFormdata() PUT request (multipart/form-data, application/x-www-form-urlencoded)
POST /api/notifications/:id/ - promises to mark a notification as read
The ID of the notification
POST /api/notifications/read/ - promises to mark notifications as read
The limitation rules
Generated using TypeDoc
public NotificationsAPI - Provides methods to interact with the Notifications API