Defines an API request.
constructFormdata() Constructs a FormData instance from an object.
the object to generate the FormData from
POST /api/auth/user/accept-guidelines/ - Promises to accept the user guidelines
POST /api/auth/users/:username/block/ - Promises to block a user by username
The username of the user to block
POST /api/auth/register/ (urlencoded) - Promises to create a user
The user's properties
delete() DELETE request
generateHeaders() A function used to generate the headers that need to be passed to the request performee.
get() GET request
GET /auth/auth/user/languages/ - Promises to get the user's languages
GET /api/auth/user/notifications-settings/ - Promises to retrieve the user's notification settings
GET /api/auth/blocked-users/ - Promises to get an array of blocked users
Query limitation parameters
Checks whether the request is authenticated
GET /api/auth/followers/ - Promises to get an array of followers
Query limitation parameters
Checks whether the request is authenticated
GET /api/auth/followings/ - Promises to get an array of followings
Query limitation parameters
Checks whether the request is authenticated
GET /api/auth/linked-users/ - Promises to get an array of linked users
Checks whether the request is authenticated
GET /api/auth/user/ - Promises to get a user by auth token
The authentication token
GET /api/auth/user/ - Promises to get a user by username
The username to search for
Checks whether the request is authenticated
GET /api/auth/user/ - Promises to get a user by a certain query
The search query
Checks whether the request is authenticated
POST /api/auth/email-check/ - Promises to check if an email address is available
The desired email address
POST /api/auth/username-check/ - Promises to check if a username is available
The desired username
POST /api/auth/login/ - Promises to log a user in
The username of the user
The password of the user
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/auth/users/:username/report/ - Promises to report a user
POST /api/auth/password/reset/ - Promises to initiate a password reset process
GET /api/auth/blocked-users/search/ - Promises to search between blocked users
The search query
The max number of results
GET /api/auth/followers/search - Promises to search between followers
GET /api/auth/followings/search - Promises to search between followings
GET /api/auth/linked-users/search/ - Promises to search a linked user
POST /api/auth/user/languages/ - Promises to set a new user language
The id of the desired language
PUT /api/auth/users/:username/notifications/subscribe - Promises to subscribe a user to notifications
The username of the user to subscribe
POST /api/auth/users/:username/unblock/ - Promises to unblock a user by username
The username of the user to unblock
DELETE /api/auth/users/:username/notifications/subscribe - Promises to unsubscribe a user from notifications
The username of the user to unsubscribe
POST /api/auth/user/notifications-settings/ - Promises to update the user's notification settings
PATCH /api/auth/user/ (urlencoded) - Promises to create a user
The user's properties
PATCH /api/auth/user/settings/ (urlencoded) - Promises to update the user's email
The desired email address
PATCH /api/auth/user/settings/ (urlencoded) - Promises to update the user's passord
The user's current password
The user's desired new password
POST /api/auth/email/verify/ - Promises to verify a user's email
The verification token
POST /api/auth/password/verify/ - Promises to verify a password
POST /api/auth/register/verify-token - Promises to verify a user token
the token to verify
Generated using TypeDoc
public AuthAPI - provides methods to interact with the Auth API