Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PushConfig

Push notification configuration for a message. Allows customization of push title, content, and platform-specific settings.

example
const params = new SendTextMessageParams({ text: 'Hello' });
params.pushConfig = {
  pushTitle: 'New Message',
  pushContent: 'You have a new message',
};

Hierarchy

  • Omit<IPushConfig, "harmonyOSConfig" | "androidConfig" | "iOSConfig">
    • PushConfig

Index

Properties

Properties

pushTitle

pushTitle: string

Push notification title If not set, the following default title display rules will be applied Default title display rules: Built-in messages: For one-to-one chat notifications, the sender's name is displayed as the title; for group chat notifications, the group name is displayed as the title. Custom messages: No title is displayed by default.

pushContent

pushContent: string

Push content Prefer using IPushConfig.pushContent. If not available, use the pushContent parameter from the sent message.

pushData

pushData: string

Remote push additional information Prefer using IPushConfig.pushData. If not available, use the pushContent parameter from the message being sent.

Optional disablePushTitle

disablePushTitle?: boolean

Indicates whether to display the push notification title. This is only applicable to the iOS platform.

Optional forceShowDetailContent

forceShowDetailContent?: boolean

Whether to force push

Optional templateId

templateId?: string

Push notification template ID

Optional androidConfig

androidConfig?: AndroidPushConfig

Android-specific push configuration

Optional iOSConfig

iOSConfig?: IOSPushConfig

iOS-specific push configuration