Options
All
  • Public
  • Public/Protected
  • All
Menu

Module QChatMsgServiceInterface

Index

Enumerations

Interfaces

Type Aliases

Type Aliases

DeleteMessageOptions

DeleteMessageOptions: { env?: string; ext?: string; message: Partial<QChatMessage>; ps?: string; pushContent?: string; pushPayload?: StrAnyObj; routeEnable?: boolean }

Type declaration

  • Optional env?: string

    抄送相关-环境变量

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

  • Optional ext?: string

    扩展字段

  • message: Partial<QChatMessage>

    要删除的消息内容

    其中必填 serverId、channelId、msgIdServer、time

  • Optional ps?: string

    操作附言

  • Optional pushContent?: string

    推送相关-推送内容

  • Optional pushPayload?: StrAnyObj

    推送相关-推送参数

  • Optional routeEnable?: boolean

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

    默认为 true

GetHistoryMessageOptions

GetHistoryMessageOptions: { beginTime?: number; channelId: string; endTime?: number; excludeMsgId?: string; limit?: number; reverse?: boolean; serverId: string }

Type declaration

  • Optional beginTime?: number

    查询条件-开始时间，默认 0，代表不限制

  • channelId: string

    所属的频道的id

  • Optional endTime?: number

    查询条件-结束时间，默认 0，代表不限制

  • Optional excludeMsgId?: string

    查询条件-上一条 msgIdServer（服务器生成的消息id）。

    注意：这个值只是辅助 beginTime 和 endTime 区间范围使用的，他的用处是在发送时间相同的两条消息里区分出来，而自身其实不能起到分页排序的关键。

    总之想要达成分页获取的目的，请传上一次获取到的消息体的 time 作为 beginTime/endTime，消息体的 msgIdServer 作为 excludeMsgId

  • Optional limit?: number

    分页参数。默认获取 100 条

  • Optional reverse?: boolean

    是否反向查询。

    默认 false 表示从 endTime 开始往前查找历史消息，

    true 表示从 beginTime 开始往后查找历史消息

  • serverId: string

    所属的服务器的id

GetMessageHistoryByIdsOptions

GetMessageHistoryByIdsOptions: { channelId: string; messageReferList: QChatMessageRefer[]; serverId: string }

Type declaration

  • channelId: string

    频道id

  • messageReferList: QChatMessageRefer[]

    “回复消息”列表

  • serverId: string

    服务器id

GetReferMessagesOptions

GetReferMessagesOptions: { message: QChatMessage; referType: TQChatMessageReferType }

Type declaration

  • message: QChatMessage

    某消息

  • referType: TQChatMessageReferType

    回复消息的类型

    默认 "all"，即查询被回复的消息以及根消息

    "reply"，只查询被回复的消息

    "thread"，只查询根消息

GetReferMessagesResult

GetReferMessagesResult: { replyMessage?: QChatMessage; threadMessage?: QChatMessage }

Type declaration

GetThreadMessagesOptions

GetThreadMessagesOptions: { message: QChatMessage; messageQueryOption: { beginTime?: number; endTime?: number; excludeMsgId?: string; limit?: number; reverse?: boolean } }

Type declaration

  • message: QChatMessage

    要查询的消息

    注：可以是根消息，也可以是子消息

  • messageQueryOption: { beginTime?: number; endTime?: number; excludeMsgId?: string; limit?: number; reverse?: boolean }

    查询条件 QChatMessageQueryOption

    • Optional beginTime?: number

      查询条件-开始时间，默认 0，代表不限制

    • Optional endTime?: number

      查询条件-结束时间，默认 0，代表不限制

    • Optional excludeMsgId?: string

      查询条件-上一条 msgIdServer（服务器生成的消息id）。

      注意：这个值只是辅助 beginTime 和 endTime 区间范围使用的，他的用处是在发送时间相同的两条消息里区分出来，而自身其实不能起到分页排序的关键。

      总之想要达成分页获取的目的，请传上一次获取到的消息体的 time 作为 beginTime/endTime，消息体的 msgIdServer 作为 excludeMsgId

    • Optional limit?: number

      分页参数。默认获取 100 条

    • Optional reverse?: boolean

      是否反向查询。

      默认 false 表示从 endTime 开始往前查找历史消息，

      true 表示从 beginTime 开始往后查找历史消息

GetThreadMessagesResult

GetThreadMessagesResult: { messages: QChatMessage[]; thread: QChatMessageRefer; threadInfo: { lastMessageTimestamp: number; messageCount: number } }

Type declaration

  • messages: QChatMessage[]

    查询到的thread历史消息

  • thread: QChatMessageRefer

    thread 根消息的消息引用结构

  • threadInfo: { lastMessageTimestamp: number; messageCount: number }

    thread聊天信息 QChatMessageThreadInfo

    • lastMessageTimestamp: number

      最后一条消息的时间戳

    • messageCount: number

      总回复数

GetThreadRootMessagesMetaOptions

GetThreadRootMessagesMetaOptions: { channelId: string; serverId: string; threadRootMessages: QChatMessage[] }

Type declaration

  • channelId: string

    频道的id

  • serverId: string

    服务器的id

  • threadRootMessages: QChatMessage[]

    要查询的 thread 根消息的列表

GetThreadRootMessagesMetaResult

GetThreadRootMessagesMetaResult: { msgIdServer: string; msgTime: number; timestamp: number; total: number }[]

MarkMesaageReadOptions

MarkMesaageReadOptions: { channelId: string; serverId: string; time: number }

Type declaration

  • channelId: string

    频道id

  • serverId: string

    服务器id

  • time: number

    时间戳，此频道你读过最新的消息的时间戳

MarkSystemNotificationsReadOptions

MarkSystemNotificationsReadOptions: { systemNotifications: QChatSystemNotification[] }

Type declaration

QChatGetLastMessageOfChannelsOptions

QChatGetLastMessageOfChannelsOptions: { channelIdList: string[]; serverId: string }

Type declaration

  • channelIdList: string[]

    channelId 列表

    注：channelId 要求属于这个 server 的

  • serverId: string

    服务器 ID

QChatGetLastMessageOfChannelsResult

QChatGetLastMessageOfChannelsResult: {}

Type declaration

QChatGetQuickCommentsOptions

QChatGetQuickCommentsOptions: { channelId: string; msgList: QChatMessage[]; serverId: string }

Type declaration

  • channelId: string

    消息所属的频道的id

  • msgList: QChatMessage[]

    消息列表，1次最多10条

  • serverId: string

    消息所属的服务器的id

QChatGetQuickCommentsResult

QChatGetQuickCommentsResult: {}

Type declaration

  • [key: string]: { channelId: string; details: QChatQuickCommentDetail[]; lastUpdateTime: number; msgIdServer: string; serverId: string; totalCount: number }

    key 为 msgIdServer

    • channelId: string

      消息所属的频道的id

    • details: QChatQuickCommentDetail[]

      评论详情列表

    • lastUpdateTime: number

      消息评论最后一次操作的时间

    • msgIdServer: string

      服务端给出的消息Id

    • serverId: string

      消息所属的服务器的id

    • totalCount: number

      获取总评论数

QChatMessage

QChatMessage: { accidsOfMentionedRoles?: string[]; antiSpamInfo?: QChatMessageAntiSpamInfo; attach?: UploadFileResult & QChatMessageForGEOAttach & {}; body?: string; callbackExt?: string; channelId: string; deliveryStatus?: TDeliveryStatus; env?: string; ext?: string; fromAccount: string; fromClientType?: TClientType; fromDeviceId?: string; fromNick?: string; historyEnable?: boolean; isAntispam?: boolean; mentionAccids?: string[]; mentionAll?: boolean; mentionRoleIds?: string[]; msgIdClient: string; msgIdServer: string; needBadge?: boolean; needPushNick?: boolean; notifyReason?: TNotifyReason; pushContent?: string; pushEnable?: boolean; pushPayload?: StrAnyObj; replyRefer?: QChatMessageRefer; resendFlag?: boolean; routeEnable?: boolean; serverId: string; status?: number; subType?: number; threadRefer?: QChatMessageRefer; time: number; type: TMsgType; updateContent?: { body?: string; ext?: string; status?: number }; updateOperatorInfo?: QChatMessageUpdateOperatorInfo; updateTime: number }

Type declaration

  • Optional accidsOfMentionedRoles?: string[]

    被艾特的人的账号列表（小server场景下使用）

  • Optional antiSpamInfo?: QChatMessageAntiSpamInfo

    反垃圾相关字段

  • Optional attach?: UploadFileResult & QChatMessageForGEOAttach & {}

    附加内容，type 为 custom，image，video，audio，file，geo 等类型都会附带这个

    其中 image，video，audio，file 作为文件类型，返回值是 UploadFileResult

    而 geo 的返回是 QChatMessageForGEOAttach

    而 custom 的返回一个可以随意 key-value 的对象

  • Optional body?: string

    消息的内容，type 为 text，tip 时有此值，其他的类型不一定有。

  • Optional callbackExt?: string

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

  • channelId: string

    消息所属的频道的id

  • Optional deliveryStatus?: TDeliveryStatus

    消息的送达状态，区分发送中，发送失败，发送成功三种。

  • Optional env?: string

    抄送相关-环境变量

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

  • Optional ext?: string

    扩展字段

  • fromAccount: string

    消息发送方, 帐号

  • Optional fromClientType?: TClientType

    发送方的设备类型

  • Optional fromDeviceId?: string

    发送端设备id

  • Optional fromNick?: string

    消息发送方的昵称

  • Optional historyEnable?: boolean

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

  • Optional isAntispam?: boolean

    是否触发反垃圾，而被拦截。默认 false

  • Optional mentionAccids?: string[]

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

  • Optional mentionAll?: boolean

    是否 “艾特” 了所有人

  • Optional mentionRoleIds?: string[]

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

  • msgIdClient: string

    SDK 端测生成的消息id，消息唯一凭证，主键

  • msgIdServer: string

    IM 服务端生成的消息 id，如果消息发送成功，服务器将会赋予这个值.

    注意：不要和上面的 serverId 概念混起来

  • Optional needBadge?: boolean

    开关位-推送相关：是否需要消息计数（APP 的角标计数）

  • Optional needPushNick?: boolean

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

  • Optional notifyReason?: TNotifyReason

    下发通知的原因

  • Optional pushContent?: string

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

  • Optional pushEnable?: boolean

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

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

  • Optional pushPayload?: StrAnyObj

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

  • Optional replyRefer?: QChatMessageRefer

    “回复消息”的引用

  • Optional resendFlag?: boolean

    是否为重发的消息

  • Optional routeEnable?: boolean

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

    默认为 true

  • serverId: string

    消息所属的服务器的id

  • Optional status?: number

    消息的状态

    0: 一般状态，默认。 1: 被撤回。 2: 被删除。 大于 10000 ，用户自定义。

  • Optional subType?: number

    消息子类型

  • Optional threadRefer?: QChatMessageRefer

    ”thread 根消息“引用

  • time: number

    消息发送成功的时间戳(单位毫秒)

  • type: TMsgType

    消息类型

  • Optional updateContent?: { body?: string; ext?: string; status?: number }

    消息在上次更新后的内容，当消息曾被更新过/删除过/撤回过时存在。

    • Optional body?: string

      消息更新后的 body 内容

      注，存在条件为：若消息更新时，有 body 的变动。

    • Optional ext?: string

      消息更新后的 ext 内容

      注，存在条件为：若消息更新时，有 ext 的变动。

    • Optional status?: number

      消息更新后的状态，定义同上文的 {@link QChatMessage.status | status}

      注，存在条件为：撤回，删除，或者更新消息为自定义状态。

  • Optional updateOperatorInfo?: QChatMessageUpdateOperatorInfo

    消息在上次更新后的操作信息

  • updateTime: number

    最后更新时间

QChatMessageAntiSpamInfo

QChatMessageAntiSpamInfo: { antiSpamBusinessId: string; antiSpamContent: string; antiSpamUsingYidun: boolean; useCustomContent: boolean; yidunAntiCheating: string; yidunAntiSpamExt: string; yidunAntiSpamRes: string; yidunCallback: string }

Type declaration

  • antiSpamBusinessId: string

    用户配置的对某些单条消息另外的反垃圾的业务ID

  • antiSpamContent: string

    开发者自定义的反垃圾字段, 如果提供了这个字段, 在过反垃圾时不会再使用content或者attach

  • antiSpamUsingYidun: boolean

    单条消息是否使用易盾反垃圾, 0:(在开通易盾的情况下)不过易盾反垃圾, 其他都是按照原来的规则

  • useCustomContent: boolean

    指定是否需要使用自定义反垃圾字段(即antiSpamContent) true:需要,false:不需要,默认不需要

  • yidunAntiCheating: string

    易盾反垃圾增强反作弊专属字段, 限制json, 长度限制1024

  • yidunAntiSpamExt: string

    易盾反垃圾扩展字段, 限制json, 长度限制1024

  • yidunAntiSpamRes: string

    易盾反垃圾返回的结果字段

  • yidunCallback: string

    易盾check的回调URL, 目前仅支持Audio类型的消息, 最长256个字符, 如果不合法则忽略该参数

QChatMessageForGEOAttach

QChatMessageForGEOAttach: { lat?: number; lng?: number; title?: string }

Type declaration

  • Optional lat?: number

    GEO 地理位置信息专属：纬度

  • Optional lng?: number

    GEO 地理位置信息专属：经度

  • Optional title?: string

    GEO 地理位置信息专属：所在地名称

QChatMessageRefer

QChatMessageRefer: { fromAccount: string; msgIdClient: string; msgIdServer: string; time: number }

消息引用结构，用于存在回复消息的情况

Type declaration

  • fromAccount: string

    消息发送者的账号

  • msgIdClient: string

    消息的 msgIdClient

  • msgIdServer: string

    消息的 msgIdServer

  • time: number

    消息发送时间

QChatMessageUpdateOperatorInfo

QChatMessageUpdateOperatorInfo: { ext?: string; operatorAccount: string; operatorClientType: TClientType; ps?: string; pushContent?: string; pushPayload?: StrAnyObj }

消息更新的操作信息

Type declaration

  • Optional ext?: string

    扩展字段

  • operatorAccount: string

    操作者账号 id

  • operatorClientType: TClientType

    操作者客户端类型

  • Optional ps?: string

    操作附言

  • Optional pushContent?: string

    推送相关-推送内容

  • Optional pushPayload?: StrAnyObj

    推送相关-推送参数

QChatQuickCommentDetail

QChatQuickCommentDetail: { count: number; hasSelf: boolean; severalAccids: string[]; type: number }

快捷评论的内容

Type declaration

  • count: number

    评论数量

  • hasSelf: boolean

    自己是否添加了该类型评论

  • severalAccids: string[]

    若干个添加了此类型评论的 account id 列表.

    注：不是按照操作时间排序的，可以认为是随机取了N个

  • type: number

    评论类型

QChatQuickCommentRequest

QChatQuickCommentRequest: { channelId: string; fromAccount: string; msgIdServer: string; opeAccid: string; opeType: number; serverId: string; time: number; type: number }

Type declaration

  • channelId: string

    消息所属的频道的id

  • fromAccount: string

    发送者的账号 id

  • msgIdServer: string

    服务端给出的消息Id

  • opeAccid: string

    该快捷评论的操作者的账号 id

  • opeType: number

    该快捷评论的操作类型

    注：1 为添加此快捷评论，2 为删除此快捷评论

  • serverId: string

    消息所属的服务器的id

  • time: number

    消息发送时间

  • type: number

    快捷评论的自定义类型

QChatSearchMsgByPageOptions

QChatSearchMsgByPageOptions: { channelId?: string; cursor?: string; fromAccid?: string; fromTime?: number; includeSelf?: boolean; keyword?: string; limit?: number; msgTypes: string[]; order?: TQChatSearchOrder; serverId: string; sort?: TSortType; subTypes?: number[]; toTime?: number }

Type declaration

  • Optional channelId?: string

    消息所属的频道的id

  • Optional cursor?: string

    查询游标

  • Optional fromAccid?: string

    消息发送者账号

  • Optional fromTime?: number

    开始时间

  • Optional includeSelf?: boolean

    可选、包含自己的消息， 默认不包含. 该字段如果为true，那么搜索的结果是包含自己的除subType限制之外条件的所有符合条件的消息。如果该字段为空，则搜索的结果是包含自己的受其他所有条件限制的消息

  • Optional keyword?: string

    检索关键字

  • Optional limit?: number

    查询数量, 默认100

  • msgTypes: string[]

    消息类型，必选 0-TEXT、 1-PICTURE、 3-VIDEO、 6-FILE 例：['0','1']

  • Optional order?: TQChatSearchOrder

    排序规则：ASC-升序 ,DESC-倒序 默认DESC

  • serverId: string

    消息所属的服务器的id

  • Optional sort?: TSortType

    sendTime-发送时间（默认）

  • Optional subTypes?: number[]

    消息子类型

  • Optional toTime?: number

    结束时间

QChatSearchMsgByPageResult

QChatSearchMsgByPageResult: { datas: QChatMessage[]; listQueryTag: { cursor: string; hasMore: boolean; nextTimetag: number } }

Type declaration

  • datas: QChatMessage[]
  • listQueryTag: { cursor: string; hasMore: boolean; nextTimetag: number }

    分页便捷选项

    • cursor: string

      查询游标，下次查询的起始位置

    • hasMore: boolean

      是否还有下一页

    • nextTimetag: number

      下一次翻页时的起始时间戳

QChatSendTypingEventOptions

QChatSendTypingEventOptions: { channelId: string; ext?: string; serverId: string }

Type declaration

  • channelId: string

    频道id

  • Optional ext?: string

    扩展字段，推荐使用 JSON 格式字符串。

  • serverId: string

    服务器id

QChatSystemNotification

QChatSystemNotification: { attach: { channelInfo?: ChannelInfo; event?: number; kickedAccids?: string[]; serverInfo?: ServerInfo; serverMember?: MemberInfo; type: TSystemMessageType }; channelId: string; ext?: string; fromAccount: string; fromClientType?: TClientType; fromDeviceId?: string; fromNick?: string; msgIdClient?: string; msgIdServer: string; needBadge?: boolean; needPushNick?: boolean; persistEnable?: boolean; pushContent?: string; pushEnable?: boolean; pushPayload?: StrAnyObj; resendFlag?: boolean; serverId: string; status?: number; time: number; toAccids?: string[]; type: TSystemMessageType; updateTime: number }

Type declaration

  • attach: { channelInfo?: ChannelInfo; event?: number; kickedAccids?: string[]; serverInfo?: ServerInfo; serverMember?: MemberInfo; type: TSystemMessageType }

    系统通知的附加信息

    • [key: string]: any
    • Optional channelInfo?: ChannelInfo

      举例若是更新了某个频道，那么通知里 attach 携带要更新的频道的信息

    • Optional event?: number

      收到type为channelVisibilityUpdate或serverEnterLeave会有这个字段 event=1表示进入服务器/频道，event=2表示推出服务器/频道

    • Optional kickedAccids?: string[]

      若 type 为 serverMemberKick，把某人踢出服务器，那么通知里 attach 里携带被踢人的账号

    • Optional serverInfo?: ServerInfo

      举例加入某个服务器，那么通知里 attach 里携带想要加入的服务器信息

    • Optional serverMember?: MemberInfo

      举例若是修改了服务器上自己或者其他人的信息，那么通知里 attach 携带变更后的成员信息

    • type: TSystemMessageType
  • channelId: string

    通知所属的频道的id

  • Optional ext?: string

    自定义系统通知可追加的扩展字段

  • fromAccount: string

    系统通知的来源, account id

  • Optional fromClientType?: TClientType

    发送方的设备类型

  • Optional fromDeviceId?: string

    发送端设备id

  • Optional fromNick?: string

    消息发送方的昵称

  • Optional msgIdClient?: string

    SDK 端测生成的消息id，自定义的系统通知里才存在。可以用于去重

  • msgIdServer: string

    IM 服务端生成的系统通知 id，作为系统消息的唯一凭证。

    注意，只有当这条系统通知存离线 (persistEnable = true)，才会有此字段，否则都为 "0"

  • Optional needBadge?: boolean

    开关位-推送相关：是否需要消息计数

  • Optional needPushNick?: boolean

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

  • Optional persistEnable?: boolean

    开关位：是否可以存入离线通知。默认 false

    注意：只有 toAccids 不为空，才能设置为存离线。

  • Optional pushContent?: string

    自定义推送文案

  • Optional pushEnable?: boolean

    开关位-推送相关：是否需要推送。默认 false

  • Optional pushPayload?: StrAnyObj

    第三方自定义的推送属性，限制 json

  • Optional resendFlag?: boolean

    是否为重发的

  • serverId: string

    通知所属的服务器的id

  • Optional status?: number

    系统通知状态，0 为 默认。大于 10000 为用户自定义的状态

  • time: number

    通知发送成功的时间戳(单位毫秒)

  • Optional toAccids?: string[]

    系统通知的目标账号 account id 列表 即收到这条消息的账号列表

  • type: TSystemMessageType

    系统通知类型

    频道相关的有 ... 服务器相关的 .... 其他的如自定义的系统通知等类型。

  • updateTime: number

    最后更新时间

QChatUpdateQuickCommentOptions

QChatUpdateQuickCommentOptions: { commentMessage: QChatMessage; type: number }

Type declaration

  • commentMessage: QChatMessage

    被评论消息

  • type: number

    评论类型

ReplyMessageOptions

ReplyMessageOptions: SendMessageOptions & IUploadFileOptions & { replyMessage: QChatMessage }

回复消息的入参 = 普通消息类型定义 + 文件类型的扩展 + 回复消息的扩展

RovokeMessageOptions

RovokeMessageOptions: { env?: string; ext?: string; message: Partial<QChatMessage>; ps?: string; pushContent?: string; pushPayload?: StrAnyObj; routeEnable?: boolean }

Type declaration

  • Optional env?: string

    抄送相关-环境变量

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

  • Optional ext?: string

    扩展字段

  • message: Partial<QChatMessage>

    要撤回的消息内容

    其中必填 serverId、channelId、msgIdServer、time

  • Optional ps?: string

    操作附言

  • Optional pushContent?: string

    推送相关-推送内容

  • Optional pushPayload?: StrAnyObj

    推送相关-推送参数

  • Optional routeEnable?: boolean

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

    默认为 true

SendMessageOptions

SendMessageOptions: { antiSpamInfo?: QChatMessageAntiSpamInfo; attach?: UploadFileResult & QChatMessageForGEOAttach & {}; body?: string; callbackExt?: string; channelId: string; env?: string; ext?: string; historyEnable?: boolean; mentionAccids?: string[]; mentionAll?: boolean; mentionRoleIds?: string[]; needBadge?: boolean; needPushNick?: boolean; pushContent?: string; pushEnable?: boolean; pushPayload?: StrAnyObj; routeEnable?: boolean; serverId: string; subType?: number; type: TMsgType; onSendBefore?: any }

Type declaration

  • Optional antiSpamInfo?: QChatMessageAntiSpamInfo

    反垃圾相关字段

  • Optional attach?: UploadFileResult & QChatMessageForGEOAttach & {}

    附加内容（自定义，geo 等类型的消息需要附带这个）

  • Optional body?: string

    消息的内容（若是文件类型的消息，那么这个字段可以不用填）

  • Optional callbackExt?: string

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

  • channelId: string

    消息所属的频道的id

  • Optional env?: string

    抄送相关-环境变量

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

  • Optional ext?: string

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

  • Optional historyEnable?: boolean

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

  • Optional mentionAccids?: string[]

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

  • Optional mentionAll?: boolean

    是否 “艾特” 了所有人

  • Optional mentionRoleIds?: string[]

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

  • Optional needBadge?: boolean

    开关位-推送相关：是否需要消息计数（APP 的角标计数）

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

  • Optional needPushNick?: boolean

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

  • Optional pushContent?: string

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

  • Optional pushEnable?: boolean

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

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

  • Optional pushPayload?: StrAnyObj

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

  • Optional routeEnable?: boolean

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

    默认为 true

  • serverId: string

    消息所属的服务器的id

  • Optional subType?: number

    消息子类型

  • type: TMsgType

    消息类型

  • onSendBefore?:function

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

      Parameters

      Returns void

SendSystemNotificationOptions

SendSystemNotificationOptions: { attach?: {}; body: string; channelId: string; env?: string; ext?: string; persistEnable?: boolean; pushContent?: string; pushPayload?: StrAnyObj; resendFlag?: boolean; routeEnable?: boolean; serverId: string; toAccids?: string[] }

Type declaration

  • Optional attach?: {}

    内建系统通知的附加信息, JSON 对象

    • [key: string]: any
  • body: string

    通知内容

  • channelId: string

    通知所属的频道的id

  • Optional env?: string

    抄送相关-环境变量

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

  • Optional ext?: string

    自定义系统通知可追加的扩展字段

  • Optional persistEnable?: boolean

    开关位：是否可以存入离线通知。默认 false

    注意：只有 toAccids 不为空，才能设置为存离线。

  • Optional pushContent?: string

    自定义推送文案

  • Optional pushPayload?: StrAnyObj

    第三方自定义的推送属性，限制 json

  • Optional resendFlag?: boolean

    是否为重发的

  • Optional routeEnable?: boolean

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

    默认为 true

  • serverId: string

    通知所属的服务器的id

  • Optional toAccids?: string[]

    通知的目标, account id 列表

TDeliveryStatus

TDeliveryStatus: keyof typeof EDeliveryStatus

消息的送达状态，区分发送中，发送失败，发送成功三种。

TMsgType

TMsgType: keyof typeof EMsgType

TNotifyReason

TNotifyReason: keyof typeof ENotifyReason

TQChatMessageReferType

TQChatMessageReferType: keyof typeof EQChatMessageReferType

TSortType

TSortType: keyof typeof QChatEServerSortType

TSystemMessageType

TSystemMessageType: keyof typeof ESystemMessageType

UpdateMessageOptions

UpdateMessageOptions: { env?: string; ext?: string; message: { antiSpamInfo?: QChatMessageAntiSpamInfo; body?: string; channelId: string; ext?: string; msgIdServer: string; serverId: string; status?: number; subType?: number; time: number }; ps?: string; pushContent?: string; pushPayload?: StrAnyObj; routeEnable?: boolean }

Type declaration

  • Optional env?: string

    抄送相关-环境变量

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

  • Optional ext?: string

    扩展字段

  • message: { antiSpamInfo?: QChatMessageAntiSpamInfo; body?: string; channelId: string; ext?: string; msgIdServer: string; serverId: string; status?: number; subType?: number; time: number }

    要更新的消息内容

    其中必填 serverId、channelId、msgIdServer、time 用于区分消息

    其中选填 body、ext、作为可更新的内容

    • Optional antiSpamInfo?: QChatMessageAntiSpamInfo

      反垃圾相关字段

    • Optional body?: string

      消息的内容

    • channelId: string

      消息所属的频道的id

    • Optional ext?: string

      扩展字段

    • msgIdServer: string

      IM 服务端生成的消息 id，如果消息发送成功，服务器将会赋予这个值.

      注意：不要和上面的 serverId 概念混起来

    • serverId: string

      消息所属的服务器的id

    • Optional status?: number

      消息的状态，必须大于等于 10000，视为自定义状态

    • Optional subType?: number

      消息子类型

    • time: number

      消息发送成功的时间戳(单位毫秒)

  • Optional ps?: string

    操作附言

  • Optional pushContent?: string

    推送相关-推送内容

  • Optional pushPayload?: StrAnyObj

    推送相关-推送参数

  • Optional routeEnable?: boolean

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

    默认为 true

UpdateSystemNotificationOptions

UpdateSystemNotificationOptions: { env?: string; ext?: string; ps?: string; pushContent?: string; pushPayload?: StrAnyObj; routeEnable?: boolean; systemNotification: Partial<QChatSystemNotification> }

Type declaration

  • Optional env?: string

    抄送相关-环境变量

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

  • Optional ext?: string

    扩展字段

  • Optional ps?: string

    操作附言

  • Optional pushContent?: string

    推送相关-推送内容

  • Optional pushPayload?: StrAnyObj

    推送相关-推送参数

  • Optional routeEnable?: boolean

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

    默认为 true

  • systemNotification: Partial<QChatSystemNotification>

    要更新的系统通知内容

    其中必填 msgIdServer、type

    其中选填 body、ext、status 作为可更新的内容