NotificationsApi
Import
Import
Constructors
Constructor
-
Parameters
-
Optional configuration: Configuration
-
basePath: string = ...
-
axios: AxiosInstance = ...
Returns NotificationsApi
-
Methods
Get Notifications Auth
-
Parameters
-
Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<NotificationAuth, any>>
-
Retrieves both a subscription token and a channel name that the user should use to subscribe to notifications. The Relationship Service updates the notifications channel as changes to the user's relationships occur. This includes updates to the presence state of any friends, new friend requests (i.e.
FRIEND_REQUEST
relationships created), etc. In general, the client should not depend on repeatedly polling the entire list of relationships to monitor for changes, but should instead fetch the entire list once and then register for notifications of any updates. This allows the client to keep the list up to date while minimizing overhead. ## Notification format: TBD - Provide details on the notification format when it is available.Get notification auth details.
{RequiredError}
NotificationsApi