Json_value_msg
功能介绍
消息Json Keys
关于对应Elem的顺序
目前文件和语音Elem不一定会按照添加顺序传输,其他Elem按照顺序,不过建议不要过于依赖Elem顺序进行处理,应该逐个按照Elem类型处理,防止异常情况下进程Crash。
针对群组的红包和点赞消息
对于直播场景,会有点赞和发红包功能,点赞相对优先级较低,红包消息优先级较高,具体消息内容可以使用自定义消息CustomElem进行定义,发送消息时,可通过 kTIMMsgPriority 定义消息优先级。
阅后即焚消息
开发者通过设置 TIMMsgIsOnlineMsg 字段为true时,表示发送阅后即焚消息,该消息有如下特性
C2C会话,当此消息发送时,只有对方在线,对方才会收到。如果当时离线,后续再登录也收不到此消息。
群会话,当此消息发送时,只有群里在线的成员才会收到。如果当时离线,后续再登录也收不到此消息。
此消息服务器不会保存
此消息不计入未读计数
此消息在本地不会存储
消息自定义字段
开发者可以对消息增加自定义字段,如自定义整数(通过 kTIMMsgCustomInt 指定)、自定义二进制数据(通过 kTIMMsgCustomStr 指定,必须转换成String,Json不支持二进制传输),可以根据这两个字段做出各种不同效果,例如语音消息是否已经播放等等。另外需要注意,此自定义字段仅存储于本地,不会同步到Server,更换终端获取不到。
参数介绍
message_elem_array
- 参数类型 : [ ElemTextElem | ElemImageElem | ElemSoundElem | ElemCustomElem | ElemFileElem | ElemVideoElem | ElemMergerElem | ElemFaceElem | ElemLocationElem | ElemGroupReportElem | ElemGroupTipsElem | any ]
- 参数描述 : 消息内元素列表
message_conv_id
- 参数类型 : string
- 参数描述 : 消息所属会话ID
message_conv_type
- 参数类型 : number
- 参数描述 : TIMConvType 消息所属会话类型
message_sender
- 参数类型 : string
- 参数描述 : 消息的发送者
message_priority
- 参数类型 : number
- 参数描述 : 消息优先级
message_client_time
- 参数类型 : number
- 参数描述 : 客户端时间
message_server_time
- 参数类型 : number
- 参数描述 : 服务端时间
message_is_from_self
- 参数类型 : boolean
- 参数描述 : 消息是否来自自己
message_platform
- 参数类型 : TIMPlatform
- 参数描述 : 发送消息的平台
message_is_read
- 参数类型 : boolean
- 参数描述 : 消息是否已读
message_is_online_msg
- 参数类型 : boolean
- 参数描述 : 消息是否是在线消息,false表示普通消息,true表示阅后即焚消息,默认为false
message_is_peer_read
- 参数类型 : boolean
- 参数描述 : 消息是否被会话对方已读
message_status
- 参数类型 : TIMMsgStatus
- 参数描述 : 消息当前状态
message_unique_id
- 参数类型 : number
- 参数描述 : 消息的唯一标识,推荐使用 kTIMMsgMsgId
message_msg_id
- 参数类型 : string
- 参数描述 : 消息id
message_rand
- 参数类型 : number
- 参数描述 : 消息的随机码
message_seq
- 参数类型 : number
- 参数描述 : 消息序列
message_custom_int
- 参数类型 : number
- 参数描述 : 自定义数据字段(本地保存,不会发送到对端,程序卸载重装后失效)
message_custom_str
- 参数类型 : string
- 参数描述 : 消息自定义数据(云端保存,会发送到对端,程序卸载重装后还能拉取到)
message_cloud_custom_str
- 参数类型 : string
- 参数描述 : 消息自定义数据(云端保存,会发送到对端,程序卸载重装后还能拉取到)
message_is_excluded_from_unread_count
- 参数类型 : boolean
- 参数描述 : 消息是否不计入未读计数:默认为 NO,表明需要计入未读计数,设置为 YES,表明不需要计入未读计数
message_group_at_user_array
- 参数类型 : string
- 参数描述 : 群消息中被 @ 的用户 UserID 列表(即该消息都 @ 了哪些人),如果需要 @ ALL ,请传入 kImSDK_MessageAtALL 字段
message_is_forward_message
- 参数类型 : boolean
- 参数描述 : 如果需要转发一条消息,不能直接调用 sendMessage 接口发送原消息,原消息 kTIMMsgIsForwardMessage 设置为 true 再发送。
message_sender_profile
- 参数类型 : userProfile
- 参数描述 : 消息的发送者的用户资料
message_sender_group_member_info
- 参数类型 : GroupMemberInfo
- 参数描述 : 消息发送者在群里面的信息,只有在群会话有效。目前仅能获取字段 kTIMGroupMemberInfoIdentifier、kTIMGroupMemberInfoNameCard 其他的字段建议通过 TIMGroupGetMemberInfoList 接口获取
message_support_message_extension
- 参数类型 : boolean
- 参数描述 : 是否支持消息扩展
message_offline_push_config
- 参数类型 : OfflinePushConfig
- 参数描述 : 消息的离线推送设置
message_need_read_receipt
- 参数类型 : boolean
- 参数描述 : 消息是否需要已读回执
message_receipt_peer_read
- 参数类型 : boolean
- 参数描述 : 消息对方是否已读(只有 C2C 消息有效)
message_is_broadcast_message
- 参数类型 : boolean
- 参数描述 : 是否广播消息
message_has_sent_receipt
- 参数类型 : boolean
- 参数描述 : 消息是否发送了已读回执
message_group_receipt_read_count
- 参数类型 : number
- 参数描述 : 消息已读人数
message_group_receipt_unread_count
- 参数类型 : number
- 参数描述 : 消息未读人数
message_version
- 参数类型 : number
- 参数描述 : 消息的离线推送设置
message_excluded_from_last_message
- 参数类型 : boolean
- 参数描述 : 消息是否不计入会话 lastMsg
message_excluded_from_content_moderation
- 参数类型 : boolean
- 参数描述 : 是否不过内容审核(包含【本地审核】和【云端审核】),只有在开通【本地审核】或【云端审核】功能后,该字段设置才有效,设置为 true,表明不过内容审核,设置为 false:表明过内容审核。【本地审核】开通流程请参考 本地审核功能。 【云端审核】开通流程请参考 云端审核功能
message_target_group_member_array
- 参数类型 : string[]
- 参数描述 : 消息at群组成员列表
message_revoker_user_id
- 参数类型 : string
- 参数描述 : 撤回消息的用户id