AgoraChatGroup Class Reference

#import <AgoraChatGroup.h>

Inheritance diagram for AgoraChatGroup:

Instance Methods
(AgoraChatGroupOptions *setting)	- __deprecated_msg
(NSArray *occupants)	- __deprecated_msg

Class Methods
(instancetype)	+ groupWithId:

Properties
NSString *	groupId
NSString *	groupName
NSString *	description
NSString *	announcement
AgoraChatGroupOptions *	settings
NSString *	owner
NSArray< NSString * > *	adminList
NSArray< NSString * > *	memberList
NSArray< NSString * > *	blacklist
NSArray< NSString * > *	muteList
NSArray< NSString * > *	whiteList
NSArray< AgoraChatGroupSharedFile * > *	sharedFileList
BOOL	isPushNotificationEnabled
BOOL	isPublic
BOOL	isBlocked
AgoraChatGroupPermissionType	permissionType
NSArray< NSString * > *	users
NSInteger	occupantsCount
BOOL	isMuteAllMembers
BOOL	isDisabled

Detailed Description

The group.

Method Documentation

__deprecated_msg [1/2]

- (AgoraChatGroupOptions *setting) __deprecated_msg

("Use settings instead")

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

Deprecated. Please use settings instead.

__deprecated_msg [2/2]

- (NSArray *occupants) __deprecated_msg

("Use users instead")

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

Deprecated. Please use users instead.

groupWithId:

+ (instancetype) groupWithId:

(NSString *)

aGroupId

Gets the group instance. Creates an instance if it does not exist.

Parameters

aGroupId

The group ID.

Returns

The group instance.

Property Documentation

adminList

- (NSArray<NSString *>*) adminList

readnonatomiccopy

The admins of the group who have the group management authority. To get the value of this member, you need to call getGroupSpecificationFromServerWithId first.

announcement

- (NSString*) announcement

readnonatomiccopy

The announcement of the group. To get the value of this member, you need to call getGroupAnnouncementWithId first.

blacklist

- (NSArray<NSString *>*) blacklist

readnonatomicstrong

The blocklist of the chat group. To get the value of this member, you need to call getGroupSpecificationFromServerWithId first.

Only the group owner can call this method. Otherwise, the SDK returns nil.

description

- (NSString*) description

readnonatomiccopy

The description of the group. To get the value of this member, you need to call getGroupSpecificationFromServerWithId first.

groupId

- (NSString*) groupId

readnonatomiccopy

The group ID.

groupName

- (NSString*) groupName

readnonatomiccopy

The subject of the group. To get the value of this member, you need to call getGroupSpecificationFromServerWithId to get the group details first.

isBlocked

- (BOOL) isBlocked

readnonatomicassign

Whether to block the current group‘s messages.

isDisabled

- (BOOL) isDisabled

readnonatomicassign

Whether the group is disabled. The default value for reading or pulling roaming messages from the database is NO

isMuteAllMembers

- (BOOL) isMuteAllMembers

readnonatomicassign

Whether all the group members are muted.

isPublic

- (BOOL) isPublic

readnonatomicassign

Whether the group is a public group. To get the value of this member, you need to call getGroupSpecificationFromServerWithId first.

isPushNotificationEnabled

- (BOOL) isPushNotificationEnabled

readnonatomicassign

Whether to enable the push notification service for the group.

memberList

- (NSArray<NSString *>*) memberList

readnonatomiccopy

The member list of the group. To get the value of this member, you need to call getGroupSpecificationFromServerWithId first.

muteList

- (NSArray<NSString *>*) muteList

readnonatomicstrong

The list of muted members.

Only the group owner or admin can call this method. Otherwise, the SDK returns nil.

occupantsCount

- (NSInteger) occupantsCount

readnonatomicassign

The total number of group occupants, including the owner, admins, and all other group members. To get the value of this member, you need to call getGroupSpecificationFromServerWithId first.

owner

- (NSString*) owner

readnonatomiccopy

The owner of the group who has the highest privilege of the group. To get the value of this member, you need to call getGroupSpecificationFromServerWithId first.

Each chat group has only one owner.

permissionType

- (AgoraChatGroupPermissionType) permissionType

readnonatomicassign

The group membership type of the current login account.

settings

- (AgoraChatGroupOptions*) settings

readnonatomicstrong

The setting options of group. To get the value of this member, you need to call getGroupSpecificationFromServerWithId first.

sharedFileList

- (NSArray<AgoraChatGroupSharedFile *>*) sharedFileList

readnonatomicstrong

The list of group shared files.

users

- (NSArray<NSString *>*) users

readnonatomicstrong

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

whiteList

- (NSArray<NSString *>*) whiteList

readnonatomicstrong

The allowlist of the chat group.

Only the group owner can call this method. Otherwise, the SDK returns nil.

---

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

• AgoraChat.framework/Headers/AgoraChatGroup.h