Elem
功能介绍
消息单体信息
参数介绍
elem_type
- 参数类型 : TIMElemType
- 参数描述 : 读写(必填), 元素类型
text_elem_content
- 参数类型 : string
- 参数描述 : 读写(必填), 文本内容
face_elem_index
- 参数类型 : int
- 参数描述 : 读写(必填), 表情索引
face_elem_buf
- 参数类型 : string
- 参数描述 : 读写(选填), 其他额外数据,可由用户自定义填写。若要传输二进制,麻烦先转码成字符串。JSON只支持字符串
location_elem_desc
- 参数类型 : string
- 参数描述 : 读写(选填), 位置描述
location_elem_longitude
- 参数类型 : double
- 参数描述 : 读写(必填), 经度
location_elem_latitude
- 参数类型 : double
- 参数描述 : 读写(必填), 纬度
image_elem_orig_path
- 参数类型 : string
- 参数描述 : 读写(必填), 发送图片的路径
image_elem_level
- 参数类型 : TIMImageLevel
- 参数描述 : 读写(必填), 发送图片的质量级别
image_elem_format
- 参数类型 : int
- 参数描述 : 读写, 发送图片格式:,0xff:未知格式, 1:JPG, 2:GIF, 3:PNG, 4:BMP
image_elem_orig_id
- 参数类型 : string
- 参数描述 : 只读, 原图 ID
image_elem_orig_pic_height
- 参数类型 : int
- 参数描述 : 只读, 原图的图片高度
image_elem_orig_pic_width
- 参数类型 : int
- 参数描述 : 只读, 原图的图片宽度
image_elem_orig_pic_size
- 参数类型 : int
- 参数描述 : 只读, 原图的图片大小
image_elem_thumb_id
- 参数类型 : string
- 参数描述 : 只读, 缩略图 ID
image_elem_thumb_pic_height
- 参数类型 : int
- 参数描述 : 只读, 缩略图的图片高度
image_elem_thumb_pic_width
- 参数类型 : int
- 参数描述 : 只读, 缩略图的图片宽度
image_elem_thumb_pic_size
- 参数类型 : int
- 参数描述 : 只读, 缩略图的图片大小
image_elem_large_id
- 参数类型 : string
- 参数描述 : 只读, 大图片uuid
image_elem_large_pic_height
- 参数类型 : int
- 参数描述 : 只读, 大图片的图片高度
image_elem_large_pic_width
- 参数类型 : int
- 参数描述 : 只读, 大图片的图片宽度
image_elem_large_pic_size
- 参数类型 : int
- 参数描述 : 只读, 大图片的图片大小
image_elem_orig_url
- 参数类型 : string
- 参数描述 : 只读, 原图URL
image_elem_thumb_url
- 参数类型 : string
- 参数描述 : 只读, 缩略图URL
image_elem_large_url
- 参数类型 : string
- 参数描述 : 只读, 大图片URL
image_elem_task_id
- 参数类型 : int
- 参数描述 : 只读, 任务ID,废弃
sound_elem_file_path
- 参数类型 : string
- 参数描述 : 读写(必填), 语音文件路径,需要开发者自己先保存语言然后指定路径
sound_elem_file_size
- 参数类型 : int
- 参数描述 : 读写(必填), 语音数据文件大小
sound_elem_file_time
- 参数类型 : int
- 参数描述 : 读写(必填), 语音时长
sound_elem_file_id
- 参数类型 : string
- 参数描述 : 只读, 语音 ID
sound_elem_business_id
- 参数类型 : int
- 参数描述 : 只读, 下载时用到的businessID
sound_elem_download_flag
- 参数类型 : int
- 参数描述 : 只读, 是否需要申请下载地址(0:需要申请,1:到cos申请,2:不需要申请,直接拿url下载)
sound_elem_url
- 参数类型 : string
- 参数描述 : 只读,下载的URL
sound_elem_task_id
- 参数类型 : int
- 参数描述 : 只读,任务ID,废弃
custom_elem_data
- 参数类型 : string
- 参数描述 : 读写, 数据,支持二进制数据
custom_elem_desc
- 参数类型 : string
- 参数描述 : 读写, 自定义描述
custom_elem_ext
- 参数类型 : string
- 参数描述 : 读写, 后台推送对应的ext字段
custom_elem_sound
- 参数类型 : string
- 参数描述 : 读写, 自定义声音
file_elem_file_path
- 参数类型 : string
- 参数描述 : 读写(必填), 文件所在路径(包含文件名)
file_elem_file_name
- 参数类型 : string
- 参数描述 : 读写(必填), 文件名,显示的名称。不设置该参数时,kTIMFileElemFileName默认为kTIMFileElemFilePath指定的文件路径中的文件名
file_elem_file_size
- 参数类型 : int
- 参数描述 : 读写(必填), 文件大小
file_elem_file_id
- 参数类型 : string
- 参数描述 : 只读, 文件 ID
file_elem_business_id
- 参数类型 : int
- 参数描述 : 只读, 下载时用到的businessID
file_elem_download_flag
- 参数类型 : int
- 参数描述 : 只读, 文件下载flag
file_elem_url
- 参数类型 : string
- 参数描述 : 只读, 文件下载的URL
file_elem_task_id
- 参数类型 : int
- 参数描述 : 只读, 任务ID,废弃
video_elem_video_type
- 参数类型 : string
- 参数描述 : 读写(必填), 视频文件类型,发送消息时进行设置
video_elem_video_size
- 参数类型 : uint
- 参数描述 : 读写(必填), 视频文件大小
video_elem_video_duration
- 参数类型 : uint
- 参数描述 : 读写(必填), 视频时长,发送消息时进行设置
video_elem_video_path
- 参数类型 : string
- 参数描述 : 读写(必填), 适配文件路径
video_elem_video_id
- 参数类型 : string
- 参数描述 : 只读, 视频 ID
video_elem_business_id
- 参数类型 : int
- 参数描述 : 只读, 下载时用到的businessID
video_elem_video_download_flag
- 参数类型 : int
- 参数描述 : 只读, 视频文件下载flag
video_elem_video_url
- 参数类型 : string
- 参数描述 : 只读, 视频文件下载的URL
video_elem_image_type
- 参数类型 : string
- 参数描述 : 读写(必填), 截图文件类型,发送消息时进行设置
video_elem_image_size
- 参数类型 : uint
- 参数描述 : 读写(必填), 截图文件大小
video_elem_image_width
- 参数类型 : uint
- 参数描述 : 读写(必填), 截图高度,发送消息时进行设置
video_elem_image_height
- 参数类型 : uint
- 参数描述 : 读写(必填), 截图宽度,发送消息时进行设置
video_elem_image_path
- 参数类型 : string
- 参数描述 : 读写(必填), 保存截图的路径
video_elem_image_id
- 参数类型 : string
- 参数描述 : 只读, 截图 ID
video_elem_image_download_flag
- 参数类型 : int
- 参数描述 : 只读, 截图文件下载flag
video_elem_image_url
- 参数类型 : string
- 参数描述 : 只读, 截图文件下载的URL
video_elem_task_id
- 参数类型 : uint
- 参数描述 : 只读, 任务ID,废弃
merge_elem_title
- 参数类型 : string
- 参数描述 : 读写(必填), 合并消息 title
merge_elem_abstract_array
- 参数类型 : List< string >
- 参数描述 : 读写(必填), 合并消息摘要列表
merge_elem_message_array
- 参数类型 : List< Message >
- 参数描述 : 读写(必填), 消息列表(最大支持 300 条,消息对象必须是 kTIMMsg_SendSucc 状态,消息类型不能为 GroupTipsElem 或 GroupReportElem)
merge_elem_compatible_text
- 参数类型 : string
- 参数描述 : 读写(必填), 合并消息兼容文本,低版本 SDK 如果不支持合并消息,默认会收到一条文本消息,文本消息的内容为 compatibleText,该参数不能为空。
merge_elem_layer_over_limit
- 参数类型 : bool
- 参数描述 : 只读, 合并消息里面又包含合并消息我们称之为合并嵌套,合并嵌套层数不能超过 100 层,如果超过限制,layersOverLimit 会返回 YES,kTIMMergerElemTitle 和 kTIMMergerElemAbstractArray 为空,DownloadMergerMessage 会返回 ERR_MERGER_MSG_LAYERS_OVER_LIMIT 错误码。
merge_elem_relay_pb_key
- 参数类型 : string
- 参数描述 : 只读, native 端消息列表下载 key
merge_elem_relay_json_key
- 参数类型 : string
- 参数描述 : 只读, web 端消息列表下载 key
merge_elem_relay_buffer
- 参数类型 : string
- 参数描述 : 只读, 转发消息的 buffer
group_tips_elem_tip_type
- 参数类型 : TIMGroupTipType
- 参数描述 : 只读, 群消息类型
group_tips_elem_op_user
- 参数类型 : string
- 参数描述 : 只读, 操作者ID
group_tips_elem_group_name
- 参数类型 : string
- 参数描述 : 只读, 群组名称
group_tips_elem_group_id
- 参数类型 : string
- 参数描述 : 只读, 群组ID
group_tips_elem_time
- 参数类型 : uint
- 参数描述 : 只读, 群消息时间,废弃
group_tips_elem_user_array
- 参数类型 : List< string >
- 参数描述 : 只读, 被操作的帐号列表
group_tips_elem_group_change_info_array
- 参数类型 : List< GroupTipGroupChangeInfo >
- 参数描述 : 只读, 群资料变更信息列表,仅当 tips_type 值为 kTIMGroupTip_GroupInfoChange 时有效
group_tips_elem_member_change_info_array
- 参数类型 : List< GroupTipMemberChangeInfo >
- 参数描述 : 只读, 群成员变更信息列表,仅当 tips_type 值为 kTIMGroupTip_MemberInfoChange 时有效
group_tips_elem_op_user_info
- 参数类型 : UserProfile
- 参数描述 : 只读, 操作者个人资料
group_tips_elem_op_group_memberinfo
- 参数类型 : GroupMemberInfo
- 参数描述 : 只读, 群成员信息
group_tips_elem_changed_user_info_array
- 参数类型 : List< UserProfile >
- 参数描述 : 只读, 被操作者列表资料
group_tips_elem_changed_group_memberinfo_array
- 参数类型 : List< GroupMemberInfo >
- 参数描述 : 只读, 群成员信息列表
group_tips_elem_member_num
- 参数类型 : uint
- 参数描述 : 只读, 当前群成员数,只有当事件消息类型为 kTIMGroupTip_Invite 、 kTIMGroupTip_Quit 、 kTIMGroupTip_Kick 时有效
group_tips_elem_platform
- 参数类型 : string
- 参数描述 : 只读, 操作方平台信息
group_report_elem_report_type
- 参数类型 : TIMGroupReportType
- 参数描述 : 只读, 类型
group_report_elem_group_id
- 参数类型 : string
- 参数描述 : 只读, 群组ID
group_report_elem_group_name
- 参数类型 : string
- 参数描述 : 只读, 群组名称
group_report_elem_op_user
- 参数类型 : string
- 参数描述 : 只读, 操作者ID
group_report_elem_msg
- 参数类型 : string
- 参数描述 : 只读, 操作理由
group_report_elem_user_data
- 参数类型 : string
- 参数描述 : 只读, 操作者填的自定义数据
group_report_elem_op_user_info
- 参数类型 : UserProfile
- 参数描述 : 只读, 操作者个人资料
group_report_elem_op_group_memberinfo
- 参数类型 : GroupMemberInfo
- 参数描述 : 只读,操作者群内资料
group_report_elem_platform
- 参数类型 : string
- 参数描述 : 只读, 操作方平台信息
profile_change_elem_change_type
- 参数类型 : TIMProfileChangeType
- 参数描述 : 只读, 资料变更类型
profile_change_elem_from_identifer
- 参数类型 : string
- 参数描述 : 只读, 资料变更用户的UserID
profile_change_elem_user_profile_item
- 参数类型 : UserProfileItem
- 参数描述 : 只读, 具体的变更信息,只有当 change_type 为 kTIMProfileChange_Profile 时有效