Class ChatPushManager

The class for message push configuration options.

Hierarchy

  • Native
    • ChatPushManager

Constructors

constructor

Methods

fetchPreferredNotificationLanguage fetchPushOptionFromServer fetchSelectedPushTemplate fetchSilentModeForAll fetchSilentModeForConversation fetchSilentModeForConversations removeSilentModeForConversation selectPushTemplate setNativeListener setPreferredNotificationLanguage setSilentModeForAll setSilentModeForConversation updatePushDisplayStyle updatePushNickname _callMethod checkErrorFromResult

Constructors

constructor

Methods

fetchPreferredNotificationLanguage

  • fetchPreferredNotificationLanguage(): Promise<undefined | string>

  • Gets the configured push translation language.

    Returns Promise<undefined | string>

    The language code.

    Throws

    A description of the exception. See ChatError.

fetchPushOptionFromServer

  • fetchPushOptionFromServer(): Promise<ChatPushOption>

  • Gets the push configurations from the server.

    Returns Promise<ChatPushOption>

    The push options.

    Throws

    A description of the exception. See ChatError.

fetchSelectedPushTemplate

  • fetchSelectedPushTemplate(): Promise<undefined | string>

  • Gets the selected push template for offline push.

    Returns Promise<undefined | string>

    The name of the selected push template.

    Throws

    A description of the exception. See ChatError.

fetchSilentModeForAll

fetchSilentModeForConversation

  • fetchSilentModeForConversation(params): Promise<ChatSilentModeResult>

  • Gets the offline push settings of the conversation.

    Parameters

    Returns Promise<ChatSilentModeResult>

    The offline push settings of the conversation.

    Params

    params

    • convId: The conversation ID.
    • convType: The conversation type.

    Throws

    A description of the exception. See ChatError.

fetchSilentModeForConversations

  • fetchSilentModeForConversations(conversations): Promise<Map<string, ChatSilentModeResult>>

  • Gets the do-not-disturb settings of the specified conversations.

    Parameters

    Returns Promise<Map<string, ChatSilentModeResult>>

    The do-not-disturb settings of the specified conversations, which are key-value pairs where the key is the conversation ID and the value is the do-not-disturb settings.

    Throws

    A description of the exception. See ChatError.

removeSilentModeForConversation

  • removeSilentModeForConversation(params): Promise<void>

  • Clears the offline push settings of the conversation.

    After clearing, the conversation uses the offline push settings of the app. See EMPushManager.setSilentModeForAll.

    Parameters

    Returns Promise<void>

    Params

    params

    • convId: The conversation ID.
    • convType: The conversation type.

    Throws

    A description of the exception. See ChatError.

selectPushTemplate

  • selectPushTemplate(templateName): Promise<void>

  • Selects the push template for offline push.

    The push template can be set with a RESTful API or on the console.

    Parameters

    • templateName: string

      The push template name. If the template name does not exist, this template does not take effect, although no error is returned.

    Returns Promise<void>

    Throws

    A description of the exception. See ChatError.

setNativeListener

  • setNativeListener(_event): void

  • Parameters

    • _event: NativeEventEmitter

    Returns void

setPreferredNotificationLanguage

  • setPreferredNotificationLanguage(languageCode): Promise<void>

  • Sets the target translation language of offline push notifications.

    Parameters

    Returns Promise<void>

    Throws

    A description of the exception. See ChatError.

setSilentModeForAll

  • setSilentModeForAll(option): Promise<void>

  • Sets the offline push of the app.

    Parameters

    Returns Promise<void>

    Throws

    A description of the exception. See ChatError.

setSilentModeForConversation

  • setSilentModeForConversation(params): Promise<void>

  • Sets the offline push for the conversation.

    Parameters

    Returns Promise<void>

    Params

    params

    • convId: The conversation ID.
    • convType: The conversation type.
    • option: The configuration options for the offline push.

    Throws

    A description of the exception. See ChatError.

updatePushDisplayStyle

  • updatePushDisplayStyle(displayStyle?): Promise<void>

  • Updates the display style of push notifications.

    The default value is ChatPushDisplayStyle.Simple.

    Parameters

    • displayStyle: ChatPushDisplayStyle = ChatPushDisplayStyle.Simple

      The display style of push notifications.

    Returns Promise<void>

    Throws

    A description of the exception. See ChatError.

updatePushNickname

  • updatePushNickname(nickname): Promise<void>

  • Updates nickname of the sender displayed in push notifications.

    This nickname can be different from the nickname in the user profile; however, we recommend that you use the same nickname for both. Therefore, if either nickname is updated, the other should be changed at the same time.

    To update the nickname in the user profile, you can call ChatUserInfoManager.updateOwnUserInfo.

    Parameters

    • nickname: string

      The nickname of the sender displayed in push notifications.

    Returns Promise<void>

    Throws

    A description of the exception. See ChatError.

Protected Static_callMethod

  • _callMethod<T>(method, args?): Promise<T>

  • Type Parameters

    • T

    Parameters

    • method: string
    • Optionalargs: {}

      Returns Promise<T>

    Protected StaticcheckErrorFromResult

    • checkErrorFromResult(result): void

    • Parameters

      • result: any

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods