AgoraChatSDK 1.2.0
AgoraChatGroup.h
1
9#import <Foundation/Foundation.h>
10
11#import "AgoraChatCommonDefs.h"
12#import "AgoraChatGroupOptions.h"
14
19typedef NS_ENUM(NSInteger, AgoraChatGroupPermissionType) {
20 AgoraChatGroupPermissionTypeNone = -1,
21 AgoraChatGroupPermissionTypeMember = 0,
22 AgoraChatGroupPermissionTypeAdmin,
23 AgoraChatGroupPermissionTypeOwner,
24};
25
30@interface AgoraChatGroup : NSObject
31
36@property (nonatomic, copy, readonly) NSString *groupId;
37
42@property (nonatomic, copy, readonly) NSString *groupName;
43
48@property (nonatomic, copy, readonly) NSString *description;
49
54@property (nonatomic, copy, readonly) NSString *announcement;
55
60@property (nonatomic, strong, readonly) AgoraChatGroupOptions *settings;
61
68@property (nonatomic, copy, readonly) NSString *owner;
69
75@property (nonatomic, copy, readonly) NSArray<NSString *> *adminList;
76
81@property (nonatomic, copy, readonly) NSArray<NSString *> *memberList;
82
89@property (nonatomic, strong, readonly) NSArray<NSString *> *blacklist;
90
97@property (nonatomic, strong, readonly) NSArray<NSString *> *muteList;
98
99
106@property (nonatomic, strong, readonly) NSArray<NSString *> *whiteList;
107
112@property (nonatomic, strong, readonly) NSArray<AgoraChatGroupSharedFile *> *sharedFileList;
113
118@property (nonatomic, readonly) BOOL isPushNotificationEnabled;
119
124@property (nonatomic, readonly) BOOL isPublic;
125
130@property (nonatomic, readonly) BOOL isBlocked;
131
136@property (nonatomic, readonly) AgoraChatGroupPermissionType permissionType;
137
142@property (nonatomic, strong, readonly) NSArray<NSString *> *users;
143
148@property (nonatomic, readonly) NSInteger occupantsCount;
149
154@property (nonatomic, readonly) BOOL isMuteAllMembers;
155
160 @property (nonatomic, readonly) BOOL isDisabled;
161
170+ (instancetype)groupWithId:(NSString *)aGroupId;
171
172#pragma mark - EM_DEPRECATED_IOS 3.8.8
179@property (nonatomic, strong, readonly) AgoraChatGroupOptions *setting __deprecated_msg("Use settings instead");
180
187@property (nonatomic, strong, readonly) NSArray *occupants
188__deprecated_msg("Use users instead");
189
190@end
Definition: AgoraChatGroup.h:31
NSArray< NSString * > * whiteList
Definition: AgoraChatGroup.h:106
NSArray< AgoraChatGroupSharedFile * > * sharedFileList
Definition: AgoraChatGroup.h:112
NSString * groupId
Definition: AgoraChatGroup.h:36
BOOL isMuteAllMembers
Definition: AgoraChatGroup.h:154
NSArray< NSString * > * memberList
Definition: AgoraChatGroup.h:81
AgoraChatGroupOptions *setting __deprecated_msg("Use settings instead")
NSInteger occupantsCount
Definition: AgoraChatGroup.h:148
BOOL isBlocked
Definition: AgoraChatGroup.h:130
NSArray< NSString * > * blacklist
Definition: AgoraChatGroup.h:89
BOOL isPublic
Definition: AgoraChatGroup.h:124
AgoraChatGroupPermissionType permissionType
Definition: AgoraChatGroup.h:136
NSString * announcement
Definition: AgoraChatGroup.h:54
NSArray *occupants __deprecated_msg("Use users instead")
NSArray< NSString * > * users
Definition: AgoraChatGroup.h:142
AgoraChatGroupOptions * settings
Definition: AgoraChatGroup.h:60
BOOL isPushNotificationEnabled
Definition: AgoraChatGroup.h:118
NSString * description
Definition: AgoraChatGroup.h:48
NSArray< NSString * > * muteList
Definition: AgoraChatGroup.h:97
NSString * groupName
Definition: AgoraChatGroup.h:42
NSArray< NSString * > * adminList
Definition: AgoraChatGroup.h:75
BOOL isDisabled
Definition: AgoraChatGroup.h:160
NSString * owner
Definition: AgoraChatGroup.h:68
Definition: AgoraChatGroupOptions.h:30
Definition: AgoraChatGroupSharedFile.h:15