EMGroup类 参考

#import <EMGroup.h>

类 EMGroup 继承关系图:

构造函数
(EMGroupOptions *setting)	- __deprecated_msg
(NSArray *occupants)	- __deprecated_msg

类方法
(instancetype)	+ groupWithId:

属性
NSString *	groupId
NSString *	groupName
NSString *	description
NSString *	announcement
EMGroupOptions *	settings
NSString *	owner
NSArray< NSString * > *	adminList
NSArray< NSString * > *	memberList
NSArray< NSString * > *	blacklist
NSArray< NSString * > *	muteList
NSArray< NSString * > *	whiteList
NSArray< EMGroupSharedFile * > *	sharedFileList
BOOL	isPushNotificationEnabled
BOOL	isPublic
BOOL	isBlocked
EMGroupPermissionType	permissionType
NSArray< NSString * > *	users
NSInteger	occupantsCount
BOOL	isMuteAllMembers
BOOL	isDisabled

详细描述

群组。

函数文档

- (EMGroupOptions* setting) __deprecated_msg

("Use settings instead")

群组属性配置，需要先通过 getGroupSpecificationFromServerWithId 获取群组详情。

已废弃，请用 settings 代替。

- (NSArray* occupants) __deprecated_msg

("Use users instead")

群组的所有成员(包含owner、admins和members)。

已废弃，请用 users 代替。

+ (instancetype) groupWithId:

(NSString *)

aGroupId

获取群组实例，如果不存在则创建。

参数

aGroupId

群组 ID。

返回

群组实例。

属性说明

- (NSArray<NSString *>*) adminList

readnonatomiccopy

群组的管理者，拥有群的管理权限，需要先通过 getGroupSpecificationFromServerWithId 获取群组详情。

- (NSString*) announcement

readnonatomiccopy

群组的公告，需要先通过 getGroupAnnouncementWithId 方法获取群公告。

- (NSArray<NSString *>*) blacklist

readnonatomicstrong

群组的黑名单，需要先调用 getGroupSpecificationFromServerWithId 方法获取群详情。

该方法只有群主才有权限调用。否则 SDK 返回空值 nil 。

- (NSString*) description

readnonatomiccopy

群组的描述，需要先通过 getGroupSpecificationFromServerWithId 获取群组详情。

- (NSString*) groupId

readnonatomiccopy

群组 ID。

- (NSString*) groupName

readnonatomiccopy

群组的名称，需要先通过 getGroupSpecificationFromServerWithId 方法获取群详情。

- (BOOL) isBlocked

readnonatomicassign

是否屏蔽群消息。

- (BOOL) isDisabled

readnonatomicassign

群组是否禁用。（本地数据库不存储，从数据库读取或拉取漫游消息默认值是 NO）

- (BOOL) isMuteAllMembers

readnonatomicassign

群组成员是否全部被禁言。

- (BOOL) isPublic

readnonatomicassign

此群是否为公开群，需要先通过 getGroupSpecificationFromServerWithId 获取群组详情。

- (BOOL) isPushNotificationEnabled

readnonatomicassign

群组是否接收消息推送通知。

- (NSArray<NSString *>*) memberList

readnonatomiccopy

群组的成员列表，需要先通过 getGroupSpecificationFromServerWithId 获取群组详情。

- (NSArray<NSString *>*) muteList

readnonatomicstrong

群组的被禁言列表。

该方法只有管理员或者群主才有权限调用。否则 SDK 返回空值 nil 。

- (NSInteger) occupantsCount

readnonatomicassign

群组当前的成员数量，包括群主、群管理员和普通成员。该方法需要先通过 getGroupSpecificationFromServerWithId 获取群组详情。

- (NSString*) owner

readnonatomiccopy

群组的所有者，拥有群的最高权限，需要先通过 getGroupSpecificationFromServerWithId 获取群组详情。

群组的所有者只有一人。

- (EMGroupPermissionType) permissionType

readnonatomicassign

当前登录账号的群成员类型。

- (EMGroupOptions*) settings

readnonatomicstrong

群组属性配置，需要先通过 getGroupSpecificationFromServerWithId 获取群组详情。

- (NSArray<EMGroupSharedFile *>*) sharedFileList

readnonatomicstrong

群共享文件列表。

- (NSArray<NSString *>*) users

readnonatomicstrong

群组的所有成员(包含群主、管理员和普通成员）。

- (NSArray<NSString *>*) whiteList

readnonatomicstrong

聊天室的白名单列表。

该方法只有群主才能调用，否则 SDK 返回空值 nil。

---

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

• HyphenateChat.framework/Headers/EMGroup.h