AgoraChat.Group Class Reference

Inheritance diagram for AgoraChat.Group:

Properties
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]

Property Documentation

GroupId

string AgoraChat.Group.GroupId

getset

The group ID.

Name

string AgoraChat.Group.Name

getset

The group name.

Description

string AgoraChat.Group.Description

getset

The group description.

Owner

string AgoraChat.Group.Owner

getset

The group owner.

Announcement

string AgoraChat.Group.Announcement

getset

The group announcement.

To get the group announcement from the server, you can call IGroupManager#GetGroupAnnouncementFromServer(String, ValueCallBack).

MemberCount

int AgoraChat.Group.MemberCount

getset

The number of members in the group.

MemberList

List<string> AgoraChat.Group.MemberList

getset

The member list of the group.

AdminList

List<string> AgoraChat.Group.AdminList

getset

The admin list of the group.

To get the admin list of the group from the server, you can call IGroupManager#GetGroupSpecificationFromServer(String, ValueCallBack) to get group details.

BlockList

List<string> AgoraChat.Group.BlockList

getset

Gets the block list of the group.

To get the block list of the group from the server, you can call IGroupManager#GetGroupBlockListFromServer(String, int, int, ValueCallBack).

MuteList

List<string> AgoraChat.Group.MuteList

getset

Gets the mute list of the group.

To get the mute list of the group from the server, you can call IGroupManager#GetGroupMuteListFromServer(String, int, int, ValueCallBack).

NoticeEnabled

bool AgoraChat.Group.NoticeEnabled

getset

Whether push notifications are enabled.

• true: Yes.
• false: No.

MessageBlocked

bool AgoraChat.Group.MessageBlocked

getset

Whether group messages are blocked.

• true: Yes.
• false: No.

To block group messages, you can call IGroupManager#BlockGroup(String，CallBack.

To unblock group messages, you can call IGroupManager#UnBlockGroup(String, CallBack).

IsAllMemberMuted

bool AgoraChat.Group.IsAllMemberMuted

getset

Whether all members are muted.

• true: Yes.
• false: No.

The mute state of the in-memory object is updated when the mute callback OnMuteListAddedFromGroup or unmuting callback OnMuteListRemovedFromGroup is received.

After the in-memory object is collected and pulled again from the database or server, the state becomes untrustworthy.

PermissionType

GroupPermissionType AgoraChat.Group.PermissionType

getset

The role of the current user in the group.

IsMemberOnly

bool AgoraChat.Group.IsMemberOnly

getset

Whether users can join a group only via a join request or a group invitation:

• true: Yes.
• false: No. Users can join a group freely, without a join request or a group invitation.

When GroupStyle is set to PrivateOnlyOwnerInvite, PrivateMemberCanInvite, or PublicJoinNeedApproval, the attribute value is true.

IsMemberAllowToInvite

bool AgoraChat.Group.IsMemberAllowToInvite

getset

Whether other group members than the group owner and admins can invite users to join the group:

• true: Yes. All group members can invite other users to join the group.
• false: No. Only the group owner and admins can invite other users to join the group.

MaxUserCount

int AgoraChat.Group.MaxUserCount

getset

The maximum number of members allowed in a group.

The attribute is set during group creation.

To get the correct attribute value, you need to first get the details of the group from the server by calling IGroupManager#GetGroupSpecificationFromServer(String, ValueCallBack). Otherwise, the SDK returns 0.

IsDisabled

bool AgoraChat.Group.IsDisabled

getset

Whether the group is disabled:

• true: Yes. The group is disabled. Group members cannot send or receive messages, nor perform group and member management operations. This is also the case for threads in this group.
• false: No. The group is in the normal state. Group members can send and receive messages, as well as perform group and member management operations. This is also the case for threads in this group.

This attribute is not stored in the local database.

For groups loaded from the local database, the default value of this attribute is NO.

Ext

string AgoraChat.Group.Ext

getset

Gets the custom extension information of the group.

Returns

The custom extension information of the group.