ChatSDK 命名空间参考

命名空间
namespace	MessageBody

类
class	CallBack
class	ChatThread
class	ChatThreadEvent
class	Conversation
class	CursorResult
struct	CursorResultTO
class	DeviceInfo
class	Error
class	Group
class	GroupInfo
class	GroupOptions
class	GroupReadAck
class	GroupSharedFile
class	IChatManager
interface	IChatManagerDelegate
class	IChatThreadManager
interface	IChatThreadManagerDelegate
class	IClient
interface	IConnectionDelegate
class	IContactManager
interface	IContactManagerDelegate
class	IConversationManager
class	IGroupManager
interface	IGroupManagerDelegate
class	IMessageBody
interface	IMultiDeviceDelegate
class	IPresenceManager
interface	IPresenceManagerDelegate
class	IRoomManager
interface	IRoomManagerDelegate
class	IUserInfoManager
class	Message
class	MessageReaction
class	MessageReactionChange
class	Options
class	PageResult
class	Presence
class	PresenceDeviceStatus
class	Room
class	SDKClient
class	SupportLanguage
class	UserInfo
class	ValueCallBack

枚举
enum	DataType {   Bool , String , Group , Room ,   CursorResult , ListOfString , ListOfMessage , ListOfConversation ,   ListOfGroup , ListOfGroupSharedFile }
enum	MessageBodyType {   TXT , IMAGE , VIDEO , LOCATION ,   VOICE , FILE , CMD , CUSTOM }
enum	MessageType { Chat = 0 , Group , Room }
enum	MessageStatus { CREATE , PROGRESS , SUCCESS , FAIL }
enum	MessageDirection { SEND , RECEIVE }
enum	ConversationType { Chat , Group , Room }
enum	MessageSearchDirection { UP , DOWN }
enum	GroupStyle { PrivateOnlyOwnerInvite , PrivateMemberCanInvite , PublicJoinNeedApproval , PublicOpenJoin }
enum	GroupPermissionType {   Member , Admin , Owner , Unknown = -1 ,   Default =Unknown , None =Unknown }
enum	RoomPermissionType {   Member , Admin , Owner , Unknown = -1 ,   Default = Unknown , None = Unknown }
enum	PushStyle : byte { Simple , Summary }
enum	AttributeValueType : byte {   BOOL = 0 , INT32 , UINT32 , INT64 ,   FLOAT , DOUBLE , STRING , JSONSTRING ,   NULLOBJ }
enum	MultiDevicesOperation {   UNKNOWN = -1 , CONTACT_REMOVE = 2 , CONTACT_ACCEPT = 3 , CONTACT_DECLINE = 4 ,   CONTACT_BAN = 5 , CONTACT_ALLOW = 6 , GROUP_CREATE = 10 , GROUP_DESTROY = 11 ,   GROUP_JOIN = 12 , GROUP_LEAVE = 13 , GROUP_APPLY = 14 , GROUP_APPLY_ACCEPT = 15 ,   GROUP_APPLY_DECLINE = 16 , GROUP_INVITE = 17 , GROUP_INVITE_ACCEPT = 18 , GROUP_INVITE_DECLINE = 19 ,   GROUP_KICK = 20 , GROUP_BAN = 21 , GROUP_ALLOW = 22 , GROUP_BLOCK = 23 ,   GROUP_UNBLOCK = 24 , GROUP_ASSIGN_OWNER = 25 , GROUP_ADD_ADMIN = 26 , GROUP_REMOVE_ADMIN = 27 ,   GROUP_ADD_MUTE = 28 , GROUP_REMOVE_MUTE = 29 , GROUP_ADD_USER_WHITE_LIST = 30 , GROUP_REMOVE_USER_WHITE_LIST = 31 ,   GROUP_ALL_BAN = 32 , GROUP_REMOVE_ALL_BAN = 33 , THREAD_CREATE = 40 , THREAD_DESTROY = 41 ,   THREAD_JOIN = 42 , THREAD_LEAVE = 43 , THREAD_UPDATE = 44 , THREAD_KICK = 45 }
enum	SilentModeParamType { RemindType = 0 , Duration , Interval }
enum	PushRemindType { Default = 0 , All , MentionOnly , None }
enum	ChatThreadOperation {   UnKnown = 0 , Create , Update , Delete ,   Update_Msg }
enum	UserInfoType {   NICKNAME = 0 , AVATAR_URL = 1 , EMAIL = 2 , PHONE = 3 ,   GENDER = 4 , SIGN = 5 , BIRTH = 6 , EXT = 100 }

函数
delegate void	OnError (int code, string desc)
delegate void	OnProgress (int progress)

枚举类型说明

DataType

enum ChatSDK.DataType

数据类型枚举。

MessageBodyType

enum ChatSDK.MessageBodyType

消息类型枚举。

枚举值
TXT	文本消息。
IMAGE	图片消息。
VIDEO	视频消息。
LOCATION	位置消息。
VOICE	语音消息。
FILE	文件消息。
CMD	命令消息（透传消息）。
CUSTOM	用户自定义消息。

MessageType

enum ChatSDK.MessageType

聊天类型枚举。

枚举值
Chat	单聊。
Group	群聊。
Room	聊天室。

MessageStatus

enum ChatSDK.MessageStatus

消息状态枚举。

枚举值
CREATE	消息已创建。
PROGRESS	消息正在发送。
SUCCESS	消息发送成功。
FAIL	消息发送失败。

MessageDirection

enum ChatSDK.MessageDirection

消息方向枚举。

枚举值
SEND	该消息是当前用户发送出去的。
RECEIVE	该消息是当前用户接收到的。

ConversationType

enum ChatSDK.ConversationType

会话类型枚举。

枚举值
Chat	单聊会话。
Group	群聊会话。
Room	聊天室会话。

MessageSearchDirection

enum ChatSDK.MessageSearchDirection

消息查询方向枚举。

枚举值
UP	按消息中的时间戳 (SortMessageByServerTime) 的倒序加载。
DOWN	按消息中的时间戳 (SortMessageByServerTime) 的顺序加载。

GroupStyle

enum ChatSDK.GroupStyle

群组类型枚举。

枚举值
PrivateOnlyOwnerInvite	私有群组，只允许群主邀请用户加入。
PrivateMemberCanInvite	私有群组，群成员可邀请用户加入。
PublicJoinNeedApproval	公开群组，只允许群主邀请用户加入; 非群成员用户需发送入群申请，群主或群组管理员同意后才能入群。
PublicOpenJoin	公开群组，允许非群组成员加入，无需群主或管理员同意.

GroupPermissionType

enum ChatSDK.GroupPermissionType

群组成员角色枚举。

枚举值
Member	普通成员。
Admin	群组管理员。
Owner	群主。
Unknown	未知。

RoomPermissionType

enum ChatSDK.RoomPermissionType

聊天室成员枚举。

枚举值
Member	普通成员。
Admin	聊天室管理员。
Owner	聊天室所有者。
Unknown	未知。

PushStyle

enum ChatSDK.PushStyle : byte

推送通知的显示样式枚举。

枚举值
Simple	显示“你有一条新消息”。
Summary	显示离线消息的内容。

AttributeValueType

enum ChatSDK.AttributeValueType : byte

消息的扩展属性类型的枚举。

枚举值
BOOL	布尔类型。
INT32	有符号的 32 位整型。
UINT32	无符号的 32 位整型。
INT64	有符号的 64 位整型。
FLOAT	浮点类型。
DOUBLE	双精度类型。
STRING	字符串类型。
JSONSTRING	JSON 字符串类型。

MultiDevicesOperation

enum ChatSDK.MultiDevicesOperation

多设备操作类型枚举。

枚举值
CONTACT_REMOVE	当前用户在其他设备上删除好友。
CONTACT_ACCEPT	当前用户在其他设备上接受好友请求。
CONTACT_DECLINE	当前用户在其他设备上拒绝好友请求。
CONTACT_BAN	当前用户在其他设备上将好友加入黑名单。
CONTACT_ALLOW	当前用户在其他设备上将好友移出黑名单。
GROUP_CREATE	当前用户在其他设备上创建群组。
GROUP_DESTROY	当前用户在其他设备上解散群组。
GROUP_JOIN	当前用户在其他设备上加入群组。
GROUP_LEAVE	当前用户在其他设备离开群组。
GROUP_APPLY	当前用户在其他设备上申请加入群组。
GROUP_APPLY_ACCEPT	当前用户在其他设备接受入群申请。
GROUP_APPLY_DECLINE	当前用户在其他设备上拒绝入群申请。
GROUP_INVITE	当前用户在其他设备上邀请用户入群。
GROUP_INVITE_ACCEPT	当前用户在其他设备上接受了入群邀请。
GROUP_INVITE_DECLINE	当前用户在其他设备上拒绝了入群邀请。
GROUP_KICK	当前用户在其他设备上将成员踢出群。
GROUP_BAN	当前用户在其他设备上将成员加入群组黑名单。
GROUP_ALLOW	当前用户在其他设备上将成员移除群组黑名单。
GROUP_BLOCK	当前用户在其他设备上屏蔽群组。
GROUP_UNBLOCK	当前用户在其他设备上取消群组屏蔽。
GROUP_ASSIGN_OWNER	当前用户在其他设备上转让群组所有权。
GROUP_ADD_ADMIN	当前用户在其他设备上添加管理员。
GROUP_REMOVE_ADMIN	当前用户在其他设备上移除管理员。
GROUP_ADD_MUTE	当前用户在其他设备上禁言成员。
GROUP_REMOVE_MUTE	当前用户在其他设备上解除禁言。
GROUP_ADD_USER_WHITE_LIST	当前用户在其他设备上将群组成员添加至白名单。
GROUP_REMOVE_USER_WHITE_LIST	当前用户在其他设备上将群组成员移除白名单。
GROUP_ALL_BAN	当前用户在其他设备上将所有其他群组成员禁言。
GROUP_REMOVE_ALL_BAN	当前用户在其他设备上将所有其他群组成员解除禁言。
THREAD_CREATE	子区在其他设备上被创建。
THREAD_DESTROY	子区在其他设备上被销毁。
THREAD_JOIN	在其他设备上加入子区。
THREAD_LEAVE	在其他设备上加退出子区。
THREAD_UPDATE	子区在其他设备上有更新。
THREAD_KICK	在其他设备上被提出子区。

SilentModeParamType

enum ChatSDK.SilentModeParamType

枚举值
RemindType	离线消息推送方式。
Duration	免打扰时长，单位为分钟。
Interval	免打扰时间段。仅 app 全局设置有效，对单个会话无效。

PushRemindType

enum ChatSDK.PushRemindType

枚举值
Default	\～chinese 缺省接收全部离线消息的推送通知。
All	\～chinese 接收全部离线消息的推送通知。
MentionOnly	\～chinese 只接收提及当前用户的离线消息的推送通知。
None	\～chinese 不接收离线消息的推送通知。

ChatThreadOperation

enum ChatSDK.ChatThreadOperation

枚举值
UnKnown	\～chinese 未知操作，缺省值。
Create	\～chinese 创建子区。
Update	\～chinese 更新子区。
Delete	\～chinese 删除子区。
Update_Msg	\～chinese 子区消息更新。

UserInfoType

enum ChatSDK.UserInfoType

用户属性枚举类。

枚举值
NICKNAME	用户昵称。
AVATAR_URL	用户头像的 URL。
EMAIL	用户的电子邮件地址。
PHONE	用户的电话号码。
GENDER	用户的性别。 （默认）0：未知； 1：男； 2：女。
SIGN	用户的签名。
BIRTH	用户的生日。
EXT	用户的扩展信息。 用户可自行扩展，建议封装成 JSON 字符串，也可设置为空字符串。

函数说明

OnError()

delegate void ChatSDK.OnError	(	int	code,
		string	desc
	)

执行错误回调。

参数

code	错误码。
desc	错误描述。

OnProgress()

delegate void ChatSDK.OnProgress

(

int

progress

)

执行进度回调。

参数

progress

执行进度值，取值范围为 [0,100]。