高级消息

msgID: string

消息 ID(消息创建的时候为空,消息发送的时候会生成)

timestamp: number

消息的 UTC 时间戳

sender: string

消息发送者

nickName: string

消息发送者昵称

friendRemark: string

消息发送者好友备注

nameCard: string

如果是群组消息,nameCard 为发送者的群名片

faceURL: string

消息发送者头像 在 C2C 场景下,陌生人的头像不会实时更新,如需更新陌生人的头像(如在 UI 上点击陌生人头像以展示陌生人信息时), 请调用 V2TIMManager.h -> GetUsersInfo 接口触发信息的拉取。待拉取成功后,SDK 会更新本地头像信息,即 faceURL 字段的内容。

Note

请不要在收到每条消息后都去 GetUsersInfo,会严重影响程序性能。

groupID?: string

如果是群组消息,groupID 为会话群组 ID,否则为空

userID?: string

如果是单聊消息,userID 为会话用户 ID,否则为空, 假设自己和 userA 聊天,无论是自己发给 userA 的消息还是 userA 发给自己的消息,这里的 userID 均为 userA

seq: number

群聊中的消息序列号云端生成,在群里是严格递增且唯一的, 单聊中的序列号是本地生成,不能保证严格递增且唯一。

random: number

消息随机码

消息发送状态

supportMessageExtension: boolean

是否支持消息扩展(6.7 及其以上版本支持,需要您购买旗舰版套餐) 社群(Community)和直播群(AVChatRoom)消息不支持该功能。 您需要先到 IM 控制台配置该功能。

isSelf: boolean

消息发送者是否是自己

needReadReceipt: boolean

消息是否需要已读回执

Note

群聊消息 6.1 及以上版本支持该特性,需要您先到 IM 控制台配置支持已读回执的群类型。 单聊消息 6.2 及以上版本支持该特性。 群聊消息和单聊消息都需要购买旗舰版套餐包。

isBroadcastMessage: boolean

是否是广播消息,仅直播群支持(6.5 及以上版本支持,需要您购买旗舰版套餐)

消息优先级(只有 onRecvNewMessage 收到的 V2TIMMessage 获取有效)

groupAtUserList: string[]

群消息中被 @ 的用户 UserID 列表(即该消息都 @ 了哪些人)

elemType: V2TIMElemType

消息元素类型

textElem?: V2TIMTextElem

消息类型 为 V2TIM_ELEM_TYPE_TEXT,textElem 会存储文本消息内容

customElem?: V2TIMCustomElem

消息类型 为 V2TIM_ELEM_TYPE_CUSTOM,customElem 会存储自定义消息内容

imageElem?: V2TIMImageElem

消息类型 为 V2TIM_ELEM_TYPE_IMAGE,imageElem 会存储图片消息内容

soundElem?: V2TIMSoundElem

消息类型 为 V2TIM_ELEM_TYPE_SOUND,soundElem 会存储语音消息内容

videoElem?: V2TIMVideoElem

消息类型 为 V2TIM_ELEM_TYPE_VIDEO,videoElem 会存储视频消息内容

fileElem?: V2TIMFileElem

消息类型 为 V2TIM_ELEM_TYPE_FILE,fileElem 会存储文件消息内容

locationElem?: V2TIMLocationElem

消息类型 为 V2TIM_ELEM_TYPE_LOCATION,locationElem 会存储地理位置消息内容

faceElem?: V2TIMFaceElem

消息类型 为 V2TIM_ELEM_TYPE_FACE,faceElem 会存储表情消息内容

mergerElem?: V2TIMMergerElem

消息类型 为 V2TIM_ELEM_TYPE_MERGER,mergerElem 会存储转发消息内容

groupTipsElem?: V2TIMGroupTipsElem

消息类型 为 V2TIM_ELEM_TYPE_GROUP_TIPS,groupTipsElem 会存储群 tips 消息内容

cloudCustomData: ArrayBuffer

消息自定义数据(云端保存,会发送到对端,程序卸载重装后还能拉取到)

isExcludedFromUnreadCount: boolean

消息是否不计入会话未读数:默认为 false,表明需要计入会话未读数,设置为 true,表明不需要计入会话未读数 5.3.425 及以上版本支持, 会议群(Meeting)默认不支持该字段

isExcludedFromLastMessage: boolean

消息是否不计入会话 lastMsg:默认为 false,表明需要计入会话 lastMsg,设置为 true,表明不需要计入会话 lastMsg

customModerationConfigurationID: String

消息自定义审核配置 ID(从 7.8 版本开始支持) 在开通【云端审核】功能后,您可以请前往 控制台 (云端审核 -> 审核配置 -> 自定义配置 -> 添加自定义配置) 获取配置 ID。 【自定义审核】配置流程请参考 [云端审核功能](https://cloud.tencent.com/document/product/269/78633#a5efc9e8-a7ec-40e3-9b18-8ed1910f589c)

Note

该字段需要发消息前设置,仅用于控制发消息时的消息审核策略,其值不会存储在漫游和本地。

isExcludedFromContentModeration: boolean

消息是否不过内容审核(【云端审核】) 只有在开通【云端审核】功能后,isExcludedFromContentModeration 设置才有效,设置为 true,表明不过内容审核,设置为 false:表明过内容审核。 【云端审核】开通流程请参考 云端审核功能

isIdentifiedAsRiskMessage: boolean

是否被标记为有安全风险的消息(从 7.4 版本开始支持) 暂时只支持图片和视频消息。 只有在开通【云端审核】功能后才生效,【云端审核】开通流程请参考 云端审核功能。 如果您发送的图片或视频消息内容不合规,云端异步审核后会触发 SDK 的 onRecvMessageModified 回调,回调里的 message 对象该字段值为 true。

hasRiskContent?: boolean

如果您发送的语音或视频消息内容不合规,云端异步审核后会触发 SDK 的 onRecvMessageModified 回调,回调里的 message 对象该字段值为 true。

disableCloudMessagePreHook?: Boolean

是否禁用消息发送前云端回调(从 8.1 版本开始支持)

disableCloudMessagePostHook?: Boolean

是否禁用消息发送后云端回调(从 8.1 版本开始支持)

offlinePushInfo?: V2TIMOfflinePushInfo

消息的离线推送信息

revokerInfo?: V2TIMUserFullInfo

消息撤回者(从 7.4 版本开始支持) 仅当消息为撤回状态时有效

revokeReason?: string

消息撤回原因 (从 7.4 版本开始支持) 仅当消息为撤回状态时有效

消息置顶者 (从 8.0 版本开始支持) 只有通过 GetPinnedGroupMessageList 获取到的置顶消息才包含该字段

  • 消息自己是否已读

    Returns boolean

  • 消息对方是否已读(只有 C2C 消息有效) 该字段为 true 的条件是消息 timestamp <= 对端标记会话已读的时间

    Returns boolean

  • 获取消息自定义数据(本地保存,不会发送到对端,程序卸载重装后失效)

    Returns ArrayBuffer

  • 设置消息自定义数据(本地保存,不会发送到对端,程序卸载重装后失效)

    Parameters

    • localCustomData: ArrayBuffer

    Returns Promise<void>

  • 获取消息自定义数据,可以用来标记语音、视频消息是否已经播放(本地保存,不会发送到对端,程序卸载重装后失效)

    Returns number

  • 设置消息自定义数据,可以用来标记语音、视频消息是否已经播放(本地保存,不会发送到对端,程序卸载重装后失效)

    Parameters

    • localCustomInt: number

    Returns Promise<void>

Generated using TypeDoc