Function NotificationsApiFp

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

• adminCreateNotification:function

  • adminCreateNotification(groupId, appId, newMessage, options?): Promise<((axios?, basePath?) => 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: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Create a push notification

    Throws

• adminDeleteMessage:function

  • adminDeleteMessage(groupId, appId, messageId, options?): Promise<((axios?, basePath?) => 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: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Delete a push notification message

    Throws

• adminGetMessage:function

  • adminGetMessage(groupId, appId, messageId, options?): Promise<((axios?, basePath?) => 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: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<Message>)>

    Summary

    Retrieve a push notification message

    Throws

• adminListNotifications:function

  • adminListNotifications(groupId, appId, state?, options?): Promise<((axios?, basePath?) => 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: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<any>)>

    Summary

    List push notifications

    Throws

• adminSendMessage:function

  • adminSendMessage(groupId, appId, messageId, options?): Promise<((axios?, basePath?) => 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: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Send a push notification

    Throws

• adminSetMessageType:function

  • adminSetMessageType(groupId, appId, messageId, options?): Promise<((axios?, basePath?) => 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: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    Set a push notification's type

    Throws

• adminUpdateMessage:function

  • adminUpdateMessage(groupId, appId, messageId, options?): Promise<((axios?, basePath?) => 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: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<Message>)>

    Summary

    Update a push notification

    Throws