AgoraChatSDK 1.14.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
39typedef NS_ENUM(NSUInteger, EMSDKPlatform) {
41 EMSDKPlatformNative = 0,
43 EMSDKPlatformFlutter = 1,
45 EMSDKPlatformReactNative = 2,
47 EMSDKPlatformUnity = 3,
48};
49
54@interface AgoraChatOptions : NSObject
55
60@property(nonatomic, copy, readonly) NSString *appkey;
61
66@property(nonatomic, copy, readonly) NSString *appId;
67
74@property(nonatomic, assign) BOOL enableConsoleLog;
75
83@property(nonatomic, assign) AgoraChatLogLevel logLevel;
84
91@property(nonatomic, assign) BOOL usingHttpsOnly;
92
101@property(nonatomic, assign) BOOL isAutoLogin;
102
109@property(nonatomic, assign) BOOL deleteMessagesOnLeaveGroup;
110
117@property(nonatomic, assign) BOOL deleteMessagesOnLeaveChatroom;
118
125@property(nonatomic, assign) BOOL canChatroomOwnerLeave;
126
133@property(nonatomic, assign) BOOL autoAcceptGroupInvitation;
134
141@property(nonatomic, assign) BOOL autoAcceptFriendInvitation;
142
149@property(nonatomic, assign) BOOL autoDownloadThumbnail;
150
157@property(nonatomic, assign) BOOL enableRequireReadAck;
165@property(nonatomic, assign) BOOL enableDeliveryAck;
166
174@property(nonatomic, assign) BOOL sortMessageByServerTime;
175
182@property(nonatomic, assign) BOOL isAutoTransferMessageAttachments;
183
192@property(nonatomic, copy) NSString *apnsCertName;
193
202@property(nonatomic, copy) NSString *pushKitCertName;
203
212@property(nonatomic) AreaCode area;
213
222@property(nonatomic) BOOL enableStatistics;
223
232@property(nonatomic) BOOL loadEmptyConversations;
233
240@property(nonatomic) NSInteger customOSType;
241
248@property(strong) NSString* customDeviceName;
249
260@property(nonatomic) BOOL useReplacedMessageContents;
261
270@property(nonatomic) BOOL includeSendMessageInMessageListener;
271
279@property(nonatomic) BOOL regardImportMessagesAsRead;
280
288@property(nonatomic) BOOL autoLoadConversations;
289
294@property (nonatomic) NSString * loginExtensionInfo;
295
302@property (nonatomic) BOOL workPathCopiable;
303
309@property (nonatomic, copy) NSString* uiKitVersion;
310
316@property (nonatomic) EMSDKPlatform platform;
317
318@property (nonatomic) BOOL useAgoraChatDomain;
319
328+ (instancetype _Nonnull)optionsWithAppkey:(NSString * _Nonnull)aAppkey;
329
338+ (instancetype _Nonnull)optionsWithAppId:(NSString* _Nonnull)appId;
339@end
Definition: AgoraChatOptions.h:55
BOOL autoAcceptGroupInvitation
Definition: AgoraChatOptions.h:133
BOOL usingHttpsOnly
Definition: AgoraChatOptions.h:91
BOOL enableConsoleLog
Definition: AgoraChatOptions.h:74
BOOL isAutoLogin
Definition: AgoraChatOptions.h:101
BOOL enableStatistics
Definition: AgoraChatOptions.h:222
AreaCode area
Definition: AgoraChatOptions.h:212
BOOL deleteMessagesOnLeaveGroup
Definition: AgoraChatOptions.h:109
NSString * uiKitVersion
Definition: AgoraChatOptions.h:309
NSString * loginExtensionInfo
Definition: AgoraChatOptions.h:294
BOOL enableDeliveryAck
Definition: AgoraChatOptions.h:165
BOOL canChatroomOwnerLeave
Definition: AgoraChatOptions.h:125
BOOL workPathCopiable
Definition: AgoraChatOptions.h:302
BOOL enableRequireReadAck
Definition: AgoraChatOptions.h:157
BOOL autoDownloadThumbnail
Definition: AgoraChatOptions.h:149
NSString * apnsCertName
Definition: AgoraChatOptions.h:192
BOOL autoLoadConversations
Definition: AgoraChatOptions.h:288
NSString * pushKitCertName
Definition: AgoraChatOptions.h:202
BOOL includeSendMessageInMessageListener
Definition: AgoraChatOptions.h:270
BOOL autoAcceptFriendInvitation
Definition: AgoraChatOptions.h:141
NSString * appId
Definition: AgoraChatOptions.h:66
BOOL useReplacedMessageContents
Definition: AgoraChatOptions.h:260
BOOL isAutoTransferMessageAttachments
Definition: AgoraChatOptions.h:182
AgoraChatLogLevel logLevel
Definition: AgoraChatOptions.h:83
EMSDKPlatform platform
Definition: AgoraChatOptions.h:316
NSString * customDeviceName
Definition: AgoraChatOptions.h:248
NSInteger customOSType
Definition: AgoraChatOptions.h:240
BOOL loadEmptyConversations
Definition: AgoraChatOptions.h:232
NSString * appkey
Definition: AgoraChatOptions.h:60
BOOL sortMessageByServerTime
Definition: AgoraChatOptions.h:174
BOOL deleteMessagesOnLeaveChatroom
Definition: AgoraChatOptions.h:117
BOOL regardImportMessagesAsRead
Definition: AgoraChatOptions.h:279