Chat SDK for Unity and Windows v1.3.1
|
Public 成员函数 | |
void | applyJoinToGroup (string groupId, string reason="", CallBack callback=null) |
void | AcceptGroupInvitation (string groupId, ValueCallBack< Group > callback=null) |
void | AcceptGroupJoinApplication (string groupId, string userId, CallBack callback=null) |
void | AddGroupAdmin (string groupId, string memberId, CallBack callback=null) |
void | AddGroupMembers (string groupId, List< string > newmembers, CallBack callback=null) |
void | AddGroupAllowList (string groupId, List< string > members, CallBack callback=null) |
void | BlockGroup (string groupId, CallBack callback=null) |
void | BlockGroupMembers (string groupId, List< string > members, CallBack callback=null) |
void | ChangeGroupDescription (string groupId, string desc, CallBack callback=null) |
void | ChangeGroupName (string groupId, string name, CallBack callback=null) |
void | ChangeGroupOwner (string groupId, string newOwner, CallBack callback=null) |
void | CheckIfInGroupAllowList (string groupId, ValueCallBack< bool > callback=null) |
void | CreateGroup (string groupName, GroupOptions options, string desc=null, List< string > inviteMembers=null, string inviteReason=null, ValueCallBack< Group > callback=null) |
void | DeclineGroupInvitation (string groupId, string reason=null, CallBack callback=null) |
void | DeclineGroupJoinApplication (string groupId, string userId, string reason=null, CallBack callback=null) |
void | DestroyGroup (string groupId, CallBack callback=null) |
void | DownloadGroupSharedFile (string groupId, string fileId, string savePath, CallBack callback=null) |
void | GetGroupAnnouncementFromServer (string groupId, ValueCallBack< string > callback=null) |
void | GetGroupBlockListFromServer (string groupId, int pageNum=1, int pageSize=200, ValueCallBack< List< string > > callback=null) |
void | GetGroupFileListFromServer (string groupId, int pageNum=1, int pageSize=200, ValueCallBack< List< GroupSharedFile > > callback=null) |
void | GetGroupMemberListFromServer (string groupId, int pageSize=200, string cursor="", ValueCallBack< CursorResult< string > > callback=null) |
void | GetGroupMuteListFromServer (string groupId, int pageNum=1, int pageSize=200, ValueCallBack< Dictionary< string, long > > callback=null) |
void | GetGroupSpecificationFromServer (string groupId, ValueCallBack< Group > callback=null) |
void | GetGroupAllowListFromServer (string groupId, ValueCallBack< List< string > > callback=null) |
Group | GetGroupWithId (string groupId) |
List< Group > | GetJoinedGroups () |
void | FetchJoinedGroupsFromServer (int pageNum=0, int pageSize=20, bool needAffiliations=false, bool needRole=false, ValueCallBack< List< Group > > callback=null) |
void | FetchJoinedGroupsFromServer (int pageNum=0, int pageSize=20, ValueCallBack< List< Group > > callback=null) |
void | FetchPublicGroupsFromServer (int pageSize=200, string cursor="", ValueCallBack< CursorResult< GroupInfo > > callback=null) |
void | JoinPublicGroup (string groupId, CallBack callback=null) |
void | LeaveGroup (string groupId, CallBack callback=null) |
void | MuteGroupAllMembers (string groupId, CallBack callback=null) |
void | MuteGroupMembers (string groupId, List< string > members, long muteMilliseconds=-1, CallBack callback=null) |
void | RemoveGroupAdmin (string groupId, string memberId, CallBack callback=null) |
void | DeleteGroupSharedFile (string groupId, string fileId, CallBack callback=null) |
void | DeleteGroupMembers (string groupId, List< string > members, CallBack callback=null) |
void | RemoveGroupAllowList (string groupId, List< string > members, CallBack callback=null) |
void | UnBlockGroup (string groupId, CallBack callback=null) |
void | UnBlockGroupMembers (string groupId, List< string > members, CallBack callback=null) |
void | UnMuteGroupAllMembers (string groupId, CallBack callback=null) |
void | UnMuteGroupMembers (string groupId, List< string > members, CallBack callback=null) |
void | UpdateGroupAnnouncement (string groupId, string announcement, CallBack callback=null) |
void | UpdateGroupExt (string groupId, string ext, CallBack callback=null) |
void | UploadGroupSharedFile (string groupId, string filePath, CallBack callback=null) |
void | SetMemberAttributes (string groupId, string userId, Dictionary< string, string > attrs, CallBack callback=null) |
void | FetchMemberAttributes (string groupId, List< string > userIds, List< string > attrs, ValueCallBack< Dictionary< string, Dictionary< string, string > > > callback=null) |
void | FetchMyGroupsCount (ValueCallBack< int > callback=null) |
void | AddGroupManagerDelegate (IGroupManagerDelegate groupManagerDelegate) |
void | RemoveGroupManagerDelegate (IGroupManagerDelegate groupManagerDelegate) |
群组管理器抽象类。
void AgoraChat.GroupManager.applyJoinToGroup | ( | string | groupId, |
string | reason = "" , |
||
CallBack | callback = null |
||
) |
void AgoraChat.GroupManager.AcceptGroupInvitation | ( | string | groupId, |
ValueCallBack< Group > | callback = null |
||
) |
void AgoraChat.GroupManager.AcceptGroupJoinApplication | ( | string | groupId, |
string | userId, | ||
CallBack | callback = null |
||
) |
void AgoraChat.GroupManager.AddGroupAdmin | ( | string | groupId, |
string | memberId, | ||
CallBack | callback = null |
||
) |
添加群组管理员。
仅群主可调用此方法,admin 无权限。
异步方法。
groupId | 群组 ID。 |
memberId | 新增加的管理员 ID。 |
callback | 添加结果回调,详见 CallBack 。 |
void AgoraChat.GroupManager.AddGroupMembers | ( | string | groupId, |
List< string > | newmembers, | ||
CallBack | callback = null |
||
) |
void AgoraChat.GroupManager.AddGroupAllowList | ( | string | groupId, |
List< string > | members, | ||
CallBack | callback = null |
||
) |
void AgoraChat.GroupManager.BlockGroup | ( | string | groupId, |
CallBack | callback = null |
||
) |
void AgoraChat.GroupManager.BlockGroupMembers | ( | string | groupId, |
List< string > | members, | ||
CallBack | callback = null |
||
) |
将用户加入群组黑名单。
成功调用该方法后,该用户会先被移除出群组,然后加入群组黑名单。该用户无法接收、发送群消息,也无法申请再次加入群组。
仅群主和管理员可调用此方法。
异步方法。
groupId | 群组ID。 |
members | 要加入黑名单的用户列表。 |
callback | 操作结果回调,详见 CallBack 。 |
void AgoraChat.GroupManager.ChangeGroupDescription | ( | string | groupId, |
string | desc, | ||
CallBack | callback = null |
||
) |
void AgoraChat.GroupManager.ChangeGroupName | ( | string | groupId, |
string | name, | ||
CallBack | callback = null |
||
) |
void AgoraChat.GroupManager.ChangeGroupOwner | ( | string | groupId, |
string | newOwner, | ||
CallBack | callback = null |
||
) |
void AgoraChat.GroupManager.CheckIfInGroupAllowList | ( | string | groupId, |
ValueCallBack< bool > | callback = null |
||
) |
void AgoraChat.GroupManager.CreateGroup | ( | string | groupName, |
GroupOptions | options, | ||
string | desc = null , |
||
List< string > | inviteMembers = null , |
||
string | inviteReason = null , |
||
ValueCallBack< Group > | callback = null |
||
) |
创建群组。
群组创建成功后,会更新内存及数据库中的数据,多端多设备会收到相应的通知事件,然后将群组更新到内存及数据库中。
可通过设置 IMultiDeviceDelegate
监听相关事件,事件回调函数为 onGroupMultiDevicesEvent((MultiDevicesOperation, string, List<string>)
。
异步方法。
groupName | 群组名称。该参数可选,不设置传 null 。 |
options | 群组创建时需设置的选项。该参数可选,不可为 null 。详见 GroupOptions 。 群组的其他选项如下:
|
desc | 群组描述。该参数可选,不设置传 null 。 |
inviteMembers | 群成员列表。该参数不可为 null 。 |
inviteReason | 成员入群的邀请信息。该参数可选,不设置传 null 。 |
callback | 创建结果回调,详见 CallBack 。 |
void AgoraChat.GroupManager.DeclineGroupInvitation | ( | string | groupId, |
string | reason = null , |
||
CallBack | callback = null |
||
) |
void AgoraChat.GroupManager.DeclineGroupJoinApplication | ( | string | groupId, |
string | userId, | ||
string | reason = null , |
||
CallBack | callback = null |
||
) |
拒绝入群申请。
仅群组创建者和管理员可调用此方法。
异步方法。
groupId | 群组 ID。 |
userId | 申请人的用户 ID。 |
reason | 拒绝理由。 |
callback | 操作结果回调,详见 CallBack 。 |
void AgoraChat.GroupManager.DestroyGroup | ( | string | groupId, |
CallBack | callback = null |
||
) |
void AgoraChat.GroupManager.DownloadGroupSharedFile | ( | string | groupId, |
string | fileId, | ||
string | savePath, | ||
CallBack | callback = null |
||
) |
void AgoraChat.GroupManager.GetGroupAnnouncementFromServer | ( | string | groupId, |
ValueCallBack< string > | callback = null |
||
) |
void AgoraChat.GroupManager.GetGroupBlockListFromServer | ( | string | groupId, |
int | pageNum = 1 , |
||
int | pageSize = 200 , |
||
ValueCallBack< List< string > > | callback = null |
||
) |
以分页方式获取群组的黑名单。
仅群主和管理员可调用此方法。
异步方法。
groupId | 群组 ID。 |
pageNum | 当前页码,从 1 开始。 |
pageSize | 每页期望返回的黑名单成员数量。 |
callback | 操作结果回调,返回黑名单列表或错误信息,详见 ValueCallBack 。 |
void AgoraChat.GroupManager.GetGroupFileListFromServer | ( | string | groupId, |
int | pageNum = 1 , |
||
int | pageSize = 200 , |
||
ValueCallBack< List< GroupSharedFile > > | callback = null |
||
) |
从服务器获取群共享文件列表。
若数据量未知且很大,可分页获取,服务器会根据每次传入的 pageSize
和 pageNum
的值返回数据。
异步方法。
groupId | 群组 ID。 |
pageNum | 当前页码,从 1 开始。 |
pageSize | 每页期望返回的共享文件数。 查询最后一页时,返回的数量小于 pageSize 的值。 |
callback | 操作结果回调,成功返回共享文件列表,失败则返回错误信息,详见 ValueCallBack 。 |
void AgoraChat.GroupManager.GetGroupMemberListFromServer | ( | string | groupId, |
int | pageSize = 200 , |
||
string | cursor = "" , |
||
ValueCallBack< CursorResult< string > > | callback = null |
||
) |
从服务器获取群成员列表。
异步方法。
groupId | 群组 ID。 |
pageSize | 每页期望返回的群成员数。 |
cursor | 从该游标位置开始获取数据,首次获取数据时传 null 会从最新一条数据开始获取。 |
callback | 操作结果回调,成功返回成员列表及用于下次获取数据的cursor,失败返回错误信息,详见 ValueCallBack 。 |
void AgoraChat.GroupManager.GetGroupMuteListFromServer | ( | string | groupId, |
int | pageNum = 1 , |
||
int | pageSize = 200 , |
||
ValueCallBack< Dictionary< string, long > > | callback = null |
||
) |
获取群组的禁言列表。
仅群主和管理员可调用此方法。
异步方法。
groupId | 群组 ID。 |
pageNum | 当前页码,从 1 开始。 |
pageSize | 每页期望返回的禁言成员数。 |
callback | 操作结果回调,成功返回禁言列表,失败返回错误信息,详见 ValueCallBack 。 |
void AgoraChat.GroupManager.GetGroupSpecificationFromServer | ( | string | groupId, |
ValueCallBack< Group > | callback = null |
||
) |
void AgoraChat.GroupManager.GetGroupAllowListFromServer | ( | string | groupId, |
ValueCallBack< List< string > > | callback = null |
||
) |
获取群组白名单列表。
仅聊天室创建者和管理员可调用此方法。
异步方法。
groupId | 群组 ID。 |
callback | 操作结果回调,成功返回白名单列表,失败返回错误信息,详见 ValueCallBack 。 |
Group AgoraChat.GroupManager.GetGroupWithId | ( | string | groupId | ) |
根据群组 ID,从内存中获得群组对象。
groupId | 群组 ID。 |
null
。 List< Group > AgoraChat.GroupManager.GetJoinedGroups | ( | ) |
从本地内存和数据库获取加入的群组列表。
void AgoraChat.GroupManager.FetchJoinedGroupsFromServer | ( | int | pageNum = 0 , |
int | pageSize = 20 , |
||
bool | needAffiliations = false , |
||
bool | needRole = false , |
||
ValueCallBack< List< Group > > | callback = null |
||
) |
以分页方式从服务器获取当前用户加入的群组。
此操作只返回群组列表,不包含群组的所有成员信息。
异步方法,会阻塞当前线程。
pageNum | 当前页码,从 0 开始。 |
pageSize | 每页期望返回的群组数,取值范围为[1,20]。 |
needAffiliations | 是否获取成员数目。 |
needRole | 是否获取当前用户在群中的角色。 |
callback | 操作结果回调,成功群组列表,失败返回错误信息,详见 ValueCallBack 。 |
void AgoraChat.GroupManager.FetchJoinedGroupsFromServer | ( | int | pageNum = 0 , |
int | pageSize = 20 , |
||
ValueCallBack< List< Group > > | callback = null |
||
) |
以分页方式从服务器获取当前用户加入的群组。
此操作只返回群组列表,不包含群组的所有成员信息。
异步方法,会阻塞当前线程。
pageNum | 当前页码,从 0 开始。 |
pageSize | 每页期望返回的群组数,缺省为20。 |
callback | 操作结果回调,成功群组列表,失败返回错误信息,详见 ValueCallBack 。 |
void AgoraChat.GroupManager.FetchPublicGroupsFromServer | ( | int | pageSize = 200 , |
string | cursor = "" , |
||
ValueCallBack< CursorResult< GroupInfo > > | callback = null |
||
) |
以分页方式从服务器获取公开群组。
异步方法。
pageSize | 每页期望返回的公开群组数量。 |
cursor | 从该游标位置开始取数据,首次获取数据时传 null 从最新数据开始获取。 |
callback | 操作结果回调,成功返回获取的成员列表及用于下次获取数据的cursor,失败则返回错误信息,详见 ValueCallBack 。 |
void AgoraChat.GroupManager.JoinPublicGroup | ( | string | groupId, |
CallBack | callback = null |
||
) |
void AgoraChat.GroupManager.LeaveGroup | ( | string | groupId, |
CallBack | callback = null |
||
) |
void AgoraChat.GroupManager.MuteGroupAllMembers | ( | string | groupId, |
CallBack | callback = null |
||
) |
void AgoraChat.GroupManager.MuteGroupMembers | ( | string | groupId, |
List< string > | members, | ||
long | muteMilliseconds = -1 , |
||
CallBack | callback = null |
||
) |
将多个成员禁言。
仅群主和管理员可调用此方法。
异步方法。
groupId | 群组 ID。 |
members | 要禁言的用户列表。 |
muteMilliseconds | 禁言时长, -1 为永久禁言。 |
callback | 操作结果回调,详见 CallBack 。 |
void AgoraChat.GroupManager.RemoveGroupAdmin | ( | string | groupId, |
string | memberId, | ||
CallBack | callback = null |
||
) |
void AgoraChat.GroupManager.DeleteGroupSharedFile | ( | string | groupId, |
string | fileId, | ||
CallBack | callback = null |
||
) |
删除群组指定的共享文件。
群组成员可以删除自己上传的文件,群主或者群组管理员可以删除所有的共享文件。
异步方法。
groupId | 群组 ID。 |
fileId | 共享文件 ID。 |
callback | 操作结果回调,详见 CallBack 。 |
void AgoraChat.GroupManager.DeleteGroupMembers | ( | string | groupId, |
List< string > | members, | ||
CallBack | callback = null |
||
) |
void AgoraChat.GroupManager.RemoveGroupAllowList | ( | string | groupId, |
List< string > | members, | ||
CallBack | callback = null |
||
) |
将成员移除群组白名单。
仅群组创建者和管理员可调用此方法。
异步方法。
groupId | 群组 ID。 |
members | 需从白名单中移除的成员列表。 |
callback | 操作结果回调,详见 CallBack 。 |
void AgoraChat.GroupManager.UnBlockGroup | ( | string | groupId, |
CallBack | callback = null |
||
) |
void AgoraChat.GroupManager.UnBlockGroupMembers | ( | string | groupId, |
List< string > | members, | ||
CallBack | callback = null |
||
) |
void AgoraChat.GroupManager.UnMuteGroupAllMembers | ( | string | groupId, |
CallBack | callback = null |
||
) |
void AgoraChat.GroupManager.UnMuteGroupMembers | ( | string | groupId, |
List< string > | members, | ||
CallBack | callback = null |
||
) |
void AgoraChat.GroupManager.UpdateGroupAnnouncement | ( | string | groupId, |
string | announcement, | ||
CallBack | callback = null |
||
) |
void AgoraChat.GroupManager.UpdateGroupExt | ( | string | groupId, |
string | ext, | ||
CallBack | callback = null |
||
) |
void AgoraChat.GroupManager.UploadGroupSharedFile | ( | string | groupId, |
string | filePath, | ||
CallBack | callback = null |
||
) |
void AgoraChat.GroupManager.SetMemberAttributes | ( | string | groupId, |
string | userId, | ||
Dictionary< string, string > | attrs, | ||
CallBack | callback = null |
||
) |
void AgoraChat.GroupManager.FetchMemberAttributes | ( | string | groupId, |
List< string > | userIds, | ||
List< string > | attrs, | ||
ValueCallBack< Dictionary< string, Dictionary< string, string > > > | callback = null |
||
) |
根据指定的属性 key 获取多个群成员的自定义属性。
异步方法。
groupId | 群组 ID。 |
userIds | 要获取自定义属性的群成员的用户 ID 数组。最多可传 10 个用户 ID。 |
attrs | 要获取自定义属性的 key 的数组。若 keys 为空数组或不传则获取这些群成员的所有自定义属性。 |
callback | 操作结果回调,详见 ValueCallBack 。 |
void AgoraChat.GroupManager.FetchMyGroupsCount | ( | ValueCallBack< int > | callback = null | ) |
void AgoraChat.GroupManager.AddGroupManagerDelegate | ( | IGroupManagerDelegate | groupManagerDelegate | ) |
注册群组管理器的监听器。
groupManagerDelegate | 要注册的群组管理器的监听器,继承自 IGroupManagerDelegate 。 |
void AgoraChat.GroupManager.RemoveGroupManagerDelegate | ( | IGroupManagerDelegate | groupManagerDelegate | ) |
移除群组管理器的监听器。
groupManagerDelegate | 要移除的群组管理器的监听器,继承自 IGroupManagerDelegate 。 |