Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ChatPushManager

export manager

Hierarchy

  • Native
    • ChatPushManager

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Static Private TAG

TAG: string = 'ChatPushManager'

Methods

fetchPreferredNotificationLanguage

  • fetchPreferredNotificationLanguage(): Promise<undefined | string>

  • Gets the configured push translation language.

    throws

    A description of the exception. See ChatError.

    Returns Promise<undefined | string>

    The language code.

fetchPushOptionFromServer

  • Gets the push configurations from the server.

    throws

    A description of the exception. See ChatError.

    Returns Promise<ChatPushOption>

    The push options.

fetchSelectedPushTemplate

  • fetchSelectedPushTemplate(): Promise<undefined | string>

  • Gets the selected push template for offline push.

    throws

    A description of the exception. See ChatError.

    Returns Promise<undefined | string>

    The name of the selected push template.

fetchSilentModeForAll

  • Gets the do-not-disturb settings of the app.

    throws

    A description of the exception. See ChatError.

    Returns Promise<ChatSilentModeResult>

    The do-not-disturb settings of the app.

fetchSilentModeForConversation

  • Gets 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.

    Parameters

    Returns Promise<ChatSilentModeResult>

    The offline push settings of the conversation.

fetchSilentModeForConversations

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

    throws

    A description of the exception. See ChatError.

    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.

removeSilentModeForConversation

  • removeSilentModeForConversation(params: { convId: string; convType: ChatConversationType }): Promise<void>

  • Clears the offline push settings of the conversation.

    After clearing, the conversation uses the offline push settings of the app. See {@link EMPushManager.setSilentModeForAll}.

    params

    params

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

    A description of the exception. See ChatError.

    Parameters

    Returns Promise<void>

selectPushTemplate

  • selectPushTemplate(templateName: string): Promise<void>

  • Selects the push template for offline push.

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

    throws

    A description of the exception. See ChatError.

    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>

setNativeListener

  • setNativeListener(_event: NativeEventEmitter): void

  • Parameters

    • _event: NativeEventEmitter

    Returns void

setPreferredNotificationLanguage

  • setPreferredNotificationLanguage(languageCode: string): Promise<void>

  • Sets the target translation language of offline push notifications.

    throws

    A description of the exception. See ChatError.

    Parameters

    Returns Promise<void>

setSilentModeForAll

  • Sets the offline push of the app.

    throws

    A description of the exception. See ChatError.

    Parameters

    Returns Promise<void>

setSilentModeForConversation

updatePushDisplayStyle

  • Updates the display style of push notifications.

    The default value is ChatPushDisplayStyle.Simple.

    throws

    A description of the exception. See ChatError.

    Parameters

    • displayStyle: ChatPushDisplayStyle = ChatPushDisplayStyle.Simple

      The display style of push notifications.

    Returns Promise<void>

updatePushNickname

  • updatePushNickname(nickname: string): 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.

    throws

    A description of the exception. See ChatError.

    Parameters

    • nickname: string

      The nickname of the sender displayed in push notifications.

    Returns Promise<void>

Static Protected _callMethod

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

  • Type Parameters

    • T

    Parameters

    • method: string
    • Optional args: {}

      Returns Promise<T>

    Static Protected checkErrorFromResult

    • checkErrorFromResult(result: any): void

    • Parameters

      • result: any

      Returns void

    Generated using TypeDoc