Documentation

NotificationsApi

Import

Import

  • const { NotificationsApi } = require("@unity-services/friends-1.0");

Constructors

Constructor

Methods

Get Notifications Auth

  • getNotificationsAuth(options?: AxiosRequestConfig<any>): 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.

    summary

    Get notification auth details.

    throws

    {RequiredError}

    memberof

    NotificationsApi

    Parameters

    • Optional options: AxiosRequestConfig<any>

    Returns Promise<AxiosResponse<NotificationAuth, any>>