Function NotificationsApiFactory

Returns {
    adminCreateNotification(groupId, appId, newMessage, options?) => AxiosPromise<void>;
    adminDeleteMessage(groupId, appId, messageId, options?) => AxiosPromise<void>;
    adminGetMessage(groupId, appId, messageId, options?) => AxiosPromise<Message>;
    adminListNotifications(groupId, appId, state?, options?) => AxiosPromise<any>;
    adminSendMessage(groupId, appId, messageId, options?) => AxiosPromise<void>;
    adminSetMessageType(groupId, appId, messageId, options?) => AxiosPromise<void>;
    adminUpdateMessage(groupId, appId, messageId, options?) => AxiosPromise<Message>;
}

• adminCreateNotification:function

  • adminCreateNotification(groupId, appId, newMessage, options?): AxiosPromise<void>

  • Create a push notification.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • newMessage: NewMessage

      The notification to create.

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Create a push notification

    Throws

• adminDeleteMessage:function

  • adminDeleteMessage(groupId, appId, messageId, options?): AxiosPromise<void>

  • Delete a push notification message.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • messageId: any

      Message ID

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Delete a push notification message

    Throws

• adminGetMessage:function

  • adminGetMessage(groupId, appId, messageId, options?): AxiosPromise<Message>

  • Retrieve a push notification message.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • messageId: any

      Message ID

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<Message>

    Summary

    Retrieve a push notification message

    Throws

• adminListNotifications:function

  • adminListNotifications(groupId, appId, state?, options?): AxiosPromise<any>

  • List push notifications.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • Optional state: MessageState

      Only list notifications with the given state.

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<any>

    Summary

    List push notifications

    Throws

• adminSendMessage:function

  • adminSendMessage(groupId, appId, messageId, options?): AxiosPromise<void>

  • Send a push notification.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • messageId: any

      Message ID

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Send a push notification

    Throws

• adminSetMessageType:function

  • adminSetMessageType(groupId, appId, messageId, options?): AxiosPromise<void>

  • Set a push notification's type.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • messageId: any

      Message ID

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Set a push notification's type

    Throws

• adminUpdateMessage:function

  • adminUpdateMessage(groupId, appId, messageId, options?): AxiosPromise<Message>

  • Update a push notification message.

    Parameters

    • groupId: any

      An Atlas Project/Group ID.

    • appId: any

      The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

    • messageId: any

      Message ID

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<Message>

    Summary

    Update a push notification

    Throws