NIMSDK-iOS
载入中...
搜索中...
未找到
属性 | 所有成员列表
NIMMessage类 参考

#import <NIMMessage.h>

类 NIMMessage 继承关系图:

属性

NIMMessageType messageType
 
NSInteger messageSubType
 
NSString * from
 
NIMSession * session
 
NSString * messageId
 
NSString * serverID
 
NSString * text
 
id< NIMMessageObject > messageObject
 
NSString * rawAttachContent
 
NIMMessageSetting * setting
 
NIMAntiSpamOption * antiSpamOption
 
NSString * apnsContent
 
NSDictionary * apnsPayload
 
NIMMessageApnsMemberOption * apnsMemberOption
 
NSDictionary * remoteExt
 
NSDictionary * localExt
 
id messageExt
 
NSTimeInterval timestamp
 
NSDictionary * yidunAntiCheating
 
NSString * yidunAntiSpamExt
 
NSString * yidunAntiSpamRes
 
NSNumber * locationX
 
NSNumber * locationY
 
NSNumber * locationZ
 
NSArray< NSString * > * toAccIds
 
NSString * notifyTargetTags
 
NSString * env
 
NIMMessageDeliveryState deliveryState
 
NIMMessageAttachmentDownloadState attachmentDownloadState
 
BOOL isReceivedMsg
 
BOOL isOutgoingMsg
 
BOOL isPlayed
 
BOOL isDeleted
 
BOOL isRemoteRead
 
BOOL isTeamReceiptSended
 
NIMTeamMessageReceipt * teamReceiptInfo
 
NSString * senderName
 
NIMLoginClientType senderClientType
 
BOOL isBlackListed
 
NSString * repliedMessageId
 
NSString * repliedMessageServerId
 
NSString * repliedMessageFrom
 
NSString * repliedMessageTo
 
NSTimeInterval repliedMessageTime
 
NSString * threadMessageId
 
NSString * threadMessageServerId
 
NSString * threadMessageFrom
 
NSString * threadMessageTo
 
NSTimeInterval threadMessageTime
 
NSString * callbackExt
 
NIMMessageStatus status
 
NIMMessageRobotInfo * robotInfo
 
NIMMessageAIConfigParams * sendAIConfig
 
NIMMessageAIConfig * aiConfig
 

详细描述

消息结构

属性说明

◆ aiConfig

- (NIMMessageAIConfig*) aiConfig
readnonatomicstrong

数字人消息配置

◆ antiSpamOption

- (NIMAntiSpamOption*) antiSpamOption
readwritenonatomicstrong

消息反垃圾配置

◆ apnsContent

- (NSString*) apnsContent
readwritenonatomiccopy

消息推送文案,长度限制500字,撤回消息时该字段无效

◆ apnsMemberOption

- (NIMMessageApnsMemberOption*) apnsMemberOption
readwritenonatomicstrong

指定成员推送选项 @discussion 通过这个选项进行一些更复杂的推送设定，目前只能在群会话中使用

◆ apnsPayload

- (NSDictionary*) apnsPayload
readwritenonatomiccopy

消息推送Payload @discussion 可以通过这个字段定义消息推送 Payload ,支持字段参考苹果技术文档,长度限制 2K,撤回消息时该字段无效

◆ attachmentDownloadState

- (NIMMessageAttachmentDownloadState) attachmentDownloadState
readnonatomicassign

消息附件下载状态 仅针对收到的消息

◆ callbackExt

- (NSString*) callbackExt
readnonatomiccopy

第三方回调回来的自定义扩展字段

◆ deliveryState

- (NIMMessageDeliveryState) deliveryState
readnonatomicassign

消息投递状态 仅针对发送的消息

◆ env

- (NSString*) env
readwritenonatomiccopy

环境变量 @discussion 环境变量，用于指向不同的抄送、第三方回调等配置

◆ from

- (NSString*) from
readwritenonatomiccopy

消息来源

◆ isBlackListed

- (BOOL) isBlackListed
readnonatomicassign

是否在黑名单中 @discussion YES 为被目标拉黑;

◆ isDeleted

- (BOOL) isDeleted
readnonatomicassign

消息是否标记为已删除 @discussion 已删除的消息在获取本地消息列表时会被过滤掉，只有根据 messageId 获取消息的接口可能会返回已删除消息。聊天室消息里，此字段无效。

◆ isOutgoingMsg

- (BOOL) isOutgoingMsg
readnonatomicassign

是否是往外发的消息 @discussion 由于能对自己发消息，所以并不是所有来源是自己的消息都是往外发的消息，这个字段用于判断头像排版位置（是左还是右）。

◆ isPlayed

- (BOOL) isPlayed
readwritenonatomicassign

消息是否被播放过 @discussion 修改这个属性,后台会自动更新 db 中对应的数据。聊天室消息里，此字段无效。

◆ isReceivedMsg

- (BOOL) isReceivedMsg
readnonatomicassign

是否是收到的消息 @discussion 由于有漫游消息的概念,所以自己发出的消息漫游下来后仍旧是"收到的消息",这个字段用于消息出错是时判断需要重发还是重收

◆ isRemoteRead

- (BOOL) isRemoteRead
readnonatomicassign

对端是否已读 @discussion 只有当当前消息为 P2P 消息且 isOutgoingMsg 为 YES 时这个字段才有效，需要对端调用过发送已读回执的接口

◆ isTeamReceiptSended

- (BOOL) isTeamReceiptSended
readnonatomicassign

是否已发送群回执 @discussion 只针对群消息有效

◆ localExt

- (NSDictionary*) localExt
readwritenonatomiccopy

客户端本地扩展 @discussion 客户端可以设置这个字段，这个字段只在本地存储,不会发送至对端,上层需要保证 NSDictionary 可以转换为 JSON

◆ locationX

- (NSNumber*) locationX
readwritenonatomiccopy

X坐标，仅用于聊天室

◆ locationY

- (NSNumber*) locationY
readwritenonatomiccopy

Y坐标，仅用于聊天室

◆ locationZ

- (NSNumber*) locationZ
readwritenonatomiccopy

Z坐标。仅用于聊天室

◆ messageExt

- (id) messageExt
readwritenonatomicstrong

消息拓展字段 @discussion 服务器下发的消息拓展字段，并不在本地做持久化，目前只有聊天室中的消息才有该字段(NIMMessageChatroomExtension)

◆ messageId

- (NSString*) messageId
readnonatomiccopy

消息ID,唯一标识

◆ messageObject

- (id<NIMMessageObject>) messageObject
readwritenonatomicstrong

消息附件内容

◆ messageSubType

- (NSInteger) messageSubType
readwritenonatomicassign

消息子类型.(默认0。设置值需要大于0)

◆ messageType

- (NIMMessageType) messageType
readnonatomicassign

消息类型

◆ notifyTargetTags

- (NSString*) notifyTargetTags
readwritenonatomiccopy

消息的目标标签表达式

◆ rawAttachContent

- (NSString*) rawAttachContent
readnonatomiccopy

消息附件原始字符串内容

◆ remoteExt

- (NSDictionary*) remoteExt
readwritenonatomiccopy

服务器扩展 @discussion 客户端可以设置这个字段,这个字段将在本地存储且发送至对端,上层需要保证 NSDictionary 可以转换为 JSON，长度限制 1K

◆ repliedMessageFrom

- (NSString*) repliedMessageFrom
readnonatomiccopy

该消息回复的目标消息的发送者 @discussion 如果未回复其他消息，则为空

◆ repliedMessageId

- (NSString*) repliedMessageId
readnonatomiccopy

该消息回复的目标消息的消息ID @discussion 如果未回复其他消息，则为空 @discussion A为一条普通消息,B消息为对A回复的消息,则A是B的 replied 消息和 thread 消息; 同时, C为回复B的消息,则C的 replied 消息是B, C的thread消息为A

◆ repliedMessageServerId

- (NSString*) repliedMessageServerId
readnonatomiccopy

该消息回复的目标消息的服务端ID @discussion 如果未回复其他消息，则为空

◆ repliedMessageTime

- (NSTimeInterval) repliedMessageTime
readnonatomicassign

该消息回复的目标消息的发送时间 @discussion 如果未回复其他消息则为0（单位：秒）

◆ repliedMessageTo

- (NSString*) repliedMessageTo
readnonatomiccopy

该消息回复的目标消息的接收者 @discussion 如果未回复其他消息，则为空

◆ robotInfo

- (NIMMessageRobotInfo*) robotInfo
readwritenonatomicstrong

消息机器人信息 @discussion 设置和获取消息的机器人相关信息

◆ sendAIConfig

- (NIMMessageAIConfigParams*) sendAIConfig
readwritenonatomicstrong

请求大模型的相关参数

◆ senderClientType

- (NIMLoginClientType) senderClientType
readnonatomicassign

发送者客户端类型

◆ senderName

- (NSString*) senderName
readnonatomiccopy

消息发送者名字 @discussion 当发送者是自己时,这个值可能为空,这个值表示的是发送者当前的昵称,而不是发送消息时的昵称。聊天室消息里，此字段无效。

◆ serverID

- (NSString*) serverID
readnonatomiccopy

消息服务端ID

◆ session

- (NIMSession*) session
readnonatomiccopy

消息所属会话

◆ setting

- (NIMMessageSetting*) setting
readwritenonatomicstrong

消息设置 @discussion 可以通过这个字段制定当前消息的各种设置,如是否需要计入未读，是否需要多端同步等

◆ status

- (NIMMessageStatus) status
readwritenonatomicassign

消息处理状态

◆ teamReceiptInfo

- (NIMTeamMessageReceipt*) teamReceiptInfo
readnonatomicstrong

群已读回执信息 @discussion 只有当当前消息为 Team 消息且 teamReceiptEnabled 为 YES 时才有效，需要对端调用过发送已读回执的接口

◆ text

- (NSString*) text
readwritenonatomiccopy

消息文本 @discussion 消息中除 NIMMessageTypeText 和 NIMMessageTypeTip 外，其他消息 text 字段都为 nil

◆ threadMessageFrom

- (NSString*) threadMessageFrom
readnonatomiccopy

该消息回复的父消息的发送者 @discussion 如果未回复其他消息，则为空

◆ threadMessageId

- (NSString*) threadMessageId
readnonatomiccopy

该消息的父消息的消息ID @discussion 如果未回复其他消息，则为空

◆ threadMessageServerId

- (NSString*) threadMessageServerId
readnonatomiccopy

该消息的父消息的服务端ID @discussion 如果未回复其他消息，则为空

◆ threadMessageTime

- (NSTimeInterval) threadMessageTime
readnonatomicassign

该消息回复的父消息的发送时间 @discussion 如果未回复其他消息则为0（单位：秒）

◆ threadMessageTo

- (NSString*) threadMessageTo
readnonatomiccopy

该消息回复的目标消息的接收者 @discussion 如果未回复其他消息，则为空

◆ timestamp

- (NSTimeInterval) timestamp
readwritenonatomicassign

消息发送时间 @discussion 本地存储消息可以通过修改时间戳来调整其在会话列表中的位置，发完服务器的消息时间戳将被服务器自动修正

◆ toAccIds

- (NSArray<NSString *>*) toAccIds
readwritenonatomiccopy

消息接受者列表，仅用于聊天室

◆ yidunAntiCheating

- (NSDictionary*) yidunAntiCheating
readwritenonatomiccopy

易盾反垃圾增强反作弊专属字段 @discussion 透传易盾反垃圾增强反作弊专属字段

◆ yidunAntiSpamExt

- (NSString*) yidunAntiSpamExt
readwritenonatomiccopy

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

◆ yidunAntiSpamRes

- (NSString*) yidunAntiSpamRes
readwritenonatomiccopy

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

该类的文档由以下文件生成: