IMSDK
即时通信 IM 提供全球接入、单聊、群聊、消息推送、资料关系链托管、账号鉴权等全方位解决方案，并提供完备的 App 接入、后台管理接口。
属性
V2TIMMessage

详细描述

高级消息

属性

NSString * msgID
 
NSDate * timestamp
 
NSString * sender
 
NSString * nickName
 
NSString * friendRemark
 
NSString * nameCard
 
NSString * faceURL
 
NSString * groupID
 
NSString * userID
 
uint64_t seq
 
uint64_t random
 
V2TIMMessageStatus status
 
BOOL isSelf
 
BOOL isRead
 
BOOL isPeerRead
 
BOOL needReadReceipt
 
BOOL supportMessageExtension
 
BOOL isBroadcastMessage
 
V2TIMMessagePriority priority
 
NSMutableArray< NSString * > * groupAtUserList
 
V2TIMElemType elemType
 
V2TIMTextElem * textElem
 
V2TIMCustomElem * customElem
 
V2TIMImageElem * imageElem
 
V2TIMSoundElem * soundElem
 
V2TIMVideoElem * videoElem
 
V2TIMFileElem * fileElem
 
V2TIMLocationElem * locationElem
 
V2TIMFaceElem * faceElem
 
V2TIMMergerElem * mergerElem
 
V2TIMGroupTipsElem * groupTipsElem
 
NSData * localCustomData
 
int localCustomInt
 
NSData * cloudCustomData
 
BOOL isExcludedFromUnreadCount
 
BOOL isExcludedFromLastMessage
 
BOOL isExcludedFromContentModeration
 
NSString * customModerationConfigurationID
 
BOOL hasRiskContent
 
BOOL disableCloudMessagePreHook
 
BOOL disableCloudMessagePostHook
 
V2TIMOfflinePushInfo * offlinePushInfo
 
V2TIMUserFullInfo * revokerInfo
 
NSString * revokeReason
 
V2TIMGroupMemberFullInfo * pinnerInfo
 

属性说明

◆ msgID

- (NSString*) msgID
readnonatomicstrong

消息 ID（消息创建的时候为 nil，消息发送的时候会生成）

◆ timestamp

- (NSDate*) timestamp
readnonatomicstrong

消息的 UTC 时间戳

◆ sender

- (NSString*) sender
readnonatomicstrong

消息发送者

◆ nickName

- (NSString*) nickName
readnonatomicstrong

消息发送者昵称

◆ friendRemark

- (NSString*) friendRemark
readnonatomicstrong

消息发送者好友备注

◆ nameCard

- (NSString*) nameCard
readnonatomicstrong

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

◆ faceURL

- (NSString*) faceURL
readnonatomicstrong

消息发送者头像

◆ groupID

- (NSString*) groupID
readnonatomicstrong

如果是群组消息，groupID 为会话群组 ID，否则为 nil

◆ userID

- (NSString*) userID
readnonatomicstrong

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

◆ seq

- (uint64_t) seq
readnonatomicassign

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

◆ random

- (uint64_t) random
readnonatomicassign

消息随机码

◆ status

- (V2TIMMessageStatus) status
readnonatomicassign

消息发送状态

◆ isSelf

- (BOOL) isSelf
readnonatomicassign

消息发送者是否是自己

◆ isRead

- (BOOL) isRead
readnonatomicassign

消息自己是否已读

◆ isPeerRead

- (BOOL) isPeerRead
readnonatomicassign

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

◆ needReadReceipt

- (BOOL) needReadReceipt
readwritenonatomicassign

消息是否需要已读回执

注意

群聊消息 6.1 及以上版本支持该特性，需要您先到 IM 控制台配置支持已读回执的群类型。

单聊消息 6.2 及以上版本支持该特性。

群聊消息和单聊消息都需要购买旗舰版套餐包。

◆ supportMessageExtension

- (BOOL) supportMessageExtension
readwritenonatomicassign

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

◆ isBroadcastMessage

- (BOOL) isBroadcastMessage
readnonatomicassign

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

◆ priority

- (V2TIMMessagePriority) priority
readnonatomicassign

消息优先级（只有 onRecvNewMessage 收到的 V2TIMMessage 获取有效）

◆ groupAtUserList

- (NSMutableArray<NSString *>*) groupAtUserList
readnonatomicstrong

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

◆ elemType

- (V2TIMElemType) elemType
readnonatomicassign

消息类型

◆ textElem

- (V2TIMTextElem*) textElem
readnonatomicstrong

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

◆ customElem

- (V2TIMCustomElem*) customElem
readnonatomicstrong

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

◆ imageElem

- (V2TIMImageElem*) imageElem
readnonatomicstrong

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

◆ soundElem

- (V2TIMSoundElem*) soundElem
readnonatomicstrong

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

◆ videoElem

- (V2TIMVideoElem*) videoElem
readnonatomicstrong

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

◆ fileElem

- (V2TIMFileElem*) fileElem
readnonatomicstrong

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

◆ locationElem

- (V2TIMLocationElem*) locationElem
readnonatomicstrong

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

◆ faceElem

- (V2TIMFaceElem*) faceElem
readnonatomicstrong

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

◆ mergerElem

- (V2TIMMergerElem*) mergerElem
readnonatomicstrong

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

◆ groupTipsElem

- (V2TIMGroupTipsElem*) groupTipsElem
readnonatomicstrong

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

◆ localCustomData

- (NSData*) localCustomData
readwritenonatomicstrong

消息自定义数据（本地保存，不会发送到对端，程序卸载重装后失效）

◆ localCustomInt

- (int) localCustomInt
readwritenonatomicassign

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

◆ cloudCustomData

- (NSData*) cloudCustomData
readwritenonatomicstrong

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

◆ isExcludedFromUnreadCount

- (BOOL) isExcludedFromUnreadCount
readwritenonatomicassign

消息是否不计入会话未读数：默认为 NO，表明需要计入会话未读数，设置为 YES，表明不需要计入会话未读数

5.3.425 及以上版本支持, 会议群（Meeting）默认不支持该字段

◆ isExcludedFromLastMessage

- (BOOL) isExcludedFromLastMessage
readwritenonatomicassign

消息是否不计入会话 lastMsg：默认为 NO，表明需要计入会话 lastMsg，设置为 YES，表明不需要计入会话 lastMsg（5.4.666 及以上版本支持）

◆ isExcludedFromContentModeration

- (BOOL) isExcludedFromContentModeration
readwritenonatomicassign

消息是否不过内容审核（【云端审核】）(7.1 及以上版本支持) 只有在开通【云端审核】功能后，isExcludedFromContentModeration 设置才有效，设置为 YES，表明不过内容审核，设置为 NO：表明过内容审核。 【云端审核】开通流程请参考 云端审核功能

◆ customModerationConfigurationID

- (NSString*) customModerationConfigurationID
readwritenonatomicstrong

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

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

◆ hasRiskContent

- (BOOL) hasRiskContent
readnonatomicassign

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

◆ disableCloudMessagePreHook

- (BOOL) disableCloudMessagePreHook
readwritenonatomicassign

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

◆ disableCloudMessagePostHook

- (BOOL) disableCloudMessagePostHook
readwritenonatomicassign

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

◆ offlinePushInfo

- (V2TIMOfflinePushInfo*) offlinePushInfo
readnonatomicstrong

消息的离线推送信息

◆ revokerInfo

- (V2TIMUserFullInfo*) revokerInfo
readnonatomicstrong

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

◆ revokeReason

- (NSString*) revokeReason
readnonatomicstrong

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

◆ pinnerInfo

- (V2TIMGroupMemberFullInfo*) pinnerInfo
readnonatomicstrong

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