hyphenate_SDK4.0 4.8.0
hyphenate java IM SDK
|
Inherits com.hyphenate.chat.EMBase< T >.
Classes | |
enum | EMGroupPermissionType |
Public Member Functions | |
String | getGroupId () |
String | getGroupName () |
String | getDescription () |
boolean | isPublic () |
boolean | isMemberAllowToInvite () |
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< EMMucSharedFile > | getShareFileList () |
EMGroupPermissionType | getGroupPermissionType () |
boolean | isDisabled () |
The group class.
List< String > com.hyphenate.chat.EMGroup.getAdminList | ( | ) |
Gets the admin list of the group.
Be sure to fetch the detail specification of the group from the server first, see EMGroupManager#getGroupFromServer(String).
String com.hyphenate.chat.EMGroup.getAnnouncement | ( | ) |
Gets the group announcement. If no announcement is found from the server, the return may be empty.
Reference: You can also call the method: EMGroupManager#fetchGroupAnnouncement(String) to get the group announcement. As for its asynchronous method, see EMGroupManager#asyncFetchGroupAnnouncement(String, EMValueCallBack).
List< String > com.hyphenate.chat.EMGroup.getBlackList | ( | ) |
Gets the blocklist of the group.
If no blocklist is found from the server, the return may be empty.
Reference: To fetch the blocklist, call EMGroupManager#fetchGroupBlackList(String, int, int).
Only the group owner or admin can call this method.
You also can call it's asynchronous method as follows: EMGroupManager#asyncFetchGroupBlackList(String, int, int, EMValueCallBack).
String com.hyphenate.chat.EMGroup.getDescription | ( | ) |
Gets the group description.
String com.hyphenate.chat.EMGroup.getExtension | ( | ) |
Gets the customized extension of the group.
String com.hyphenate.chat.EMGroup.getGroupId | ( | ) |
Gets the group ID.
String com.hyphenate.chat.EMGroup.getGroupName | ( | ) |
Gets the group name.
EMGroupPermissionType com.hyphenate.chat.EMGroup.getGroupPermissionType | ( | ) |
Gets the current user's role in group.
EMGroupPermissionType
. int com.hyphenate.chat.EMGroup.getMaxUserCount | ( | ) |
The max number of group members allowed in a group. The param is set when the group is created.
Be sure to fetch the detail specification of the group from the server first, see EMGroupManager#getGroupFromServer(String). If not, the SDK returns 0.
int com.hyphenate.chat.EMGroup.getMemberCount | ( | ) |
Gets the member count of the group.
This includes the group owner, administrators, and regular members.
List< String > com.hyphenate.chat.EMGroup.getMembers | ( | ) |
Gets the member list of the group. If no member is found from the server, the return might be empty.
Reference: You can get the group members in the following ways: (1) When member's number is less than 200, can use EMGroupManager#getGroupFromServer(String, boolean) to fetch, the second parameter pass in true, can get up to 200 members (2) Use the method of EMGroupManager#fetchGroupMembers(String, String, int) to get by page, or its asynchronous method of EMGroupManager#asyncFetchGroupMembers(String, String, int, EMValueCallBack)
to get
List< String > com.hyphenate.chat.EMGroup.getMuteList | ( | ) |
Gets the mute list of the group.
If no mute list is found from the server, the return may be empty.
Reference: You can also fetch the mute list by calling EMGroupManager#fetchGroupMuteList(String, int, int). And only the group owner or admin can call this method.
You can also call it's asynchronous method, see EMGroupManager#asyncFetchGroupMuteList(String, int, int, EMValueCallBack).
String com.hyphenate.chat.EMGroup.getOwner | ( | ) |
Gets the user ID of the group owner.
List< EMMucSharedFile > com.hyphenate.chat.EMGroup.getShareFileList | ( | ) |
Gets the group shared file list. If no shared file is found from the server, the return might be empty.
Reference: You can also call EMGroupManager#fetchGroupSharedFileList(String, int, int) to fetch the shared file list. And for the asynchronous method, see EMGroupManager#asyncFetchGroupSharedFileList(String, int, int, EMValueCallBack).
List< String > com.hyphenate.chat.EMGroup.getWhiteList | ( | ) |
Gets the allowlist of the group.
If no allowlist is found from the server, the return may be empty.
Reference: You can also fetch the allowlist by calling EMGroupManager#fetchGroupWhiteList(String, EMValueCallBack). And only the group owner or admin can call this method.
String com.hyphenate.chat.EMGroup.groupSubject | ( | ) |
The name of the group. Be sure to fetch the detail specification of the group from the server first, see EMGroupManager#getGroupFromServer(String).
boolean com.hyphenate.chat.EMGroup.isAllMemberMuted | ( | ) |
Gets whether all members are 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 unreliable.
boolean com.hyphenate.chat.EMGroup.isDisabled | ( | ) |
Gets whether the group is disabled.
true
: Group has been disabled;false
: Group is not disabled. boolean com.hyphenate.chat.EMGroup.isMemberAllowToInvite | ( | ) |
Gets whether the group member is allowed to invite other users to join the group.
true
: The group member can invite other users to join the group;false
: Do not allow the group member invite other users to join the group. boolean com.hyphenate.chat.EMGroup.isMemberOnly | ( | ) |
Fetches the group property: whether users can auto join the group VS need requesting or invitation from a group member to join the group. There are four types of group properties used to define the style of a group, and isMemberOnly
contains three types including: PRIVATE_OWNER_INVITE, PRIVATE_MEMBER_INVITE, PUBLIC_JOIN_APPROVAL. And do not include EMGroupManager.EMGroupStyle#EMGroupStylePublicOpenJoin.
true
: Users can not join the group freely. Needs the invitation from the group owner or members, or the application been approved by the group owner or admins.false
: Users can join freely without the group owner or member‘s invitation or the new joiner’s application been approved. boolean com.hyphenate.chat.EMGroup.isMsgBlocked | ( | ) |
Gets whether the group message is blocked.
Reference: For blocking group message, see EMGroupManager#blockGroupMessage(String), unblocking see EMGroupManager#unblockGroupMessage(String)
true
: The user has blocked the group messages;false
: The user does not blocked the group messages. boolean com.hyphenate.chat.EMGroup.isPublic | ( | ) |
Gets whether the group is a public group.
true
, the group is a public group, otherwise it is a private group. String com.hyphenate.chat.EMGroup.toString | ( | ) |
Gets the group name, or group ID if the group name is empty. This method can be used for adapter sorting.