类型定义
CRIMInitConfig
初始化 SDK 设置的各项参数
| 参数 | 类型 | 说明 |
|---|---|---|
| sdkServer | NSString | SDK的API地址 |
| dataDir | NSString | 客户端数据存放目录,例如:/Users/abcd/im |
| logLevel | NSInteger | SDK 日志级别 Debug:0 Info:1 Warn:2 Error:3 |
| objectStorage | NSString | 资源存放方式,默认minio |
| compression | BOOL | 压缩,默认NO |
| isLogStandardOutput | BOOL | 是否将日志打印到控制台 |
| logFilePath | NSString | 指定本地保存日志文件路径,默认数据目录 |
| skipVerifyCert | BOOL | 不校验https证书 |
CRIMAtInfo
at成员信息
| 参数 | 类型 | 说明 |
|---|---|---|
| atUserID | NSString | at成员的ID |
| groupNickname | NSString | at成员的群昵称 |
CRIMAtTextElem
at文本元素
| 参数 | 类型 | 说明 |
|---|---|---|
| text | NSString | 消息内容 |
| atUserList | NSArray<NSString *> | 被@的用户ID列表 |
| atUsersInfo | NSArray<CRIMAtInfo *> | 被@的用户信息列表 |
| quoteMessage | CRIMMessageInfo | 引用的消息内容 |
| isAtSelf | NSString | @的是否是自己 |
| isAtAll | NSString | 是否@全体成员 |
CRIMGroupHasReadInfo
群消息已读用户
| 参数 | 类型 | 说明 |
|---|---|---|
| hasReadUserIDList | NSArray<NSString *> | 已读的用户ID列表 |
| hasReadCount | NSInteger | 已读总数 |
| groupMemberCount | NSInteger | 当时发送此条消息的群人数 |
CRIMUploadProgress
上传进度
| 参数 | 类型 | 说明 |
|---|---|---|
| total | NSInteger | 上传总大小 |
| save | NSInteger | 已存储大小 |
| current | NSInteger | 当前上传大小 |
CRIMAttachedInfoElem
附加消息内容
| 参数 | 类型 | 说明 |
|---|---|---|
| groupHasReadInfo | CRIMGroupHasReadInfo | 已读消息的群成员信息 |
| isPrivateChat | BOOL | 是否为私聊 |
| burnDuration | NSTimeInterval | 阅后即焚时间 |
| hasReadTime | NSTimeInterval | 已读的时间点 |
| notSenderNotificationPush | BOOL | 不发推送消息 |
| messageEntityList | NSArray<CRIMMessageEntity *> | 暂未实现 |
| isEncryption | BOOL | 是否加密 |
| inEncryptStatus | BOOL | 当前加密状态 |
| uploadProgress | CRIMUploadProgress | 上传进度 |
CRIMConversationInfo
会话信息
| 参数 | 类型 | 说明 |
|---|---|---|
| conversationID | NSString | 会话ID |
| conversationType | CRIMConversationType | 会话类型 |
| userID | NSString | 用户ID |
| groupID | NSString | 群组ID |
| showName | NSString | 会话显示的名称 |
| faceURL | NSString | 头像URL |
| recvMsgOpt | CRIMReceiveMessageOpt | 消息接收方式 |
| unreadCount | NSInteger | 未读数 |
| groupAtType | CRIMGroupAtType | @类型 |
| latestMsgSendTime | NSInteger | 最近消息的发送时间 |
| draftText | NSString | 草稿内容 |
| draftTextTime | NSInteger | 生成草稿的时间 |
| isPinned | BOOL | 是否为置顶状态 |
| isPrivateChat | BOOL | 是否开启了阅后即焚 |
| burnDuration | NSTimeInterval | 阅后即焚的时长 |
| isNotInGroup | BOOL | 是否还在组内,true: 已不在群内 |
| attachedInfo | NSString | 附加信息 |
| latestMsg | CRIMMessageInfo | 最近的一条消息 |
| ex | NSString | 应用层扩展内容 |
CRIMConversationNotDisturbInfo
会话的消息接收方式
| 参数 | 类型 | 说明 |
|---|---|---|
| conversationID | NSString | 会话ID |
| result | CRIMReceiveMessageOpt | 消息接收方式 |
CRIMInputStatusChangedData
输入状态改变信息
| 参数 | 类型 | 说明 |
|---|---|---|
| conversationID | NSString | 会话ID |
| userID | NSString | 用户ID |
| platformIDs | NSArray<NSNumber *> | 平台ID列表 |
CRIMCustomElem
自定义消息内容
| 参数 | 类型 | 说明 |
|---|---|---|
| data | NSString | 文本内容,json字符串 |
| extension | NSString | 扩展内容,json字符串,可为空 |
| description_ | NSString | 描述信息,json字符串,可为空 |
CRIMFaceElem
表情消息
| 参数 | 类型 | 说明 |
|---|---|---|
| index | NSString | 表情的下标位置,发送端对接收端自定义内嵌的表情包 |
| data | NSString | 其他表情,如URL表情直接返回URL |
CRIMFileElem
文件消息内容
| 参数 | 类型 | 说明 |
|---|---|---|
| filePath | NSString | 文件本地路径 |
| uuID | NSString | 唯一ID,可为空 |
| sourceUrl | NSString | 图片地址 |
| fileName | NSString | 文件名称 |
| fileSize | NSInteger | 文件大小 |
CRIMFriendReq
好友申请信息
| 参数 | 类型 | 说明 |
|---|---|---|
| fromUserID | NSString | 发起者userID |
| fromNickname | NSString | 发起者昵称 |
| fromFaceURL | NSString | 发起者头像URL |
| toUserID | NSString | 被添加者userID |
| toNickname | NSString | 被添加者昵称 |
| toFaceURL | NSString | 被添加者头像URL |
| handleResult | CRIMApplicationStatus | 申请的处理结果 |
| reqMsg | NSString | 申请添加好友时的申请内容 |
| createTime | NSInteger | 发起申请的时间 |
| handlerUserID | NSString | 处理人的userID |
| handleMsg | NSString | 处理好友申请时的审批消息 |
| handleTime | NSInteger | 处理时间 |
| ex | NSString | 应用层扩展内容 |
CRIMUpdateFriendsReq
好友申请信息
| 参数 | 类型 | 说明 |
|---|---|---|
| friendUserIDs | NSString | 好友的UserID列表 |
| ex | NSString | 扩展字段 |
| remark | NSString | 备注 |
| isPinned | BOOL | 是否置顶 |
GetFriendReqListAsRecipientReq
获取好友申请列表(作为被添加者)
| 参数 | 类型 | 说明 |
|---|---|---|
| offset | NSInteger | 起始偏移 |
| count | NSInteger | 每页数量 |
| handleResults | NSArray<NSNumber *> | 处理结果(1 已同意/-1 已拒绝/0 未处理) |
GetFriendReqListAsApplicantReq
获取好友申请列表(作为发起者)
| 参数 | 类型 | 说明 |
|---|---|---|
| offset | NSInteger | 当前偏移量 |
| count | NSInteger | 每页数量 |
CRIMPublicUserInfo
用户公开信息,主要是基本信息,不包括手机等其它隐私字段
| 参数 | 类型 | 说明 |
|---|---|---|
| userID | NSString | 用户ID |
| nickname | NSString | 用户昵称 |
| faceURL | NSString | 头像URL |
| ex | NSString | 应用层扩展内容 |
CRIMBlackInfo
黑名单信息,黑名单用户基本信息,注意黑名单是双向关系。
| 参数 | 类型 | 说明 |
|---|---|---|
| userID | NSString | 用户ID |
| nickname | NSString | 用户昵称 |
| faceURL | NSString | 头像URL |
| createTime | NSInteger | 拉黑时间 |
| addSource | NSInteger | 拉黑方式 |
| operatorUserID | NSString | 操作拉黑的uesrID |
| attachedInfo | NSString | 暂未实现 |
| ex | NSString | 应用层扩展内容 |
CRIMFriendInfo
好友用户基本信息。
| 参数 | 类型 | 说明 |
|---|---|---|
| userID | NSString | 用户ID |
| nickname | NSString | 用户昵称 |
| faceURL | NSString | 头像URL |
| ownerUserID | NSString | 本人的userID |
| remark | NSString | 好友备注 |
| createTime | NSInteger | 成为好友的时间 |
| addSource | NSInteger | 成为好友的方式 |
| operatorUserID | NSString | 使双方成为好友的uesrID |
| attachedInfo | NSString | 暂未实现 |
| ex | NSString | 应用层扩展内容 |
CRIMSearchFriendsInfo
搜索好友信息,CRIMFriendInfo的子类
| 参数 | 类型 | 说明 |
|---|---|---|
| relationship | CRIMRelationship | 用户关系 |
CRIMGroupReqInfo
申请入群信息
| 参数 | 类型 | 说明 |
|---|---|---|
| groupID | NSString | 群组ID |
| groupName | NSString | 群名称 |
| notification | NSString | 群公告 |
| introduction | NSString | 群简介 |
| groupFaceURL | NSString | 群头像URL |
| createTime | NSInteger | 申请入群的时间 |
| status | NSInteger | 群状态,0:正常 1:禁止聊天 2:已解散 3: 禁言状态 |
| creatorUserID | NSString | 建群人userID |
| ownerUserID | NSString | 群主userID |
| memberCount | NSInteger | 群成员数量 |
| userID | NSString | 进群申请者userID |
| nickname | NSString | 进群申请者昵称 |
| userFaceURL | NSString | 进群申请者头像URL |
| gender | CRIMGender | 进群者性别 |
| handleResult | CRIMApplicationStatus | 处理结果 |
| reqMsg | NSString | 申请加群的申请内容 |
| handledMsg | NSString | 处理申请的审批内容 |
| reqTime | NSInteger | 申请进群的时间 |
| handleUserID | NSString | 处理进群的userID |
| handledTime | NSInteger | 处理近期申请的时间 |
| ex | NSString | 应用层扩展内容 |
| inviterUserID | NSString | 邀请进群userID |
| joinSource | CRIMJoinType | 进群方式 |
CRIMGroupBaseInfo
群信息属性
| 参数 | 类型 | 说明 |
|---|---|---|
| groupName | NSString | 群名称 |
| notification | NSString | 群公告 |
| introduction | NSString | 群简介 |
| faceURL | NSString | 群头像URL |
| ex | NSString | 应用层扩展内容 |
CRIMGroupCreateInfo
创建群信息
| 参数 | 类型 | 说明 |
|---|---|---|
| groupInfo | CRIMGroupBaseInfo | 群基础信息 |
| memberUserIDs | NSArray <NSString *> | 群成员userID |
| adminUserIDs | NSArray <NSString *> | 群管理userID |
| ownerUserID | NSString | 群所有者userID |
CRIMGroupInfo
群组信息,CRIMGroupBaseInfo的子类
| 参数 | 类型 | 说明 |
|---|---|---|
| groupID | NSString | 群组ID |
| createTime | NSInteger | 群创建的时间 |
| memberCount | NSInteger | 群成员数量 |
| status | CRIMGroupStatus | 群状态,0:正常 1:禁止聊天 2:已解散 3: 禁言状态 |
| creatorUserID | NSString | 创建者userID |
| ownerUserID | NSString | 所有者userID |
| needVerification | CRIMGroupVerificationType | 进群验证方式 |
| lookMemberInfo | NSInteger | 是否允许查看其他群成员的信息 |
| applyMemberFriend | NSInteger | 是否可以添加群成员为好友 |
| notificationUpdateTime | NSInteger | 群公告更新的时间 |
| notificationUserID | NSString | 群公告发布者userID |
CRIMGroupMemberBaseInfo
群成员信息
| 参数 | 类型 | 说明 |
|---|---|---|
| userID | NSString | 群成员ID |
| roleLevel | CRIMGroupMemberRole | 群成员身份 |
CRIMGroupMemberInfo
群成员信息
| 参数 | 类型 | 说明 |
|---|---|---|
| userID | NSString | 群成员ID |
| roleLevel | CRIMGroupMemberRole | 群成员身份 |
| groupID | NSString | 群组ID |
| nickname | NSString | 群成员昵称 |
| faceURL | NSString | 群成员头像URL |
| joinTime | NSInteger | 群成员进群的时间 |
| joinSource | NSString | 群成员进群方式 |
| operatorUserID | NSString | 同意进群的userID |
| muteEndTime | NSTimeInterval | 禁言结束时间 |
| inviterUserID | NSString | 邀请者userID |
| ex | NSString | 应用层扩展内容 |
GetGroupReqListAsRecipientReq
作为群主或管理员,获取自己管理的群收到的进群申请列表
| 参数 | 类型 | 说明 |
|---|---|---|
| groupIDs | NSArray<NSString *> | 群组ID列表 |
| offset | NSInteger | 起始偏移 |
| count | NSInteger | 每页数量 |
| handleResults | NSArray<NSNumber *> | 处理结果(1 已同意/-1 已拒绝/0 未处理) |
GetGroupReqListAsApplicantReq
作为申请者,获取自己发出的加群申请列表
| 参数 | 类型 | 说明 |
|---|---|---|
| groupIDs | NSArray<NSString *> | 群组ID列表 |
| offset | NSInteger | 当前偏移量 |
| count | NSInteger | 每页数量 |
| handleResults | NSArray<NSNumber *> | 处理结果(1 已同意/-1 已拒绝/0 未处理) |
CRIMLocationElem
定位消息内容
| 参数 | 类型 | 说明 |
|---|---|---|
| desc | NSString | 位置描述内容 |
| longitude | double | 经度 |
| latitude | double | 纬度 |
CRIMMergeElem
合并消息内容
| 参数 | 类型 | 说明 |
|---|---|---|
| title | NSString | 标题 |
| abstractList | NSArray<NSString *> | 需要显示的前几条消息的摘要 |
| multiMessage | NSArray<CRIMMessageInfo *> | 选择合并的消息内容列表 |
| messageEntityList | NSArray<CRIMMessageEntity *> | 暂未实现 |
CRIMAdvancedTextElem
高级消息内容
| 参数 | 类型 | 说明 |
|---|---|---|
| text | NSString | 消息内容 |
| messageEntityList | NSArray<CRIMMessageEntity *> | 暂未实现 |
CRIMTextElem
文本消息内容
| 参数 | 类型 | 说明 |
|---|---|---|
| content | NSString | 文本内容 |
CRIMCardElem
卡片消息内容
| 参数 | 类型 | 说明 |
|---|---|---|
| userID | NSString | 用户ID |
| nickname | NSString | 用户昵称 |
| faceURL | NSString | 头像URL |
| ex | NSString | 应用层扩展内容 |
CRIMTypingElem
提示消息内容
| 参数 | 类型 | 说明 |
|---|---|---|
| msgTips | NSString | 提示的内容 |
CRIMOfflinePushInfo
离线推送消息内容
| 参数 | 类型 | 说明 |
|---|---|---|
| title | NSString | 推送标题 |
| desc | NSString | 推送描述 |
| iOSPushSound | NSString | 推送铃声文件的名称 |
| iOSBadgeCount | BOOL | 是否展示角标 |
| operatorUserID | NSString | 发送者用户ID |
| ex | NSString | 应用层扩展内容 |
CRIMMessageInfo
消息结构体
| 参数 | 类型 | 说明 |
|---|---|---|
| clientMsgID | NSString | 客户端消息ID |
| serverMsgID | NSString | 服务端消息ID |
| createTime | NSTimeInterval | 创建消息的时间 |
| sendTime | NSTimeInterval | 发送消息的时间 |
| sessionType | CRIMConversationType | 会话类型 |
| sendID | NSString | 发送消息者ID |
| recvID | NSString | 接收消息者ID |
| handleMsg | NSString | 处理的消息内容 |
| msgFrom | CRIMMessageLevel | 消息来源级别 |
| contentType | CRIMMessageContentType | 消息类型 |
| senderPlatformID | NSInteger | 平台ID |
| senderNickname | NSString | 发送者昵称 |
| senderFaceUrl | NSString | 发送者头像URL |
| groupID | NSString | 群组ID |
| content | NSString | 消息内容 |
| seq | NSInteger | 消息的seq |
| isRead | NSString | 已读标识 |
| status | CRIMMessageStatus | 消息发送的状态 |
| attachedInfo | NSString | 附加信息 |
| ex | NSString | 扩展信息 |
| localEx | NSString | 消息本地 ex |
| offlinePush | CRIMOfflinePushInfo | 离线消息推送内容 |
| textElem | CRIMTextElem | 文本内容 |
| cardElem | CRIMCardElem | 名片内容 |
| pictureElem | CRIMPictureElem | 图片消息内容 |
| soundElem | CRIMSoundElem | 语音消息内容 |
| videoElem | CRIMVideoElem | 视频 消息内容 |
| fileElem | CRIMFileElem | 文件消息内容 |
| mergeElem | CRIMMergeElem | 合并消息内容 |
| atTextElem | CRIMAtTextElem | @消息内容 |
| locationElem | CRIMLocationElem | 地理位置内容 |
| quoteElem | CRIMQuoteElem | 引用消息内容 |
| customElem | CRIMCustomElem | 自定义消息内容 |
| notificationElem | CRIMNotificationElem | 通知消息内容 |
| faceElem | CRIMFaceElem | 自定义表情内容 |
| attachedInfoElem | CRIMAttachedInfoElem | 附加消息内容 |
| advancedTextElem | CRIMAdvancedTextElem | 暂未实现 |
| typingElem | CRIMTypingElem | 正在输入消息内容 |
| hasReadTime | NSTimeInterval | 已读的时间 |
| isReact | BOOL | 暂未实现 |
| isExternalExtensions | BOOL | 暂未实现 |
CRIMReceiptInfo
消息回执
| 参数 | 类型 | 说明 |
|---|---|---|
| userID | NSString | 已读用户ID,仅单聊时有效 |
| groupID | NSString | 已读群聊ID,仅群聊时有效 |
| msgIDList | NSArray<NSString *> | 已读消息ID列表 |
| readTime | NSString | 接收者阅读消息的时间点 |
| msgFrom | CRIMMessageLevel | 消息来源 |
| contentType | CRIMMessageContentType | 消息类型 |
| sessionType | CRIMConversationType | 会话类型 |
CRIMMessageRevokedInfo
撤回信息
| 参数 | 类型 | 说明 |
|---|---|---|
| revokerID | NSString | 撤回者的用户ID |
| revokerNickname | NSString | 撤回者昵称 |
| revokerRole | CRIMGroupMemberRole | 群消息撤回者的身份 |
| clientMsgID | NSString | 客户端消息ID |
| revokeTime | NSTimeInterval | 撤回的时间 |
| sourceMessageSendTime | NSTimeInterval | 消息发送的时间 |
| sourceMessageSendID | NSString | 消息发送者userID |
| sourceMessageSenderNickname | NSString | 消息发送者昵称 |
| sessionType | CRIMConversationType | 会话类型 |
| ex | NSString | 应用层扩展信息 |
CRIMKeyValue
| 参数 | 类型 | 说明 |
|---|---|---|
| errMsg | NSString | 错误信息 |
| errCode | NSInteger | 错误码 |
| typeKey | NSString | 类型 |
| value | NSString | 值 |
| latestUpdateTime | NSTimeInterval | 上次更新时间 |
CRIMKeyValues
| 参数 | 类型 | 说明 |
|---|---|---|
| errMsg | NSString | 错误信息 |
| errCode | NSInteger | 错误码 |
| clientMsgID | NSString | 服务端消息ID |
| reactionExtensionList | NSDictionary<NSString *, CRIMKeyValue *> | 响应扩展列表 |
CRIMNotificationElem
通知消息内容
| 参数 | 类型 | 说明 |
|---|---|---|
| detail | NSString | 详情 |
| opUser | CRIMGroupMemberInfo | 从detail字段的内容decode出来的 |
| quitUser | CRIMGroupMemberInfo | 从detail字段的内容decode出来的 |
| entrantUser | CRIMGroupMemberInfo | 从detail字段的内容decode出来的 |
| groupNewOwner | CRIMGroupMemberInfo | 从detail字段的内容decode出来的 |
| group | CRIMGroupInfo | 从detail字段的内容decode出来的 |
| kickedUserList | NSArray <CRIMGroupMemberInfo *> | 从detail字段的内容decode出来的 |
| invitedUserList | NSArray <CRIMGroupMemberInfo *> | 从detail字段的内容decode出来的 |
CRIMPictureInfo
图片信息描述
| 参数 | 类型 | 说明 |
|---|---|---|
| uuID | NSString | 唯一ID,可为空 |
| type | NSString | 图片类型, 可为空 |
| size | NSInteger | 图片大小 |
| width | CGFloat | 图片宽度 |
| height | CGFloat | 图片高度 |
| url | NSString | 图片URL地址 |
CRIMPictureElem
图片消息内容
| 参数 | 类型 | 说明 |
|---|---|---|
| sourcePath | NSString | 本地路径 |
| sourcePicture | CRIMPictureInfo | 本地图片详情 |
| bigPicture | CRIMPictureInfo | 大图详情 |
| snapshotPicture | CRIMPictureInfo | 缩略图详情 |
CRIMQuoteElem
引用消息内容
| 参数 | 类型 | 说明 |
|---|---|---|
| text | NSString | 回复的消息内容 |
| quoteMessage | CRIMMessageInfo | 被引用的消息 |
| messageEntityList | NSArray<CRIMMessageEntity *> | 暂未实现 |
CRIMSearchParam
查找本地消息参数
| 参数 | 类型 | 说明 |
|---|---|---|
| conversationID | NSString | 会话ID,全局搜素时填空串 |
| keywordList | NSArray<NSString *> | 关键词列表,目前仅支持单个关键词 |
| keywordListMatchType | NSInteger | 暂未实现 |
| senderUserIDList | NSArray<NSString *> | 暂未实现 |
| messageTypeList | NSArray<CRIMMessageContentType> | 消息类型列表 |
| searchTimePosition | NSInteger | 起始时间,UTC时间,单位秒,0表示从当前时间开始 |
| searchTimePeriod | NSInteger | 从起始时间往前的时间范围,UTC时间,单位秒,3600表示过去一小时,传0表示不限制时间范围 |
| pageIndex | NSInteger | 开始页数,首次查询传1,全局搜索时无效 |
| count | NSInteger | 每页消息数,全局搜索时无效 |
CRIMSearchGroupParam
查询群使用,isSearchGroupID,isSearchGroupName不可以同时为false
| 参数 | 类型 | 说明 |
|---|---|---|
| keywordList | NSArray<NSString *> | 关键词列表,目前仅支持单个关键词 |
| isSearchGroupID | BOOL | 是否以关键词搜索群组ID,默认false |
| isSearchGroupName | BOOL | 是否以关键词搜索群名字,默认false |
CRIMSearchFriendsParam
查询好友使用,isSearchNickname,isSearchRemark不可以同时为false
| 参数 | 类型 | 说明 |
|---|---|---|
| keywordList | NSArray<NSString *> | 关键词列表,目前仅支持单个关键词 |
| isSearchUserID | BOOL | 是否以关键词搜索userID |
| isSearchNickname | BOOL | 是否以关键词搜索昵称,默认false |
| isSearchRemark | BOOL | 是否以关键词搜索备注,默认false |
CRIMGetMessageOptions
查询聊天记录使用
| 参数 | 类型 | 说明 |
|---|---|---|
| userID | NSString | 用户ID |
| groupID | NSString | 群组ID |
| conversationID | NSString | 会话ID,为空时通过userID和groupID获取 |
| startClientMsgID | NSString | 起始的消息客户端消息ID |
| count | NSInteger | 每页消息数 |
CRIMGetAdvancedHistoryMessageListParam
查询历史消息使用
| 参数 | 类型 | 说明 |
|---|---|---|
| userID | NSString | 用户ID |
| groupID | NSString | 群组ID |
| conversationID | NSString | 会话ID,为空时通过userID和groupID获取 |
| startClientMsgID | NSString | 起始的消息客户端消息ID |
| count | NSInteger | 每页消息数 |
| viewType | NSInteger | 0 History 1 Search |
CRIMFindMessageListParam
查找消息列表
| 参数 | 类型 | 说明 |
|---|---|---|
| conversationID | NSString | 会话ID |
| clientMsgIDList | NSArray<NSString *> | 客户端消息ID列表 |
CRIMSearchGroupMembersParam
查询群成员使用,isSearchUserID、isSearchMemberNickname不可同时为false
| 参数 | 类型 | 说明 |
|---|---|---|
| groupID | NSString | 群组ID |
| keywordList | NSArray<NSString *> | 关键词列表 |
| isSearchUserID | BOOL | 是否以关键词搜索用户ID,默认 false |
| isSearchMemberNickname | BOOL | 是否以关键词搜索昵称,默认 false |
| offset | NSString | 已查询的消息数 |
| count | NSString | 每页消息数 |
CRIMSearchResultItemInfo
查找本地消息结果的item
| 参数 | 类型 | 说明 |
|---|---|---|
| conversationID | NSString | 会话ID |
| messageCount | NSInteger | 消息数量 |
| conversationType | CRIMConversationType | 会话类型 |
| showName | NSString | 展示的昵称 |
| faceURL | NSString | 头像URL |
| messageList | NSArray<CRIMMessageInfo *> | 消息列表 |
CRIMSearchResultInfo
查找本地消息结果
| 参数 | 类型 | 说明 |
|---|---|---|
| totalCount | NSInteger | 总消息数量 |
| searchResultItems | NSArray<CRIMSearchResultItemInfo *> | 搜索结果列表 |
CRIMGetAdvancedHistoryMessageListInfo
查找历史消息的返回结果
| 参数 | 类型 | 说明 |
|---|---|---|
| isEnd | BOOL | 是否查询完 |
| lastMinSeq | NSInteger | 上一次拉取回调给的值 |
| errCode | NSInteger | 错误码 |
| errMsg | NSString | 错误信息 |
| messageList | NSArray <CRIMMessageInfo *> | 消息列表 |
CRIMSimpleRequstInfo
| 参数 | 类型 | 说明 |
|---|---|---|
| toUserID | NSString | 被添加者userID |
| reqMsg | NSString | 添加好友申请时有效 |
| remark | NSString | 设置好友备注时有效 |
| handleMsg | NSString | 同意某人的好友申请时有效 |
CRIMSimpleResultInfo
| 参数 | 类型 | 说明 |
|---|---|---|
| userID | NSString | 被添加者userID |
| result | NSInteger | 1: 表示好友关系且不是黑名单 |
CRIMSoundElem
语音消息内容
| 参数 | 类型 | 说明 |
|---|---|---|
| uuID | NSString | 唯一ID |
| soundPath | NSString | 本地路径 |
| sourceUrl | NSString | 音频文件URL |
| dataSize | NSInteger | 音频文件大小 |
| duration | NSInteger | 音频文件时长 |
CRIMUserInfo
个人信息,所有信息都包括
| 参数 | 类型 | 说明 |
|---|---|---|
| userID | NSString | 用户ID |
| nickname | NSString | 用户昵称 |
| faceURL | NSString | 用户头像URL |
| createTime | NSInteger | 用户注册的时间(秒) |
| ex | NSString | 应用层扩展内容 |
| attachedInfo | NSString | 暂未实现 |
| globalRecvMsgOpt | CRIMReceiveMessageOpt | 全局消息接收方式设置 |
CRIMUserStatusInfo
用户状态信息
| 参数 | 类型 | 说明 |
|---|---|---|
| userID | NSString | 用户ID |
| platformIDs | NSArray | 平台ID列表 |
| status | NSInteger | 状态,0 表示离线,1 表示在线 |
CRIMVideoElem
| 参数 | 类型 | 说明 |
|---|---|---|
| videoPath | NSString | 视频本地路径 |
| videoUUID | NSString | 视频ID |
| videoUrl | NSString | 视频URL |
| videoType | NSString | 视频类型 |
| videoSize | NSInteger | 视频大小 |
| duration | NSInteger | 视频时长 |
| snapshotPath | NSString | 视频快照本地路径 |
| snapshotUUID | NSString | 视频快照ID |
| snapshotSize | NSInteger | 视频快照大小 |
| snapshotUrl | NSString | 视频快照URL |
| snapshotWidth | CGFloat | 视频快照宽度 |
| snapshotHeight | CGFloat | 视频快照高度 |