agora_chat_SDK  3.8.2
agorajavachatSDK
Classes | Public Member Functions | List of all members
io.agora.chat.Group Class Reference

Inherits io.agora.chat.EMBase< T >.

Classes

enum  GroupPermissionType
 

Public Member Functions

 Group (EMAGroup group)
 
String getGroupId ()
 
String getGroupName ()
 
String getDescription ()
 
boolean isPublic ()
 
boolean isAllowInvites ()
 
boolean isMemberAllowToInvite ()
 
boolean isMembersOnly ()
 
boolean isMemberOnly ()
 
int getMaxUserCount ()
 
boolean isMsgBlocked ()
 
String getOwner ()
 
String groupSubject ()
 
List< String > getMembers ()
 
int getMemberCount ()
 
String toString ()
 
List< String > getAdminList ()
 
List< String > getBlackList ()
 
List< String > getMuteList ()
 
List< String > getWhiteList ()
 
boolean isAllMemberMuted ()
 
String getExtension ()
 
String getAnnouncement ()
 
List< MucSharedFilegetShareFileList ()
 
GroupPermissionType getGroupPermissionType ()
 

Detailed Description

Group

Member Function Documentation

List<String> io.agora.chat.Group.getAdminList ( )

Get group admin list If not fetch the group's detail specification from server, the result may be empty Get Group detail, see GroupManager#getGroupFromServer(String)

Returns
List<String>
String io.agora.chat.Group.getAnnouncement ( )

Get group announcement If not get announcement from server, the return may be empty Get group announcement, can call the method of GroupManager#fetchGroupAnnouncement(String), also can call its asynchronous method of GroupManager#asyncFetchGroupAnnouncement(String, ValueCallBack)

Returns
String
List<String> io.agora.chat.Group.getBlackList ( )

Get blacklist If not get blacklist from server, the return may be empty Fetch blacklist can call GroupManager#fetchGroupBlackList(String, int, int), call this method need owner or admin authority, also can call it's asynchronous method GroupManager#asyncFetchGroupBlackList(String, int, int, ValueCallBack)

Returns
blacklist
String io.agora.chat.Group.getDescription ( )

Get group description

Returns
String
String io.agora.chat.Group.getExtension ( )

Get group customized extension

Returns
String
String io.agora.chat.Group.getGroupId ( )

Get group id

Returns
Group id
String io.agora.chat.Group.getGroupName ( )

Get group name

Returns
String
GroupPermissionType io.agora.chat.Group.getGroupPermissionType ( )

Get the current user's role in group

Returns
GroupPermissionType
int io.agora.chat.Group.getMaxUserCount ( )

Max group members capability It depends on group detail, if not fetch group detail, return 0

Returns
int io.agora.chat.Group.getMemberCount ( )

Get the member count

Returns
int
List<String> io.agora.chat.Group.getMembers ( )

Get the member list If not get members from server, the return may be empty You can get members in the flowing ways: (1) When member's number is less than 200, can use GroupManager#getGroupFromServer(String, boolean) to fetch, the second parameter pass in true, can get up to 200 members (2) Use the method of GroupManager#fetchGroupMembers(String, String, int) to get by page, also can use its asynchronous method of GroupManager#asyncFetchGroupMembers(String, String, int, ValueCallBack) to get

Returns
The list of member IDs
List<String> io.agora.chat.Group.getMuteList ( )

Get group mute list If not get mute list from server, the return may be empty Fetch mute list can call GroupManager#fetchGroupMuteList(String, int, int), call this method need owner or admin authority, also can call it's asynchronous method GroupManager#asyncFetchGroupMuteList(String, int, int, ValueCallBack)

Returns
Group mute list
String io.agora.chat.Group.getOwner ( )

Get the owner

Returns
String Group owner id
List<MucSharedFile> io.agora.chat.Group.getShareFileList ( )

Get group shared file list If not get shared file list from server, the return may be empty Fetch shared file list can call GroupManager#fetchGroupSharedFileList(String, int, int), GroupManager#asyncFetchGroupSharedFileList(String, int, int, ValueCallBack)

Returns
Group shared file list
List<String> io.agora.chat.Group.getWhiteList ( )

Get white list If not get whitelist from server, the return may be empty Fetch whitelist can call GroupManager#fetchGroupWhiteList(String, ValueCallBack), call this method need owner or admin authority

Returns
Group whitelist
String io.agora.chat.Group.groupSubject ( )

Subject of the group, need to get group detail

Returns
String
boolean io.agora.chat.Group.isAllMemberMuted ( )

Return if all member muted This method has limitations and is recommended to be used with caution The state is updated when a all-muted/all-unmuted callback is received, but only for the in-memory object. After the in-memory object is collected and pulled again from the database or server, the state becomes untrusted

Returns
boolean
boolean io.agora.chat.Group.isAllowInvites ( )

Get if the group member is allow invite the others

Returns
boolean
Deprecated:
Use isMemberAllowToInvite() instead
boolean io.agora.chat.Group.isMemberAllowToInvite ( )

Get if the group member is allow invite the others

Returns
boolean
boolean io.agora.chat.Group.isMemberOnly ( )

Group properties:members can not auto join the group, need join group application approved or received invitation Corresponding group style is the three other attributes besides GroupManager.GroupStyle#GroupStylePublicOpenJoin

Returns
boolean
boolean io.agora.chat.Group.isMembersOnly ( )

Group properties:members can not auto join the group, need join group application approved or received invitation Corresponding group style is the three other attributes besides GroupManager.GroupStyle#GroupStylePublicOpenJoin

Returns
boolean
Deprecated:
use isMemberOnly() instead
boolean io.agora.chat.Group.isMsgBlocked ( )

Get whether the group message is blocked For blocking group message see GroupManager#blockGroupMessage(String), unblocking see GroupManager#unblockGroupMessage(String)

Returns
boolean
boolean io.agora.chat.Group.isPublic ( )

Get if the group is public

Returns
boolean True is public group, otherwise is private group
String io.agora.chat.Group.toString ( )

Return group name or group id, this method can be used for adapter sorting

Returns
String

The documentation for this class was generated from the following file: