Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ISendMsgOptions

发送消息时的可选项信息

Hierarchy

  • ISendMsgOptions

Index

Properties

Properties

messageType

messageType: string

消息类型，即消息结构的 ObjectName

content

content: { user?: IUserProfile; extra?: string }

消息内容

Type declaration

  • [key: string]: any

    消息内容 key-value，最终会进行 JSON 序列化后发送

  • Optional user?: IUserProfile

    消息可携带的用户数据

  • Optional extra?: string

    其他拓展信息

Optional isPersited

isPersited?: boolean

是否存储

description

只在发送未注册过的自定义消息时有效，否则使用注册时的配置

Optional isCounted

isCounted?: boolean

是否计数

description

只在发送未注册过的自定义消息时有效，否则使用注册时的配置

Optional isStatusMessage

isStatusMessage?: boolean

是否是状态消息，一般为无需注册的自定义消息

description
  1. 状态消息只有 pub，没有 ack 应答
  2. 状态消息默认不存储，不计数，isPersited 与 isCounted 配置将失效

Optional disableNotification

disableNotification?: boolean

是否发送静默消息

description

当值为 true 时，服务器将不会发送 Push 信息，移动端也不会弹出本地通知提醒

Optional pushContent

pushContent?: string

Push 信息

Optional pushData

pushData?: string

Push 通知携带的附加信息

Optional isMentioned

isMentioned?: boolean

是否为 @ 消息，只当 conversationType 值为 ConversationType.GROUP 时有效

Optional mentionedType

mentionedType?: 1 | 2

@ 消息类型

description

1: @ 所有人 2: @ 指定用户

Optional mentionedUserIdList

mentionedUserIdList?: string[]

被 @ 的用户 Id 列表，当 mentionedType 值为 1 时，该值可为空

Optional directionalUserIdList

directionalUserIdList?: string[]

用于发送群定向消息，只当 conversationType 值为 ConversationType.GROUP 时有效

Optional isVoipPush

isVoipPush?: boolean

当对方为 iOS 设备且未在线时，其将收到 Voip Push. 此配置对 Android 无影响

Optional canIncludeExpansion

canIncludeExpansion?: boolean

消息是否支持拓展内容

Optional expansion

expansion?: {}

消息拓展内容数据

Type declaration

  • [key: string]: string

Optional isFilerWhiteBlacklist

isFilerWhiteBlacklist?: boolean

黑/白名单

todo

功能未知，需确认

Optional pushConfig

pushConfig?: IPushConfig

移动端推送配置

Optional channelId

channelId?: string

会话业务标识

description

20 个字符长度限制

Optional messageId

messageId?: number

客户端的消息标识 重发消息时用到，重发消息的消息 ID

Optional isInterrupt

isInterrupt?: boolean

超级群专有字段，是否断档，若断档需要客户判断是否拉取