TMsgPushInfo

推送相关配置

Hierarchy

TMsgPushInfo

Index

Properties

Optional forcePushContent

forcePushContent?: string

强推文本（可扩展为区别与普通推送的推送文本），长度限制 150 字符

Optional forcePushIDsList

forcePushIDsList?: string

强推的成员账号。

如不设置，则该参数默认为推送群内所有人，即等效于 "#%@all@%#"
注意该参数为string，例：'["id1", "id2"]'

Optional needForcePush

needForcePush?: boolean

群组消息强推开关，默认 false

当用户设置群消息免打扰 (updateMyMemberInfo#bitConfigMask) 时，可以通过强推将消息推送给用户
常用使用场景为 at 群成员时，使用强推将消息定向推给群内成员

Optional needPush

needPush?: boolean

是否需要推送。p2p会话默认为 true，群会话默认为 false

Optional needPushBadge

needPushBadge?: boolean

是否要做消息计数（推送消息后的 app 角标）

Optional needPushNick

needPushNick?: boolean

需要推送昵称。默认为是

Optional pushContent

pushContent?: string

推送文本。若不填，则消息的 body 字段会作为默认推送文本

Optional pushPayload

pushPayload?: string

第三方自定义的推送属性，长度2048。具体内容请参考文档：推送payload配置

example

nim.sendTextMsg({
   scene: 'p2p',
   to: 'test',
   body: 'message',
   pushInfo: {
       pushPayload: JSON.stringify({
           // 小米推送配置；注意，小米的推送字段不需要加 xiaomiField, xmField 前缀
           notify_foreground: 1
           // 华为推送配置
           hwField: {
             click_action: {}
           }
       })
   }
})