AgoraGroup Class Reference

#import <AgoraGroup.h>

Inheritance diagram for AgoraGroup:

Instance Methods
(NSArray *members)	- EM_DEPRECATED_IOS
(NSArray *blackList)	- EM_DEPRECATED_IOS
(NSInteger membersCount)	- EM_DEPRECATED_IOS
(NSString *subject)	- EM_DEPRECATED_IOS
("Use +groupWithId: instead")	- __deprecated_msg
(NSArray *bans)	- __deprecated_msg

Class Methods
(instancetype)	+ groupWithId:

Properties
NSString *	groupId
NSString *	groupName
NSString *	description
NSString *	announcement
AgoraGroupOptions *	setting
NSString *	owner
NSArray *	adminList
NSArray *	memberList
NSArray *	blacklist
NSArray *	muteList
NSArray *	whiteList
NSArray *	sharedFileList
BOOL	isPushNotificationEnabled
BOOL	isPublic
BOOL	isBlocked
AgoraGroupPermissionType	permissionType
NSArray *	occupants
NSInteger	occupantsCount
BOOL	isMuteAllMembers

Detailed Description

Group

Method Documentation

- ("Use +)groupWithId:

Initialize a group instance

Please use [+groupWithId:]

Returns

nil

- (NSArray* bans) __deprecated_msg

("Use - blackList instead")

Group‘s blacklist of blocked users, require call fetch blackList method first

Need owner's authority to access, return nil if user is not the group owner.

- (NSArray* members) EM_DEPRECATED_IOS		(3_1_0)
		(3_3_0)
		("Use -memberList instead")

Member list of the group,require fetch group's detail first

- (NSArray* blackList) EM_DEPRECATED_IOS		(3_1_0)
		(3_3_0)
		("Use -blacklist instead")

Group‘s blacklist of blocked users,require call fetch blackList method first

Need owner's authority to access, return nil if user is not the group owner.

- (NSInteger membersCount) EM_DEPRECATED_IOS		(3_1_0)
		(3_3_0)
		("Use -occupantsCount instead")

The total number of group members, require fetch group's detail first, include owner, admins, members

- (NSString* subject) EM_DEPRECATED_IOS		(3_1_0)
		(3_6_2)
		("Use -groupName instead")

Subject of the group, require fetch group's detail first

+ (instancetype) groupWithId:

(NSString *)

aGroupId

Get group instance, create a instance if it does not exist

Parameters

aGroupId

Group id

Returns

Group instance

Property Documentation

- (NSArray*) adminList

readnonatomiccopy

Admins of the group, have group management authority, require fetch group's detail first

- (NSString*) announcement

readnonatomiccopy

Announcement of the group, require fetch group's announcement first

- (NSArray*) blacklist

readnonatomicstrong

Group's blacklist of blocked users, require call get blackList method first

Need owner's authority to access, return nil if user is not the group owner.

- (NSString*) description

readnonatomiccopy

Description of the group, require fetch group's detail first

- (NSString*) groupId

readnonatomiccopy

Group id

- (NSString*) groupName

readnonatomiccopy

Subject of the group, require fetch group's detail first

- (BOOL) isBlocked

readnonatomicassign

Whether block the current group‘s messages

- (BOOL) isMuteAllMembers

readnonatomicassign

The group is all members muted.

- (BOOL) isPublic

readnonatomicassign

Whether is a public group, require fetch group's detail first

- (BOOL) isPushNotificationEnabled

readnonatomicassign

Whether use Apple Push Notification Service for group

- (NSArray*) memberList

readnonatomiccopy

Member list of the group, require fetch group's detail first

- (NSArray*) muteList

readnonatomicstrong

List of muted members

Need owner's authority to access, return nil if user is not the group owner.

- (NSArray*) occupants

readnonatomicstrong

All occupants of the group, includes the group owner and admins and all other group members

- (NSInteger) occupantsCount

readnonatomicassign

The total number of group occupants, require fetch group's detail first, include owner, admins, members

- (NSString*) owner

readnonatomiccopy

Owner of the group, has the highest authority of the group, require fetch group's detail first

Each group only has one owner

- (AgoraGroupPermissionType) permissionType

readnonatomicassign

The group membership type of the current login account

- (AgoraGroupOptions*) setting

readnonatomicstrong

Setting options of group, require fetch group's detail first

- (NSArray*) sharedFileList

readnonatomicstrong

List of group shared file

- (NSArray*) whiteList

readnonatomicstrong

List of whitelist members<NSString>

Need owner's authority to access, return nil if user is not the group owner.

---

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

• AgoraChat.framework/Headers/AgoraGroup.h