com.hyphenate.chat.EMGroup类 参考

类
enum	EMGroupPermissionType

Public 成员函数
String	getGroupId ()
String	getGroupName ()
String	getGroupAvatar ()
String	getDescription ()
boolean	isPublic ()
boolean	isMemberAllowToInvite ()
boolean	isJoinApprovalRequired ()
int	getMaxUserCount ()
boolean	isMsgBlocked ()
String	getOwner ()
String	groupSubject ()
List< String >	getMembers ()
int	getMemberCount ()
String	toString ()
List< String >	getAdminList ()
List< String >	getUsers ()
List< String >	getBlackList ()
List< String >	getMuteList ()
List< String >	getWhiteList ()
boolean	isAllMemberMuted ()
String	getExtension ()
String	getAnnouncement ()
List< EMMucSharedFile >	getShareFileList ()
EMGroupPermissionType	getGroupPermissionType ()
boolean	isDisabled ()

详细描述

群组。

成员函数说明

getAdminList()

List< String > com.hyphenate.chat.EMGroup.getAdminList

(

)

获取群组管理员列表。需要先通过 EMGroupManager#getGroupFromServer(String) 获取群组详情。

返回

群组管理员列表。

getAnnouncement()

String com.hyphenate.chat.EMGroup.getAnnouncement

(

)

获取群组公告。 如果没有获取群组公告，返回的值为空。

获取群组公告，可调用 EMGroupManager#fetchGroupAnnouncement(String), 也可调用其异步方法 EMGroupManager#asyncFetchGroupAnnouncement(String, EMValueCallBack)。

返回

群组公告内容。

getBlackList()

List< String > com.hyphenate.chat.EMGroup.getBlackList

(

)

获取群组黑名单。 如果没有获取群组黑名单列表，返回的列表可能为空。

参考： 获取黑名单列表可调用 EMGroupManager#fetchGroupBlackList(String, int, int), 调用这个方法需要群组所有者或者管理员身份。

也可通过它的异步方法进行调用，如下： EMGroupManager#asyncFetchGroupBlackList(String, int, int, EMValueCallBack)

返回

黑名单列表。

getDescription()

String com.hyphenate.chat.EMGroup.getDescription

(

)

获取群简介。

返回

群描述。

getExtension()

String com.hyphenate.chat.EMGroup.getExtension

(

)

获取群组订制扩展信息。

返回

群组定制扩展信息。

getGroupAvatar()

String com.hyphenate.chat.EMGroup.getGroupAvatar

(

)

获取群头像。

返回

群头像URL。

getGroupId()

String com.hyphenate.chat.EMGroup.getGroupId

(

)

获取群 ID。

返回

群 ID。

getGroupName()

String com.hyphenate.chat.EMGroup.getGroupName

(

)

获取群名称。

返回

群名称。

getGroupPermissionType()

EMGroupPermissionType com.hyphenate.chat.EMGroup.getGroupPermissionType

(

)

获取当前用户在群中的角色。

返回

返回 EMGroupPermissionType 中的具体类型，例如群主，管理员或者成员。

getMaxUserCount()

int com.hyphenate.chat.EMGroup.getMaxUserCount

(

)

获取群允许加入的最大成员数，在创建群时确定。 需要获取群详情才能拿到正确的结果，如果没有获取则返回 0。

返回

getMemberCount()

int com.hyphenate.chat.EMGroup.getMemberCount

(

)

获取成员数量。

包括群主、管理员、普通成员。

返回

成员数量。

getMembers()

List< String > com.hyphenate.chat.EMGroup.getMembers

(

)

获取群成员列表。 如果没有获取成员列表，返回的列表可能为空。

获取成员有如下方式： （1）成员人数少于 200 人时，可通过 EMGroupManager#getGroupFromServer(String, boolean), 第二个参数传入 true，可获取最多 200 个成员。 （2）通过 EMGroupManager#fetchGroupMembers(String, String, int) 分页获取，也可通过其异步方法 EMGroupManager#asyncFetchGroupMembers(String, String, int, EMValueCallBack) 获取。

返回

群成员 ID 列表。

getMuteList()

List< String > com.hyphenate.chat.EMGroup.getMuteList

(

)

获取群组禁言列表。 如果没有获取禁言列表，返回的列表可能为空。

参考： 获取禁言列表可调用 EMGroupManager#fetchGroupMuteList(String, int, int), 调用这个方法需要群组所有者或者管理员身份。 也可通过它的异步方法进行调用，如下 EMGroupManager#asyncFetchGroupMuteList(String, int, int, EMValueCallBack)

返回

群组禁言列表。

getOwner()

String com.hyphenate.chat.EMGroup.getOwner

(

)

获取群所有者 ID。

返回

群所者用户 ID。

getShareFileList()

List< EMMucSharedFile > com.hyphenate.chat.EMGroup.getShareFileList

(

)

获取群组共享文件。 如果没有获取群组共享文件，返回的列表可能为空。

参考： 获取群组共享文件，可调用 EMGroupManager#fetchGroupSharedFileList(String, int, int), 也可调用其异步方法 EMGroupManager#asyncFetchGroupSharedFileList(String, int, int, EMValueCallBack)

返回

群组共享文件列表。

getUsers()

List< String > com.hyphenate.chat.EMGroup.getUsers

(

)

获取群组的所有成员。

包含群主、管理员和普通成员。

返回

群组所有成员的用户 ID 列表。

getWhiteList()

List< String > com.hyphenate.chat.EMGroup.getWhiteList

(

)

获取白名单列表。 如果没有从服务器获取白名单列表，返回的列表可能为空。

参考： 获取白名单可调用 EMGroupManager#fetchGroupWhiteList(String, EMValueCallBack), 调用这个方法需要群组所有者或者管理员身份。

返回

群组白名单列表。

groupSubject()

String com.hyphenate.chat.EMGroup.groupSubject

(

)

获取群组主题，需要获取群详情。

返回

群组主题。

isAllMemberMuted()

boolean com.hyphenate.chat.EMGroup.isAllMemberMuted

(

)

返回是否全员禁言。

此方法有使用局限性，建议慎重使用。

在收到禁言/解禁的回调时，该状态会更新，但是只是更新内存中对象， 内存中对象被回收后以及再次从数据库或者从服务端拉取后，该状态变的不可信。

返回

是否全员禁言。

isDisabled()

boolean com.hyphenate.chat.EMGroup.isDisabled

(

)

返回群组是否禁用。

返回

群组是否禁用：

• true：群组已经被禁用；
• false：群组没有被禁用。

isJoinApprovalRequired()

boolean com.hyphenate.chat.EMGroup.isJoinApprovalRequired

(

)

获取群组配置：加入公开群是否需要审批。

该方法直接返回群组配置的 joinApprovalRequired 字段。对私有群（isPublic=false）该配置无实际意义，私有群用户只能通过邀请入群。

返回

• true：群组配置 joinApprovalRequired=true，用户加入公开群需要审批；
• false：群组配置 joinApprovalRequired=false，用户可以自由加入公开群。

isMemberAllowToInvite()

boolean com.hyphenate.chat.EMGroup.isMemberAllowToInvite

(

)

获取群组是否允许成员邀请。

返回

- true：群组配置 allowInvites=true，群成员可以邀请其他用户加入；

• false：群组配置 allowInvites=false，不允许群成员邀请其他用户加入。

isMsgBlocked()

boolean com.hyphenate.chat.EMGroup.isMsgBlocked

(

)

获取是否已屏蔽群消息。

参考： 设置屏蔽群消息见 EMGroupManager#blockGroupMessage(String), 取消屏蔽群消息见 EMGroupManager#unblockGroupMessage(String)。

返回

- true：用户已经屏蔽群消息；

• false：用户没有屏蔽群消息。

isPublic()

boolean com.hyphenate.chat.EMGroup.isPublic

(

)

群组是否为公开群。

返回

true：群组配置 isPublic=true，为公开群；false：群组配置 isPublic=false，为私有群。

toString()

String com.hyphenate.chat.EMGroup.toString

(

)

返回群组名称，如果为空则返回群组 ID，此方法可用于 Adapter 排序。

返回

群组名称，如果为空则返回群组 ID。

---

该类的文档由以下文件生成:

• com/hyphenate/chat/EMGroup.java