AgoraChatSDK 1.2.0
AgoraChatOptions.h
1
9#import <Foundation/Foundation.h>
10
11#import "AgoraChatCommonDefs.h"
12
17typedef NS_ENUM(NSInteger, AgoraChatLogLevel)
18{
19 AgoraChatLogLevelDebug = 0,
20 AgoraChatLogLevelWarning,
21 AgoraChatLogLevelError
22} ;
23
24typedef NS_ENUM(NSInteger, AreaCode)
25{
26 AreaCodeCN = 1 << 0,
27 AreaCodeNA = 1 << 1,
28 AreaCodeEU = 1 << 2,
29 AreaCodeAS = 1 << 3,
30 AreaCodeJP = 1 << 4,
31 AreaCodeIN = 1 << 5,
32 AreaCodeGLOB = -1
33};
34
39@interface AgoraChatOptions : NSObject
40
45@property(nonatomic, copy, readonly) NSString *appkey;
46
53@property(nonatomic, assign) BOOL enableConsoleLog;
54
62@property(nonatomic, assign) AgoraChatLogLevel logLevel;
63
70@property(nonatomic, assign) BOOL usingHttpsOnly;
71
80@property(nonatomic, assign) BOOL isAutoLogin;
81
88@property(nonatomic, assign) BOOL deleteMessagesOnLeaveGroup;
89
96@property(nonatomic, assign) BOOL deleteMessagesOnLeaveChatroom;
97
104@property(nonatomic, assign) BOOL canChatroomOwnerLeave;
105
112@property(nonatomic, assign) BOOL autoAcceptGroupInvitation;
113
120@property(nonatomic, assign) BOOL autoAcceptFriendInvitation;
121
128@property(nonatomic, assign) BOOL autoDownloadThumbnail;
129
136@property(nonatomic, assign) BOOL enableRequireReadAck;
144@property(nonatomic, assign) BOOL enableDeliveryAck;
145
153@property(nonatomic, assign) BOOL sortMessageByServerTime;
154
161@property(nonatomic, assign) BOOL isAutoTransferMessageAttachments;
162
169@property(nonatomic, assign) BOOL enableFpa;
170
179@property(nonatomic, copy) NSString *apnsCertName;
180
189@property(nonatomic, copy) NSString *pushKitCertName;
190
199@property(nonatomic) AreaCode area;
200
209@property(nonatomic) BOOL enableStatistics;
210
219@property(nonatomic) BOOL loadEmptyConversations;
220
227@property(nonatomic) NSInteger customOSType;
228
235@property(strong) NSString* customDeviceName;
236
245+ (instancetype _Nonnull)optionsWithAppkey:(NSString * _Nonnull)aAppkey;
246
247#pragma mark - EM_DEPRECATED_IOS 3.8.8
254@property(nonatomic, assign) BOOL isDeleteMessagesWhenExitGroup __deprecated_msg("Use deleteMessagesOnLeaveGroup instead");
255
262@property(nonatomic, assign) BOOL isDeleteMessagesWhenExitChatRoom
263 __deprecated_msg("Use deleteMessagesOnLeaveChatroom instead");
264
271@property(nonatomic, assign) BOOL isChatroomOwnerLeaveAllowed
272 __deprecated_msg("Use canChatroomOwnerLeave instead");
273
280@property(nonatomic, assign) BOOL isAutoAcceptGroupInvitation
281 __deprecated_msg("Use autoAcceptGroupInvitation instead");
282
289@property(nonatomic, assign) BOOL isAutoAcceptFriendInvitation
290 __deprecated_msg("Use autoAcceptFriendInvitation instead");
291
298@property(nonatomic, assign) BOOL isAutoDownloadThumbnail
299 __deprecated_msg("Use autoDownloadThumbnail instead");
300
301@end
Definition: AgoraChatOptions.h:40
BOOL autoAcceptGroupInvitation
Definition: AgoraChatOptions.h:112
BOOL usingHttpsOnly
Definition: AgoraChatOptions.h:70
BOOL enableConsoleLog
Definition: AgoraChatOptions.h:53
BOOL isAutoLogin
Definition: AgoraChatOptions.h:80
BOOL enableStatistics
Definition: AgoraChatOptions.h:209
BOOL isDeleteMessagesWhenExitGroup __deprecated_msg("Use deleteMessagesOnLeaveGroup instead")
AreaCode area
Definition: AgoraChatOptions.h:199
BOOL deleteMessagesOnLeaveGroup
Definition: AgoraChatOptions.h:88
BOOL enableDeliveryAck
Definition: AgoraChatOptions.h:144
BOOL canChatroomOwnerLeave
Definition: AgoraChatOptions.h:104
BOOL isAutoDownloadThumbnail __deprecated_msg("Use autoDownloadThumbnail instead")
BOOL enableRequireReadAck
Definition: AgoraChatOptions.h:136
BOOL autoDownloadThumbnail
Definition: AgoraChatOptions.h:128
NSString * apnsCertName
Definition: AgoraChatOptions.h:179
BOOL isChatroomOwnerLeaveAllowed __deprecated_msg("Use canChatroomOwnerLeave instead")
BOOL isDeleteMessagesWhenExitChatRoom __deprecated_msg("Use deleteMessagesOnLeaveChatroom instead")
NSString * pushKitCertName
Definition: AgoraChatOptions.h:189
BOOL autoAcceptFriendInvitation
Definition: AgoraChatOptions.h:120
BOOL isAutoAcceptFriendInvitation __deprecated_msg("Use autoAcceptFriendInvitation instead")
BOOL isAutoTransferMessageAttachments
Definition: AgoraChatOptions.h:161
BOOL enableFpa
Definition: AgoraChatOptions.h:169
AgoraChatLogLevel logLevel
Definition: AgoraChatOptions.h:62
BOOL isAutoAcceptGroupInvitation __deprecated_msg("Use autoAcceptGroupInvitation instead")
NSString * customDeviceName
Definition: AgoraChatOptions.h:235
NSInteger customOSType
Definition: AgoraChatOptions.h:227
BOOL loadEmptyConversations
Definition: AgoraChatOptions.h:219
NSString * appkey
Definition: AgoraChatOptions.h:45
BOOL sortMessageByServerTime
Definition: AgoraChatOptions.h:153
BOOL deleteMessagesOnLeaveChatroom
Definition: AgoraChatOptions.h:96