Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • SendMessageOptions

Index

Properties

反垃圾相关字段

附加内容(自定义,geo 等类型的消息需要附带这个)

body?: string

消息的内容(若是文件类型的消息,那么这个字段可以不用填)

callbackExt?: string

抄送相关-第三方回调扩展字段

channelId: string

消息所属的频道的id

env?: string

抄送相关-环境变量

注:开发者可以根据不同的 env 配置不同的抄送和回调地址。仅当 routeEnable 为 true 时生效

ext?: string

扩展字段,推荐传递 JSON 格式化的字符串

historyEnable?: boolean

是否存云端消息历史,缺省则 true

mentionAccids?: string[]

被 “艾特” 的人的 account id 列表

mentionAll?: boolean

是否 “艾特” 了所有人

mentionRoleIds?: string[]

被艾特的身份组的roleId列表(大server场景下使用)

needBadge?: boolean

开关位-推送相关:是否需要消息计数(APP 的角标计数)

注意:该参数设置作用于服务器推送给移动端设备,JS SDK 只作设置

needPushNick?: boolean

开关位-推送相关:是否需要推送昵称

pushContent?: string

移动端 APP 推送相关-推送内容

pushEnable?: boolean

开关位-推送相关:是否开启推送

注意:该参数设置作用于服务器推送给移动端设备,JS SDK 只作设置

pushPayload?: StrAnyObj

移动端 APP 推送相关-推送属性

routeEnable?: boolean

开关位-抄送相关:消息是否需要抄送。

默认为 true

serverId: string

消息所属的服务器的id

subType?: number

消息子类型

type: "text" | "image" | "audio" | "video" | "geo" | "notification" | "file" | "tip" | "robot" | "g2" | "custom"

消息类型

Methods

  • 发送前的回调函数,用于发送前拿到这个消息对象 此时这个消息对象还没有 idServer 和准确的 time,并且 status 也只是在 sending

    Parameters

    Returns void