AgoraChatroom Class Reference

#import <AgoraChatroom.h>

Inheritance diagram for AgoraChatroom:

Instance Methods
(NSArray *members)	- EM_DEPRECATED_IOS
(NSInteger membersCount)	- EM_DEPRECATED_IOS
(NSInteger maxMembersCount)	- EM_DEPRECATED_IOS
(NSArray *occupants)	- __deprecated_msg
("Use +chatroomWithId: instead")	- __deprecated_msg

Class Methods
(instancetype)	+ chatroomWithId:

Properties
NSString *	chatroomId
NSString *	subject
NSString *	description
NSString *	owner
NSString *	announcement
NSArray *	adminList
NSArray *	memberList
NSArray *	blacklist
NSArray *	muteList
NSArray *	whiteList
AgoraChatroomPermissionType	permissionType
NSInteger	maxOccupantsCount
NSInteger	occupantsCount
BOOL	isMuteAllMembers

Detailed Description

Chat room object

Method Documentation

- (NSArray* occupants) __deprecated_msg

("Use - members instead")

List of members in the chat room

- ("Use +)chatroomWithId:

Initialize chatroom instance

Please use [+chatroomWithId:]

Returns

nil

+ (instancetype) chatroomWithId:

(NSString *)

aChatroomId

Construct a chatroom instance with chatroom id

Parameters

aChatroomId

Chatroom id

Returns

Chatroom instance

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

List of members in the chat room

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

The total number of members in the chat room

- (NSInteger maxMembersCount) EM_DEPRECATED_IOS		(3_1_0)
		(3_3_0)
		("Use -maxOccupantsCount instead")

The capacity of the chat room

Property Documentation

- (NSArray*) adminList

readnonatomiccopy

Admins of the chatroom

- (NSString*) announcement

readnonatomiccopy

Announcement of chat room

- (NSArray*) blacklist

readnonatomicstrong

Chatroom‘s blacklist of blocked users

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

- (NSString*) chatroomId

readnonatomiccopy

Chat room id

- (NSString*) description

readnonatomiccopy

Description of chat room

- (BOOL) isMuteAllMembers

readnonatomicassign

The chat room is all members muted.

- (NSInteger) maxOccupantsCount

readnonatomicassign

The capacity of the chat room

- (NSArray*) memberList

readnonatomiccopy

List of members in the chat room

- (NSArray*) muteList

readnonatomicstrong

List of muted members<NSString>

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

- (NSInteger) occupantsCount

readnonatomicassign

The total number of members in the chat room

- (NSString*) owner

readnonatomiccopy

Owner of the chat room. Only one owner per chat room.

- (AgoraChatroomPermissionType) permissionType

readnonatomicassign

The chatroom membership type of the current login account

- (NSString*) subject

readnonatomiccopy

Subject of chat room

- (NSArray*) whiteList

readnonatomicstrong

List of whitelist members<NSString>

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

---

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

• AgoraChat.framework/Headers/AgoraChatroom.h