Chat SDK for Unity and Windows v1.2.0
属性 | 所有成员列表
AgoraChat.Group类 参考
类 AgoraChat.Group 继承关系图:

属性

string GroupId [get, set]
 
string Name [get, set]
 
string Description [get, set]
 
string Owner [get, set]
 
string Announcement [get, set]
 
int MemberCount [get, set]
 
List< string > MemberList [get, set]
 
List< string > AdminList [get, set]
 
List< string > BlockList [get, set]
 
List< string > MuteList [get, set]
 
bool NoticeEnabled [get, set]
 
bool MessageBlocked [get, set]
 
bool IsAllMemberMuted [get, set]
 
GroupPermissionType PermissionType [get, set]
 
bool IsMemberOnly [get, set]
 
bool IsMemberAllowToInvite [get, set]
 
int MaxUserCount [get, set]
 
bool IsDisabled [get, set]
 
string Ext [get, set]
 

属性说明

◆ GroupId

string AgoraChat.Group.GroupId
getset

群组 ID。

◆ Name

string AgoraChat.Group.Name
getset

群组名称。

◆ Description

string AgoraChat.Group.Description
getset

群组描述。

◆ Owner

string AgoraChat.Group.Owner
getset

群主信息。

◆ Announcement

string AgoraChat.Group.Announcement
getset

群组公告。

从服务端获取群组公告,可调用 IGroupManager#GetGroupAnnouncementFromServer(String, ValueCallBack)

◆ MemberCount

int AgoraChat.Group.MemberCount
getset

群组成员数量。

◆ MemberList

List<string> AgoraChat.Group.MemberList
getset

群组成员列表。

◆ AdminList

List<string> AgoraChat.Group.AdminList
getset

群组管理员列表。

若要获取服务器端的群组管理员列表,可调用 IGroupManager#GetGroupSpecificationFromServer(String, ValueCallBack) 获取群组详情。

◆ BlockList

List<string> AgoraChat.Group.BlockList
getset

群组黑名单。

若要获取服务器端的群组黑名单列表,可调用 IGroupManager#GetGroupBlockListFromServer(String, int, int, ValueCallBack)

◆ MuteList

List<string> AgoraChat.Group.MuteList
getset

群组禁言列表。

若要获取服务器端的群组禁言列表,可调用 IGroupManager#GetGroupMuteListFromServer(String, int, int, ValueCallBack)

◆ NoticeEnabled

bool AgoraChat.Group.NoticeEnabled
getset

是否开启了推送通知。

  • true:是;
  • false:否。

◆ MessageBlocked

bool AgoraChat.Group.MessageBlocked
getset

是否已屏蔽群消息。

  • true:是;
  • false:否。

开启屏蔽群消息,请参见 IGroupManager#BlockGroup(String,CallBack

取消屏蔽群消息,请参见 IGroupManager#UnBlockGroup(String, CallBack)

◆ IsAllMemberMuted

bool AgoraChat.Group.IsAllMemberMuted
getset

是否全员禁言。

  • true:是;
  • false:否。

在收到禁言回调 OnMuteListAddedFromGroup 或解禁回调 OnMuteListRemovedFromGroup 时,内存中对象的禁言状态会更新。

内存中对象被回收后以及再次从数据库或者服务端拉取后,该状态不可信。

◆ PermissionType

GroupPermissionType AgoraChat.Group.PermissionType
getset

当前用户在群组中的角色。

◆ IsMemberOnly

bool AgoraChat.Group.IsMemberOnly
getset

用户是否只能通过群成员邀请或申请才能加入群组:

  • true:是。
  • false:否。用户可自由加入群组,无需群成员邀请或提交入群申请。

群组类型(GroupStyle)设置为 PrivateOnlyOwnerInvite, PrivateMemberCanInvitePublicJoinNeedApproval 时,该属性的值为 true

◆ IsMemberAllowToInvite

bool AgoraChat.Group.IsMemberAllowToInvite
getset

群组是否允许除群主和管理员之外的成员邀请用户入群:

  • true:允许。所有群成员均可邀请其他用户加入群组。
  • false:不允许。只有群主和群管理员可邀请其他用户加入群组。

◆ MaxUserCount

int AgoraChat.Group.MaxUserCount
getset

群组允许加入的最大成员数。

该属性在创建群时确定。

需要获取群详情才能得到正确的结果,如果没有获取则返回 0

◆ IsDisabled

bool AgoraChat.Group.IsDisabled
getset

群组是否禁用:

  • true:该群组被禁用。群组成员无法收发消息,也不能进行群组和群成员的任何管理操作。而且,该群组的子区中也无法收发消息,也不能进行子区和成员的任何管理操作。
  • false:该群组为正常状态。群组成员可以正常收发消息,进行群组和群成员的管理操作。而且,该群组的子区也能发送和接收消息,进行子区和成员的管理操作。

本地数据库不存储该状态。对于从数据库加载的群组,该属性的默认值为 NO

◆ Ext

string AgoraChat.Group.Ext
getset

群组的自定义扩展信息。

返回
群组自定义扩展信息。