AgoraChatSDK 1.3.1
AgoraChatroom.h
1
9#import <Foundation/Foundation.h>
10
11#import "AgoraChatCommonDefs.h"
12
17typedef NS_ENUM(NSInteger, AgoraChatroomPermissionType) {
18 AgoraChatroomPermissionTypeNone = -1,
19 AgoraChatroomPermissionTypeMember = 0,
20 AgoraChatroomPermissionTypeAdmin,
21 AgoraChatroomPermissionTypeOwner,
22};
23
24
29@interface AgoraChatroom : NSObject
30
35@property (nonatomic, copy, readonly) NSString * _Nullable chatroomId;
36
41@property (nonatomic, copy, readonly) NSString * _Nullable subject;
42
47@property (nonatomic, copy, readonly) NSString * _Nullable description;
48
53@property (nonatomic, copy, readonly) NSString * _Nullable owner;
54
59@property (nonatomic, copy, readonly) NSString * _Nullable announcement;
60
66@property (nonatomic, copy, readonly) NSArray<NSString *> * _Nullable adminList;
67
72@property (nonatomic, copy, readonly) NSArray<NSString *> * _Nullable memberList;
73
80@property (nonatomic, strong, readonly) NSArray<NSString *> * _Nullable blacklist;
81
82
89@property (nonatomic, strong, readonly) NSArray<NSString *> * _Nullable muteList;
90
97@property (nonatomic, strong, readonly) NSArray<NSString *> * _Nullable whitelist;
98
103@property (nonatomic, readonly) AgoraChatroomPermissionType permissionType;
104
109@property (nonatomic, readonly) NSInteger maxOccupantsCount;
110
115@property (nonatomic, readonly) NSInteger occupantsCount;
116
121@property (nonatomic, readonly) BOOL isMuteAllMembers;
130+ (instancetype _Nullable)chatroomWithId:(NSString * _Nonnull )aChatroomId;
131
132#pragma mark - EM_DEPRECATED_IOS 3.8.8
133
140@property (nonatomic, strong, readonly) NSArray *whiteList __deprecated_msg("Use whitelist instead");
141
142#pragma mark - EM_DEPRECATED_IOS 3.3.0
143
148@property (nonatomic, copy, readonly) NSArray *members EM_DEPRECATED_IOS(3_1_0, 3_3_0, "Use -memberList instead");
149
154@property (nonatomic, readonly) NSInteger membersCount EM_DEPRECATED_IOS(3_1_0, 3_3_0, "Use -occupantsCount instead");
155
160@property (nonatomic, readonly) NSInteger maxMembersCount EM_DEPRECATED_IOS(3_1_0, 3_3_0, "Use -maxOccupantsCount instead");
161
162#pragma mark - EM_DEPRECATED_IOS < 3.2.3
163
168@property (nonatomic, copy, readonly) NSArray *occupants __deprecated_msg("Use -members instead");
169
178- (instancetype)init __deprecated_msg("Use +chatroomWithId: instead");
179
180@end
Definition: AgoraChatroom.h:30
NSArray *members EM_DEPRECATED_IOS(3_1_0, 3_3_0, "Use -memberList instead")
AgoraChatroomPermissionType permissionType
Definition: AgoraChatroom.h:103
NSArray< NSString * > *_Nullable muteList
Definition: AgoraChatroom.h:89
NSInteger membersCount EM_DEPRECATED_IOS(3_1_0, 3_3_0, "Use -occupantsCount instead")
NSString *_Nullable chatroomId
Definition: AgoraChatroom.h:35
NSString *_Nullable description
Definition: AgoraChatroom.h:47
NSArray< NSString * > *_Nullable blacklist
Definition: AgoraChatroom.h:80
BOOL isMuteAllMembers
Definition: AgoraChatroom.h:121
NSInteger maxMembersCount EM_DEPRECATED_IOS(3_1_0, 3_3_0, "Use -maxOccupantsCount instead")
NSInteger maxOccupantsCount
Definition: AgoraChatroom.h:109
"Use +chatroomWithId: instead" __deprecated_msg()
NSArray< NSString * > *_Nullable whitelist
Definition: AgoraChatroom.h:97
NSArray *occupants __deprecated_msg("Use -members instead")
NSInteger occupantsCount
Definition: AgoraChatroom.h:115
NSArray *whiteList __deprecated_msg("Use whitelist instead")
NSString *_Nullable subject
Definition: AgoraChatroom.h:41
NSString *_Nullable owner
Definition: AgoraChatroom.h:53
NSArray< NSString * > *_Nullable memberList
Definition: AgoraChatroom.h:72
NSArray< NSString * > *_Nullable adminList
Definition: AgoraChatroom.h:66
NSString *_Nullable announcement
Definition: AgoraChatroom.h:59