SDK 中的类型常量。为了代码简洁、方便阅读,部分常量使用常见的英文单词缩写描述,具体如下:
缩写 | 全称 |
---|---|
CONV | CONVERSATION(会话) |
GRP | GROUP(群组) |
MSG | MESSAGE(消息) |
SYS | SYSTEM(系统) |
MBR | MEMBER(成员) |
SNS | SNS(好友关系链) |
ACPT | ACCEPT(接受) |
NOTE | NOTIFY(通知) |
MULT | MULTIPLE(多重的) |
Example
// 判断消息类型
const isTextMessage = message.type === TIM.TYPES.MSG_TEXT // 是否是文本消息类型
// 判断会话类型
const isGroupConversation = conversation.type === TIM.TYPES.CONV_GROUP // 是否是群组会话
Members
(static) MSG_TEXT
消息类型:文本消息
(static) MSG_IMAGE
消息类型:图片消息
(static) MSG_SOUND
消息类型:音频消息
注意:已废弃,请使用 MSG_AUDIO
(static) MSG_AUDIO
消息类型:音频消息
(static) MSG_FILE
消息类型:文件消息
(static) MSG_FACE
消息类型:表情消息
(static) MSG_VIDEO
消息类型:视频消息
(static) MSG_GEO
消息类型:地理位置消息
注意:已废弃,请使用 MSG_LOCATION
(static) MSG_LOCATION
消息类型:地理位置消息
(static) MSG_GRP_TIP
消息类型:群提示消息
(static) MSG_GRP_SYS_NOTICE
消息类型:群系统通知消息
(static) MSG_CUSTOM
消息类型:自定义消息
(static) MSG_MERGER
消息类型:合并消息。v2.10.1 起支持。
(static) MSG_PRIORITY_HIGH
群消息高优先级。建议选择该优先级的消息类型:红包消息和礼物消息
(static) MSG_PRIORITY_NORMAL
群消息普通优先级。建议选择该优先级的消息类型:普通文本消息
(static) MSG_PRIORITY_LOW
群消息低优先级。建议选择该优先级的消息类型:点赞消息
(static) MSG_PRIORITY_LOWEST
群消息最低优先级。建议选择该优先级的消息类型:最不重要的消息
(static) CONV_C2C
会话类型:C2C(Client to Client, 端到端) 会话
(static) CONV_GROUP
会话类型:GROUP(群组) 会话
(static) CONV_SYSTEM
会话类型:SYSTEM(系统) 会话
(static) CONV_AT_ME
群会话 at 类型:有人 at 我。v2.9.0起支持
(static) CONV_AT_ALL
群会话 at 类型:at 群里所有人。v2.9.0起支持
(static) CONV_AT_ALL_AT_ME
群会话 at 类型:at 群里所有人并且单独 at 我,这里并不区分先 at 群里所有人还是先 at 我。v2.9.0起支持
(static) CONV_MARK_TYPE_STAR
会话标记类型:会话标星。v2.21.0起支持
(static) CONV_MARK_TYPE_UNREAD
会话标记类型:会话标记未读(重要会话)。v2.21.0起支持
(static) CONV_MARK_TYPE_FOLD
会话标记类型:会话折叠。v2.21.0起支持
(static) CONV_MARK_TYPE_HIDE
会话标记类型:会话隐藏。v2.21.0起支持
(static) GRP_PRIVATE
- Deprecated:
-
- !!!v2.7.1起弃用,请使用 GRP_WORK。
群组类型:私有群
(static) GRP_WORK
群组类型:好友工作群
(static) GRP_PUBLIC
群组类型:陌生人社交群
(static) GRP_CHATROOM
- Deprecated:
-
- !!!v2.7.1起弃用,请使用 GRP_MEETING。
群组类型:聊天室
(static) GRP_MEETING
群组类型:临时会议群
(static) GRP_AVCHATROOM
群组类型:直播群
(static) GRP_COMMUNITY
群组类型:社群。v2.17.0 起支持。
(static) GRP_MBR_ROLE_OWNER
群成员角色:群主
(static) GRP_MBR_ROLE_ADMIN
群成员角色:管理员
(static) GRP_MBR_ROLE_MEMBER
群成员角色:普通群成员
(static) GRP_MBR_ROLE_CUSTOM
群成员角色:社群自定义成员角色。v2.17.0 起支持,仅社群可用。
(static) GRP_TIP_MBR_JOIN
群提示:有成员加群
(static) GRP_TIP_MBR_QUIT
群提示:有群成员退群
(static) GRP_TIP_MBR_KICKED_OUT
群提示:有群成员被踢出群
(static) GRP_TIP_MBR_SET_ADMIN
群提示:有群成员被设为管理员
(static) GRP_TIP_MBR_CANCELED_ADMIN
群提示:有群成员被撤销管理员
(static) GRP_TIP_GRP_PROFILE_UPDATED
群提示:群组资料变更
(static) GRP_TIP_MBR_PROFILE_UPDATED
群提示:群成员资料变更
(static) GRP_TIP_BAN_AVCHATROOM_MEMBER
群提示:封禁直播群群成员。v2.22.0 起支持
(static) GRP_TIP_UNBAN_AVCHATROOM_MEMBER
群提示:解封直播群群成员。v2.22.0 起支持
(static) MSG_REMIND_ACPT_AND_NOTE
群消息提示类型:SDK 接收消息并通知接入侧,接入侧做提示
(static) MSG_REMIND_ACPT_NOT_NOTE
群消息提示类型:SDK 接收消息并通知接入侧,接入侧不做提示
(static) MSG_REMIND_DISCARD
群消息提示类型:SDK 拒收消息
(static) GENDER_UNKNOWN
性别:未设置性别
(static) GENDER_FEMALE
性别:女性
(static) GENDER_MALE
性别:男性
(static) KICKED_OUT_MULT_ACCOUNT
被踢类型:多帐号登录被踢
(static) KICKED_OUT_MULT_DEVICE
被踢类型:多终端登录被踢
(static) KICKED_OUT_USERSIG_EXPIRED
被踢类型:签名过期
(static) KICKED_OUT_REST_API
被踢类型:REST API kick 接口踢出,v2.20.0 起支持
(static) ALLOW_TYPE_ALLOW_ANY
当被人加好友时:允许任何人添加自己为好友
(static) ALLOW_TYPE_NEED_CONFIRM
当被人加好友时:需要经过自己确认才能添加自己为好友
(static) ALLOW_TYPE_DENY_ANY
当被人加好友时:不允许任何人添加自己为好友
(static) FORBID_TYPE_NONE
管理员禁止加好友标识:默认值,允许加好友
(static) FORBID_TYPE_SEND_OUT
管理员禁止加好友标识:禁止该用户发起加好友请求
(static) JOIN_OPTIONS_FREE_ACCESS
加群选项:自由加入
(static) JOIN_OPTIONS_NEED_PERMISSION
加群选项:需要管理员同意
(static) JOIN_OPTIONS_DISABLE_APPLY
加群选项:不允许加群
(static) JOIN_STATUS_SUCCESS
加群申请状态:加群成功
(static) JOIN_STATUS_ALREADY_IN_GROUP
加群申请状态:已在群中
(static) JOIN_STATUS_WAIT_APPROVAL
加群申请状态:等待管理员同意
(static) INVITE_OPTIONS_DISABLE_INVITE
邀请进群选项:禁止邀请。v2.27.0 起支持
(static) INVITE_OPTIONS_NEED_PERMISSION
邀请进群选项:需要群主/群管理员审批。v2.27.0 起支持
(static) INVITE_OPTIONS_FREE_ACCESS
邀请进群选项:无需审批即可邀请进群。v2.27.0 起支持
(static) GRP_PROFILE_OWNER_ID
群资料:群主 ID
(static) GRP_PROFILE_CREATE_TIME
群资料:群创建时间
(static) GRP_PROFILE_LAST_INFO_TIME
群资料:最后一次群资料变更时间
(static) GRP_PROFILE_MEMBER_NUM
群资料:当前群组的群成员数量
(static) GRP_PROFILE_MAX_MEMBER_NUM
群资料:当前群组的最大群成员数量
(static) GRP_PROFILE_JOIN_OPTION
群资料:申请加群选项
(static) GRP_PROFILE_INVITE_OPTION
群资料:邀请进群选项
(static) GRP_PROFILE_INTRODUCTION
群资料:群介绍
(static) GRP_PROFILE_NOTIFICATION
群资料:群公告
(static) GRP_PROFILE_MUTE_ALL_MBRS
群资料:全体禁言设置。v2.6.2 起支持。
(static) SNS_ADD_TYPE_SINGLE
加好友方式:表示单向加好友
(static) SNS_ADD_TYPE_BOTH
加好友方式:表示双向加好友
(static) SNS_DELETE_TYPE_SINGLE
删除好友方式:表示单向删除好友
(static) SNS_DELETE_TYPE_BOTH
删除好友方式:表示双向删除好友
(static) SNS_APPLICATION_TYPE_BOTH
拉取好友申请:别人发给我的和我发给别人的加好友请求
(static) SNS_APPLICATION_SENT_TO_ME
拉取好友申请:别人发给我的加好友请求
(static) SNS_APPLICATION_SENT_BY_ME
拉取好友申请:我发给别人的加好友请求
(static) SNS_APPLICATION_AGREE
同意好友申请方式:同意添加单向好友
(static) SNS_APPLICATION_AGREE_AND_ADD
同意好友申请方式:同意并添加为双向好友
(static) SNS_CHECK_TYPE_BOTH
校验好友:双向校验好友
(static) SNS_CHECK_TYPE_SINGLE
校验好友:单向校验好友
(static) SNS_TYPE_NO_RELATION
好友关系:A 的好友表中没有 B,B 的好友表中也没有 A
(static) SNS_TYPE_A_WITH_B
好友关系:A 的好友表中有 B,但 B 的好友表中没有 A
(static) SNS_TYPE_B_WITH_A
好友关系:A 的好友表中没有 B,但 B 的好友表中有 A
(static) SNS_TYPE_BOTH_WAY
好友关系:A 的好友表中有 B,B 的好友表中也有 A
(static) NET_STATE_CONNECTED
网络状态:已接入网络。v2.5.0 起支持。
(static) NET_STATE_CONNECTING
网络状态:连接中。v2.5.0 起支持。
(static) NET_STATE_DISCONNECTED
网络状态:未接入网络。v2.5.0 起支持。
(static) MSG_AT_ALL
群聊时 @ 所有人。v2.9.0 起支持,社群不支持 @ 所有人
(static) READ_ALL_C2C_MSG
参数设置类型,将所有C2C未读消息设置为已读。v2.16.0 起支持
(static) READ_ALL_GROUP_MSG
参数设置类型,将所有群未读消息设置为已读。v2.16.0 起支持
(static) READ_ALL_MSG
参数设置类型,将所有 C2C 和群未读消息设置为已读。v2.16.0 起支持
(static) USER_STATUS_UNKNOWN
用户状态:未知。v2.21.0 起支持
(static) USER_STATUS_ONLINE
用户状态:在线。v2.21.0 起支持
(static) USER_STATUS_OFFLINE
用户状态:离线(app 处于离线状态时触发,web 没有离线状态)。v2.21.0 起支持
(static) USER_STATUS_UNLOGINED
用户状态:未登录。v2.21.0 起支持