Class Messaging

Hierarchy (View Summary)

Constructors

constructor

Properties

apiBaseUrl auth endpoint endpointSingleton

Methods

apiRequest create delete get getAll getById parseMetadata post put remove sendMessageToDevice sendMessageToTopic subscribeToTopic unsubscribeFromAllTopics unsubscribeFromTopic update

Constructors

constructor

Properties

apiBaseUrl

apiBaseUrl: string

auth

auth: Auth

endpoint

endpoint: string = '/api/fcm'

endpointSingleton

endpointSingleton: string = '/api/fcm'

Methods

apiRequest

  • apiRequest(endpoint: string, method: string, data: any): Promise<any>

    Parameters

    • endpoint: string
    • method: string
    • data: any

    Returns Promise<any>

create

delete

get

  • get(
        endpoint: string,
        metadatas: Metadatas,
        query: null | { [key: string]: any },
    ): Promise<any>

    Parameters

    • endpoint: string
    • metadatas: Metadatas
    • query: null | { [key: string]: any }

    Returns Promise<any>

getAll

getById

parseMetadata

post

put

remove

sendMessageToDevice

  • sendMessageToDevice(
        deviceToken: string,
        payload: FcmMessagePayload,
    ): Promise<any>

    Send a message to a specific device

    Parameters

    • deviceToken: string

      The device token to send the message to

    • payload: FcmMessagePayload

      The message payload

    Returns Promise<any>

    Promise with the send result

sendMessageToTopic

subscribeToTopic

  • subscribeToTopic(
        topic: string,
        deviceToken: string,
        options?: object,
    ): Promise<any>

    Subscribe to a topic

    Parameters

    • topic: string

      The topic to subscribe to

    • deviceToken: string

      The device token to include in the payload

    • options: object = {}

      Additional options to include in the payload

    Returns Promise<any>

    Promise with the subscription result

unsubscribeFromAllTopics

  • unsubscribeFromAllTopics(deviceToken: string): Promise<any>

    Unsubscribe from all topics for a device

    Parameters

    • deviceToken: string

      The device token to unsubscribe from all topics

    Returns Promise<any>

    Promise with the unsubscription result

unsubscribeFromTopic

  • unsubscribeFromTopic(
        topic: string,
        deviceToken: string,
        options?: object,
    ): Promise<any>

    Unsubscribe from a topic

    Parameters

    • topic: string

      The topic to unsubscribe from

    • deviceToken: string

      The device token to include in the payload

    • options: object = {}

      Additional options to include in the payload

    Returns Promise<any>

    Promise with the unsubscription result

update

Settings

Member Visibility

On This Page

Constructors
Properties
Methods