Unity and Windows API reference
Public 成员函数 | 所有成员列表
ChatSDK.IGroupManager类 参考abstract

Public 成员函数

abstract void applyJoinToGroup (string groupId, string reason="", CallBack handle=null)
 
abstract void AcceptGroupInvitation (string groupId, ValueCallBack< Group > handle=null)
 
abstract void AcceptGroupJoinApplication (string groupId, string username, CallBack handle=null)
 
abstract void AddGroupAdmin (string groupId, string memberId, CallBack handle=null)
 
abstract void AddGroupMembers (string groupId, List< string > members, CallBack handle=null)
 
abstract void AddGroupWhiteList (string groupId, List< string > members, CallBack handle=null)
 
abstract void BlockGroup (string groupId, CallBack handle=null)
 
abstract void BlockGroupMembers (string groupId, List< string > members, CallBack handle=null)
 
abstract void ChangeGroupDescription (string groupId, string desc, CallBack handle=null)
 
abstract void ChangeGroupName (string groupId, string name, CallBack handle=null)
 
abstract void ChangeGroupOwner (string groupId, string newOwner, CallBack handle=null)
 
abstract void CheckIfInGroupWhiteList (string groupId, ValueCallBack< bool > handle=null)
 
abstract void CreateGroup (string groupName, GroupOptions options, string desc=null, List< string > inviteMembers=null, string inviteReason=null, ValueCallBack< Group > handle=null)
 
abstract void DeclineGroupInvitation (string groupId, string reason=null, CallBack handle=null)
 
abstract void DeclineGroupJoinApplication (string groupId, string username, string reason=null, CallBack handle=null)
 
abstract void DestroyGroup (string groupId, CallBack handle=null)
 
abstract void DownloadGroupSharedFile (string groupId, string fileId, string savePath, CallBack handle=null)
 
abstract void GetGroupAnnouncementFromServer (string groupId, ValueCallBack< string > handle=null)
 
abstract void GetGroupBlockListFromServer (string groupId, int pageNum=1, int pageSize=200, ValueCallBack< List< string > > handle=null)
 
abstract void GetGroupFileListFromServer (string groupId, int pageNum=1, int pageSize=200, ValueCallBack< List< GroupSharedFile > > handle=null)
 
abstract void GetGroupMemberListFromServer (string groupId, int pageSize=200, string cursor="", ValueCallBack< CursorResult< string > > handle=null)
 
abstract void GetGroupMuteListFromServer (string groupId, int pageNum=1, int pageSize=200, ValueCallBack< List< string > > handle=null)
 
abstract void GetGroupSpecificationFromServer (string groupId, ValueCallBack< Group > handle=null)
 
abstract void GetGroupWhiteListFromServer (string groupId, ValueCallBack< List< string > > handle=null)
 
abstract Group GetGroupWithId (string groupId)
 
abstract List< GroupGetJoinedGroups ()
 
abstract void FetchJoinedGroupsFromServer (int pageNum=1, int pageSize=200, ValueCallBack< List< Group > > handle=null)
 
abstract void FetchPublicGroupsFromServer (int pageSize=200, string cursor="", ValueCallBack< CursorResult< GroupInfo > > handle=null)
 
abstract void JoinPublicGroup (string groupId, CallBack handle=null)
 
abstract void LeaveGroup (string groupId, CallBack handle=null)
 
abstract void MuteGroupAllMembers (string groupId, CallBack handle=null)
 
abstract void MuteGroupMembers (string groupId, List< string > members, CallBack handle=null)
 
abstract void RemoveGroupAdmin (string groupId, string memberId, CallBack handle=null)
 
abstract void DeleteGroupSharedFile (string groupId, string fileId, CallBack handle=null)
 
abstract void DeleteGroupMembers (string groupId, List< string > members, CallBack handle=null)
 
abstract void RemoveGroupWhiteList (string groupId, List< string > members, CallBack handle=null)
 
abstract void UnBlockGroup (string groupId, CallBack handle=null)
 
abstract void UnBlockGroupMembers (string groupId, List< string > members, CallBack handle=null)
 
abstract void UnMuteGroupAllMembers (string groupId, CallBack handle=null)
 
abstract void UnMuteGroupMembers (string groupId, List< string > members, CallBack handle=null)
 
abstract void UpdateGroupAnnouncement (string groupId, string announcement, CallBack handle=null)
 
abstract void UpdateGroupExt (string groupId, string ext, CallBack handle=null)
 
abstract void UploadGroupSharedFile (string groupId, string filePath, CallBack handle=null)
 
void AddGroupManagerDelegate (IGroupManagerDelegate groupManagerDelegate)
 
void RemoveGroupManagerDelegate (IGroupManagerDelegate groupManagerDelegate)
 

详细描述

群组管理器抽象类。

成员函数说明

◆ applyJoinToGroup()

abstract void ChatSDK.IGroupManager.applyJoinToGroup ( string  groupId,
string  reason = "",
CallBack  handle = null 
)
pure virtual

申请加入群组。

异步方法。

参数
groupId群组 ID。
reason申请加入的原因。
handle申请结果回调,详见 CallBack

◆ AcceptGroupInvitation()

abstract void ChatSDK.IGroupManager.AcceptGroupInvitation ( string  groupId,
ValueCallBack< Group handle = null 
)
pure virtual

接受入群邀请。

异步方法。

参数
groupId群组 ID。
handle接受结果回调,返回用户同意邀请的群组,详见 ValueCallBack

◆ AcceptGroupJoinApplication()

abstract void ChatSDK.IGroupManager.AcceptGroupJoinApplication ( string  groupId,
string  username,
CallBack  handle = null 
)
pure virtual

批准入群申请。

仅群主和管理员可调用此方法。

异步方法。

参数
groupId群组 ID。
username申请人 ID。
handle批准结果回调,详见 CallBack

◆ AddGroupAdmin()

abstract void ChatSDK.IGroupManager.AddGroupAdmin ( string  groupId,
string  memberId,
CallBack  handle = null 
)
pure virtual

添加群组管理员。

仅群主可调用此方法,admin 无权限。

异步方法。

参数
groupId群组 ID。
memberId新增加的管理员 ID。
handle添加结果回调,详见 CallBack

◆ AddGroupMembers()

abstract void ChatSDK.IGroupManager.AddGroupMembers ( string  groupId,
List< string >  members,
CallBack  handle = null 
)
pure virtual

向群组中添加新成员。

仅群主和管理员可调用此方法。

异步方法。

参数
groupId群组的 ID。
members要添加的新成员列表。
handle添加结果回调,详见 CallBack

◆ AddGroupWhiteList()

abstract void ChatSDK.IGroupManager.AddGroupWhiteList ( string  groupId,
List< string >  members,
CallBack  handle = null 
)
pure virtual

添加白名单。

仅群主和管理员可调用此方法。

异步方法。

参数
groupId群组 ID。
members要添加的成员列表。
handle添加结果回调,详见 CallBack

◆ BlockGroup()

abstract void ChatSDK.IGroupManager.BlockGroup ( string  groupId,
CallBack  handle = null 
)
pure virtual

屏蔽群消息。

屏蔽群消息的用户仍是群成员,但无法接收群消息。

异步方法。

参数
groupId群组 ID。
handle屏蔽结果回调,详见 CallBack

◆ BlockGroupMembers()

abstract void ChatSDK.IGroupManager.BlockGroupMembers ( string  groupId,
List< string >  members,
CallBack  handle = null 
)
pure virtual

将用户加入群组黑名单。

成功调用该方法后,该用户会先被移除出群组,然后加入群组黑名单。该用户无法接收、发送群消息,也无法申请再次加入群组。

仅群主和管理员可调用此方法。

异步方法。

参数
groupId群组ID。
members要加入黑名单的用户列表。
handle操作结果回调,详见 CallBack

◆ ChangeGroupDescription()

abstract void ChatSDK.IGroupManager.ChangeGroupDescription ( string  groupId,
string  desc,
CallBack  handle = null 
)
pure virtual

修改群描述。

仅群主和管理员可调用此方法。

异步方法。

参数
groupId群组 ID。
desc修改后的群描述。
handle操作结果回调,详见 CallBack

◆ ChangeGroupName()

abstract void ChatSDK.IGroupManager.ChangeGroupName ( string  groupId,
string  name,
CallBack  handle = null 
)
pure virtual

修改群组名称。

仅群主和管理员可调用此方法。

异步方法。

参数
groupId需修改名称的群组的 ID。
name修改后的群组名称。
handle操作结果回调,详见 CallBack

◆ ChangeGroupOwner()

abstract void ChatSDK.IGroupManager.ChangeGroupOwner ( string  groupId,
string  newOwner,
CallBack  handle = null 
)
pure virtual

转让群组所有权。

仅群主可调用此方法。

异步方法。

参数
groupId群组 ID。
newOwner新的群主。
handle操作结果回调,详见 CallBack

◆ CheckIfInGroupWhiteList()

abstract void ChatSDK.IGroupManager.CheckIfInGroupWhiteList ( string  groupId,
ValueCallBack< bool >  handle = null 
)
pure virtual

检查当前用户是否在群组白名单中。

异步方法。

参数
groupId群组 ID。
handle操作结果回调,详见 CallBack

◆ CreateGroup()

abstract void ChatSDK.IGroupManager.CreateGroup ( string  groupName,
GroupOptions  options,
string  desc = null,
List< string >  inviteMembers = null,
string  inviteReason = null,
ValueCallBack< Group handle = null 
)
pure virtual

创建群组。

群组创建成功后,会更新内存及数据库中的数据,多端多设备会收到相应的通知事件,然后将群组更新到内存及数据库中。

可通过设置 IMultiDeviceDelegate 监听相关事件,事件回调函数为 onGroupMultiDevicesEvent((MultiDevicesOperation, string, List<string>)

异步方法。

参数
groupName群组名称。该参数可选,不设置传 null
options群组创建时需设置的选项。该参数可选,不可为 null。详见 GroupOptions。 群组的其他选项如下:
  • 群组最大成员数,默认值为 200;
  • 群组类型,详见 GroupStyle
  • 邀请入群是否需要对方同意,默认为 false,即邀请后直接入群;
  • 群详情扩展。
desc群组描述。该参数可选,不设置传 null
inviteMembers群成员列表。该参数不可为 null
inviteReason成员入群的邀请信息。该参数可选,不设置传 null
handle创建结果回调,详见 CallBack

◆ DeclineGroupInvitation()

abstract void ChatSDK.IGroupManager.DeclineGroupInvitation ( string  groupId,
string  reason = null,
CallBack  handle = null 
)
pure virtual

拒绝入群邀请。

异步方法。

参数
groupId群组 ID。
reason拒绝理由。
handle操作结果回调,详见 CallBack

◆ DeclineGroupJoinApplication()

abstract void ChatSDK.IGroupManager.DeclineGroupJoinApplication ( string  groupId,
string  username,
string  reason = null,
CallBack  handle = null 
)
pure virtual

拒绝入群申请。

仅群组创建者和管理员可调用此方法。

异步方法。

参数
groupId群组 ID。
username申请人的用户 ID。
reason拒绝理由。
handle操作结果回调,详见 CallBack

◆ DestroyGroup()

abstract void ChatSDK.IGroupManager.DestroyGroup ( string  groupId,
CallBack  handle = null 
)
pure virtual

解散群组。

仅群主可调用此方法。

异步方法。

参数
groupId群组 ID。
handle操作结果回调,详见 CallBack

◆ DownloadGroupSharedFile()

abstract void ChatSDK.IGroupManager.DownloadGroupSharedFile ( string  groupId,
string  fileId,
string  savePath,
CallBack  handle = null 
)
pure virtual

下载群组中指定的共享文件。

异步方法。

参数
groupId群组 ID。
fileId共享文件 ID。
savePath文件保存路径。
handle操作结果回调,详见 CallBack

◆ GetGroupAnnouncementFromServer()

abstract void ChatSDK.IGroupManager.GetGroupAnnouncementFromServer ( string  groupId,
ValueCallBack< string >  handle = null 
)
pure virtual

从服务器获取群公告。

群成员可调用此方法。

异步方法。

参数
groupId群组 ID。
handle操作结果回调,详见 ValueCallBack

◆ GetGroupBlockListFromServer()

abstract void ChatSDK.IGroupManager.GetGroupBlockListFromServer ( string  groupId,
int  pageNum = 1,
int  pageSize = 200,
ValueCallBack< List< string > >  handle = null 
)
pure virtual

以分页方式获取群组的黑名单。

仅群主和管理员可调用此方法。

异步方法。

参数
groupId群组 ID。
pageNum当前页码,从 1 开始。
pageSize每页期望返回的黑名单成员数量。
handle操作结果回调,返回黑名单列表或错误信息,详见 ValueCallBack

◆ GetGroupFileListFromServer()

abstract void ChatSDK.IGroupManager.GetGroupFileListFromServer ( string  groupId,
int  pageNum = 1,
int  pageSize = 200,
ValueCallBack< List< GroupSharedFile > >  handle = null 
)
pure virtual

从服务器获取群共享文件列表。

若数据量未知且很大,可分页获取,服务器会根据每次传入的 pageSizepageNum 的值返回数据。

异步方法。

参数
groupId群组 ID。
pageNum当前页码,从 1 开始。
pageSize每页期望返回的共享文件数。 查询最后一页时,返回的数量小于 pageSize 的值。
handle操作结果回调,成功返回共享文件列表,失败则返回错误信息,详见 ValueCallBack

◆ GetGroupMemberListFromServer()

abstract void ChatSDK.IGroupManager.GetGroupMemberListFromServer ( string  groupId,
int  pageSize = 200,
string  cursor = "",
ValueCallBack< CursorResult< string > >  handle = null 
)
pure virtual

从服务器获取群成员列表。

异步方法。

参数
groupId群组 ID。
pageSize每页期望返回的群成员数。
cursor从该游标位置开始获取数据,首次获取数据时传 null 会从最新一条数据开始获取。
handle操作结果回调,成功返回成员列表及用于下次获取数据的cursor,失败返回错误信息,详见 ValueCallBack

◆ GetGroupMuteListFromServer()

abstract void ChatSDK.IGroupManager.GetGroupMuteListFromServer ( string  groupId,
int  pageNum = 1,
int  pageSize = 200,
ValueCallBack< List< string > >  handle = null 
)
pure virtual

获取群组的禁言列表。

仅群主和管理员可调用此方法。

异步方法。

参数
groupId群组 ID。
pageNum当前页码,从 1 开始。
pageSize每页期望返回的禁言成员数。
handle操作结果回调,成功返回禁言列表,失败返回错误信息,详见 ValueCallBack

◆ GetGroupSpecificationFromServer()

abstract void ChatSDK.IGroupManager.GetGroupSpecificationFromServer ( string  groupId,
ValueCallBack< Group handle = null 
)
pure virtual

获取群详情。

异步方法。

参数
groupId群组 ID。
handle操作结果回调,成功返群组实例,失败返回错误信息,详见 ValueCallBack

◆ GetGroupWhiteListFromServer()

abstract void ChatSDK.IGroupManager.GetGroupWhiteListFromServer ( string  groupId,
ValueCallBack< List< string > >  handle = null 
)
pure virtual

获取群组白名单列表。

仅聊天室创建者和管理员可调用此方法。

异步方法。

参数
groupId群组 ID。
handle操作结果回调,成功返回白名单列表,失败返回错误信息,详见 ValueCallBack

◆ GetGroupWithId()

abstract Group ChatSDK.IGroupManager.GetGroupWithId ( string  groupId)
pure virtual

根据群组 ID,从内存中获得群组对象。

参数
groupId群组 ID。
返回
返回群组对象。如果群组不存在,返回 null

◆ GetJoinedGroups()

abstract List< Group > ChatSDK.IGroupManager.GetJoinedGroups ( )
pure virtual

从本地内存和数据库获取加入的群组列表。

异步方法。

返回
返回群组列表。

◆ FetchJoinedGroupsFromServer()

abstract void ChatSDK.IGroupManager.FetchJoinedGroupsFromServer ( int  pageNum = 1,
int  pageSize = 200,
ValueCallBack< List< Group > >  handle = null 
)
pure virtual

以分页方式从服务器获取当前用户加入的群组。

此操作只返回群组列表,不包含群组的所有成员信息。

异步方法,会阻塞当前线程。

参数
pageNum当前页码,从 1 开始。
pageSize每页期望返回的群组数。
handle操作结果回调,成功群组列表,失败返回错误信息,详见 ValueCallBack

◆ FetchPublicGroupsFromServer()

abstract void ChatSDK.IGroupManager.FetchPublicGroupsFromServer ( int  pageSize = 200,
string  cursor = "",
ValueCallBack< CursorResult< GroupInfo > >  handle = null 
)
pure virtual

以分页方式从服务器获取公开群组。

异步方法。

参数
pageSize每页期望返回的公开群组数量。
cursor从该游标位置开始取数据,首次获取数据时传 null 从最新数据开始获取。
handle操作结果回调,成功返回获取的成员列表及用于下次获取数据的cursor,失败则返回错误信息,详见 ValueCallBack

◆ JoinPublicGroup()

abstract void ChatSDK.IGroupManager.JoinPublicGroup ( string  groupId,
CallBack  handle = null 
)
pure virtual

加入公开群组。

异步方法。

参数
groupId公开群组 ID。
handle操作结果回调,详见 CallBack

◆ LeaveGroup()

abstract void ChatSDK.IGroupManager.LeaveGroup ( string  groupId,
CallBack  handle = null 
)
pure virtual

当前登录用户退出群组。

异步方法。

参数
groupId群组 ID。
handle操作结果回调,详见 CallBack

◆ MuteGroupAllMembers()

abstract void ChatSDK.IGroupManager.MuteGroupAllMembers ( string  groupId,
CallBack  handle = null 
)
pure virtual

对群组成员全部禁言。

仅群主和管理员可调用此方法。

异步方法。

参数
groupId群组 ID。
handle操作结果回调,详见 CallBack

◆ MuteGroupMembers()

abstract void ChatSDK.IGroupManager.MuteGroupMembers ( string  groupId,
List< string >  members,
CallBack  handle = null 
)
pure virtual

将多个成员禁言。

仅群主和管理员可调用此方法。

异步方法。

参数
groupId群组 ID。
members要禁言的用户列表。
handle操作结果回调,详见 CallBack

◆ RemoveGroupAdmin()

abstract void ChatSDK.IGroupManager.RemoveGroupAdmin ( string  groupId,
string  memberId,
CallBack  handle = null 
)
pure virtual

删除群组管理员。

仅群主可调用此方法。

异步方法。

参数
groupId群组 ID。
memberId删除的管理员 ID。
handle操作结果回调,详见 CallBack

◆ DeleteGroupSharedFile()

abstract void ChatSDK.IGroupManager.DeleteGroupSharedFile ( string  groupId,
string  fileId,
CallBack  handle = null 
)
pure virtual

删除群组指定的共享文件。

群组成员可以删除自己上传的文件,群主或者群组管理员可以删除所有的共享文件。

异步方法。

参数
groupId群组 ID。
fileId共享文件 ID。
handle操作结果回调,详见 CallBack

◆ DeleteGroupMembers()

abstract void ChatSDK.IGroupManager.DeleteGroupMembers ( string  groupId,
List< string >  members,
CallBack  handle = null 
)
pure virtual

从群组中删除成员。

仅群主和管理员可调用此方法。

异步方法。

参数
groupId群组 ID。
members要删除的成员。
handle操作结果回调,详见 CallBack

◆ RemoveGroupWhiteList()

abstract void ChatSDK.IGroupManager.RemoveGroupWhiteList ( string  groupId,
List< string >  members,
CallBack  handle = null 
)
pure virtual

将成员移除群组白名单。

仅群组创建者和管理员可调用此方法。

异步方法。

参数
groupId群组 ID。
members需从白名单中移除的成员列表。
handle操作结果回调,详见 CallBack

◆ UnBlockGroup()

abstract void ChatSDK.IGroupManager.UnBlockGroup ( string  groupId,
CallBack  handle = null 
)
pure virtual

取消屏蔽群消息。

异步方法。

参数
groupId群组 ID。
handle操作结果回调,详见 CallBack

◆ UnBlockGroupMembers()

abstract void ChatSDK.IGroupManager.UnBlockGroupMembers ( string  groupId,
List< string >  members,
CallBack  handle = null 
)
pure virtual

将用户移除群组黑名单。

仅群主和管理员可调用此方法。

异步方法。

参数
groupId群组 ID。
members要从黑名单中移除的用户列表。
handle操作结果回调,详见 CallBack

◆ UnMuteGroupAllMembers()

abstract void ChatSDK.IGroupManager.UnMuteGroupAllMembers ( string  groupId,
CallBack  handle = null 
)
pure virtual

解除全员禁言。

仅群主和管理员可调用此方法。

异步方法。

参数
groupId群组 ID。
handle操作结果回调,详见 CallBack

◆ UnMuteGroupMembers()

abstract void ChatSDK.IGroupManager.UnMuteGroupMembers ( string  groupId,
List< string >  members,
CallBack  handle = null 
)
pure virtual

解除禁言。

仅群主和管理员可调用此方法。

异步方法。

参数
groupId群组 ID。
members要解除禁言的用户列表。
handle操作结果回调,详见 CallBack

◆ UpdateGroupAnnouncement()

abstract void ChatSDK.IGroupManager.UpdateGroupAnnouncement ( string  groupId,
string  announcement,
CallBack  handle = null 
)
pure virtual

更新群公告。

仅群主和管理员可调用此方法。

异步方法。

参数
groupId群组 ID。
announcement公告内容。
handle操作结果回调,详见 CallBack

◆ UpdateGroupExt()

abstract void ChatSDK.IGroupManager.UpdateGroupExt ( string  groupId,
string  ext,
CallBack  handle = null 
)
pure virtual

更新群组扩展字段。

仅群主和管理员可调用此方法。

异步方法。

参数
groupId群组 ID。
ext群组扩展字段。
handle操作结果回调,详见 CallBack

◆ UploadGroupSharedFile()

abstract void ChatSDK.IGroupManager.UploadGroupSharedFile ( string  groupId,
string  filePath,
CallBack  handle = null 
)
pure virtual

上传共享文件至群组。

异步方法。

参数
groupId群组 ID。
filePath共享文件的本地路径。
handle操作结果回调,详见 CallBack

◆ AddGroupManagerDelegate()

void ChatSDK.IGroupManager.AddGroupManagerDelegate ( IGroupManagerDelegate  groupManagerDelegate)

注册群组管理器的监听器。

参数
groupManagerDelegate要注册的群组管理器的监听器,继承自 IGroupManagerDelegate

◆ RemoveGroupManagerDelegate()

void ChatSDK.IGroupManager.RemoveGroupManagerDelegate ( IGroupManagerDelegate  groupManagerDelegate)

移除群组管理器的监听器。

参数
groupManagerDelegate要移除的群组管理器的监听器,继承自 IGroupManagerDelegate