AgoraChat 命名空间参考

命名空间
namespace	MessageBody

类
class	CallBack
class	ChatManager
class	ChatThread
class	ChatThreadEvent
class	ChatThreadManager
class	Contact
class	ContactManager
class	Conversation
class	CursorResult
class	DeviceInfo
class	Error
class	FetchServerMessagesOption
class	Group
class	GroupInfo
class	GroupManager
class	GroupOptions
class	GroupReadAck
class	GroupSharedFile
interface	IChatManagerDelegate
interface	IChatThreadManagerDelegate
interface	IConnectionDelegate
interface	IContactManagerDelegate
interface	IGroupManagerDelegate
class	IMessageBody
interface	IMultiDeviceDelegate
interface	IPresenceManagerDelegate
interface	IRoomManagerDelegate
class	Message
class	MessageReaction
class	MessageReactionChange
class	MessageReactionOperation
class	Options
class	PageResult
class	PinnedInfo
class	Presence
class	PresenceDeviceStatus
class	PresenceManager
class	RecallMessageInfo
class	Room
class	RoomManager
class	SDKClient
class	SupportLanguage
class	UserInfo
class	UserInfoManager
class	ValueCallBack

枚举
enum	AreaCode {   CN = 1 , NA = 2 , EU = 4 , AS = 8 ,   JP = 16 , IN = 32 , GLOB = -1 }
enum	DisconnectReason {   Reason_Disconnected , Reason_AuthenticationFailed , Reason_LoginFromOtherDevice , Reason_RemoveFromServer ,   Reason_LoginTooManyDevice , Reason_ChangePassword , Reason_KickedByOtherDevice , Reason_ForbidByServer }
enum	ChatThreadOperation {   UnKnown = 0 , Create , Update , Delete ,   Update_Msg }
enum	GroupPermissionType {   Member , Admin , Owner , Unknown = -1 ,   Default = Unknown , None = Unknown }
enum	GroupStyle { PrivateOnlyOwnerInvite , PrivateMemberCanInvite , PublicJoinNeedApproval , PublicOpenJoin }
enum	RoomPermissionType {   Member , Admin , Owner , Unknown = -1 ,   Default = Unknown , None = Unknown }
enum	ConversationType { Chat , Group , Room }
enum	MessageBodyType {   TXT , IMAGE , VIDEO , LOCATION ,   VOICE , FILE , CMD , CUSTOM ,   COMBINE }
enum	RoomMessagePriority { High = 0 , Normal , Low }
enum	MessageSearchDirection { UP , DOWN }
enum	MessageSearchScope { CONTENT , EXT , ALL }
enum	MessageStatus { CREATE , PROGRESS , SUCCESS , FAIL }
enum	MessageType { Chat = 0 , Group , Room }
enum	MessageDirection { SEND , RECEIVE }
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 ,   SET_METADATA = 50 , DELETE_METADATA = 51 , GROUP_MEMBER_METADATA_CHANGED = 52 , CONVERSATION_PINNED = 60 ,   CONVERSATION_UNPINNED = 61 , CONVERSATION_DELETED = 62 , CONVERSATION_MARK = 63 }
enum	MessageReactionOperate { MessageReactionOperateRemove = 0 , MessageReactionOperateAdd = 1 }
enum	MarkType {   MarkType0 = 0 , MarkType1 = 1 , MarkType2 = 2 , MarkType3 = 3 ,   MarkType4 = 4 , MarkType5 = 5 , MarkType6 = 6 , MarkType7 = 7 ,   MarkType8 = 8 , MarkType9 = 9 , MarkType10 = 10 , MarkType11 = 11 ,   MarkType12 = 12 , MarkType13 = 13 , MarkType14 = 14 , MarkType15 = 15 ,   MarkType16 = 16 , MarkType17 = 17 , MarkType18 = 18 , MarkType19 = 19 }

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

枚举类型说明

AreaCode

enum AgoraChat.AreaCode

区域代码。

DisconnectReason

enum AgoraChat.DisconnectReason

链接断开原因。

枚举值
Reason_Disconnected	断开链接, 无具体原因。
Reason_AuthenticationFailed	用户 ID 或者密码认证错误。
Reason_LoginFromOtherDevice	用户在另一台设备上登录。
Reason_RemoveFromServer	用户被从 server 上移除。
Reason_LoginTooManyDevice	用户登录登录设备超限。
Reason_ChangePassword	用户密码变更。
Reason_KickedByOtherDevice	用户被其他设备或者后端控制台踢出。
Reason_ForbidByServer	服务被禁止。

ChatThreadOperation

enum AgoraChat.ChatThreadOperation

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

GroupPermissionType

enum AgoraChat.GroupPermissionType

群组成员角色枚举。

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

GroupStyle

enum AgoraChat.GroupStyle

群组类型枚举。

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

RoomPermissionType

enum AgoraChat.RoomPermissionType

聊天室成员枚举。

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

ConversationType

enum AgoraChat.ConversationType

会话类型枚举。

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

MessageBodyType

enum AgoraChat.MessageBodyType

消息类型枚举。

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

RoomMessagePriority

enum AgoraChat.RoomMessagePriority

聊天室消息优先级枚举。

枚举值
High	高优先级。
Normal	普通优先级。
Low	低优先级。

MessageSearchDirection

enum AgoraChat.MessageSearchDirection

消息查询方向枚举。

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

MessageSearchScope

enum AgoraChat.MessageSearchScope

消息搜索范围枚举类型。

枚举值
CONTENT	按消息内容搜索。
EXT	按消息扩展属性搜索。
ALL	按消息内容和扩展属性搜索。

MessageStatus

enum AgoraChat.MessageStatus

消息状态枚举。

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

MessageType

enum AgoraChat.MessageType

聊天类型枚举。

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

MessageDirection

enum AgoraChat.MessageDirection

消息方向枚举。

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

AttributeValueType

enum AgoraChat.AttributeValueType : byte

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

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

MultiDevicesOperation

enum AgoraChat.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	在其他设备上被踢出子区。
SET_METADATA	在其他设备上设置了群组成员自定义属性。
DELETE_METADATA	在其他设备上删除了群组成员自定义属性。
GROUP_MEMBER_METADATA_CHANGED	群组成员自定义属性发生改变。
CONVERSATION_PINNED	会话被置顶。
CONVERSATION_UNPINNED	会话被取消置顶。
CONVERSATION_DELETED	会话被删除。
CONVERSATION_MARK	会话被标记或取消标记。

MessageReactionOperate

enum AgoraChat.MessageReactionOperate

枚举值
MessageReactionOperateRemove	Reaction 删除操作。
MessageReactionOperateAdd	Reaction 添加操作。

MarkType

enum AgoraChat.MarkType

会话标记。

函数说明

OnError()

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

执行错误回调。

参数

code	错误码。
desc	错误描述。

OnProgress()

delegate void AgoraChat.OnProgress

(

int

progress

)

执行进度回调。

参数

progress

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