AgoraChatSDK 1.3.1
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
171@property(nonatomic, copy) NSString *apnsCertName;
172
181@property(nonatomic, copy) NSString *pushKitCertName;
182
191@property(nonatomic) AreaCode area;
192
201@property(nonatomic) BOOL enableStatistics;
202
211@property(nonatomic) BOOL loadEmptyConversations;
212
219@property(nonatomic) NSInteger customOSType;
220
227@property(strong) NSString* customDeviceName;
228
239@property(nonatomic) BOOL useReplacedMessageContents;
240
249@property(nonatomic) BOOL includeSendMessageInMessageListener;
250
258@property(nonatomic) BOOL regardImportMessagesAsRead;
259
267@property(nonatomic) BOOL autoLoadConversations;
268
273@property (nonatomic) NSString * loginExtensionInfo;
274
281@property (nonatomic) BOOL workPathCopiable;
282
291+ (instancetype _Nonnull)optionsWithAppkey:(NSString * _Nonnull)aAppkey;
292
293#pragma mark - EM_DEPRECATED_IOS 3.8.8
300@property(nonatomic, assign) BOOL isDeleteMessagesWhenExitGroup __deprecated_msg("Use deleteMessagesOnLeaveGroup instead");
301
308@property(nonatomic, assign) BOOL isDeleteMessagesWhenExitChatRoom
309 __deprecated_msg("Use deleteMessagesOnLeaveChatroom instead");
310
317@property(nonatomic, assign) BOOL isChatroomOwnerLeaveAllowed
318 __deprecated_msg("Use canChatroomOwnerLeave instead");
319
326@property(nonatomic, assign) BOOL isAutoAcceptGroupInvitation
327 __deprecated_msg("Use autoAcceptGroupInvitation instead");
328
335@property(nonatomic, assign) BOOL isAutoAcceptFriendInvitation
336 __deprecated_msg("Use autoAcceptFriendInvitation instead");
337
344@property(nonatomic, assign) BOOL isAutoDownloadThumbnail
345 __deprecated_msg("Use autoDownloadThumbnail instead");
346
347@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:201
BOOL isDeleteMessagesWhenExitGroup __deprecated_msg("Use deleteMessagesOnLeaveGroup instead")
AreaCode area
Definition: AgoraChatOptions.h:191
BOOL deleteMessagesOnLeaveGroup
Definition: AgoraChatOptions.h:88
NSString * loginExtensionInfo
Definition: AgoraChatOptions.h:273
BOOL enableDeliveryAck
Definition: AgoraChatOptions.h:144
BOOL canChatroomOwnerLeave
Definition: AgoraChatOptions.h:104
BOOL workPathCopiable
Definition: AgoraChatOptions.h:281
BOOL isAutoDownloadThumbnail __deprecated_msg("Use autoDownloadThumbnail instead")
BOOL enableRequireReadAck
Definition: AgoraChatOptions.h:136
BOOL autoDownloadThumbnail
Definition: AgoraChatOptions.h:128
NSString * apnsCertName
Definition: AgoraChatOptions.h:171
BOOL isChatroomOwnerLeaveAllowed __deprecated_msg("Use canChatroomOwnerLeave instead")
BOOL isDeleteMessagesWhenExitChatRoom __deprecated_msg("Use deleteMessagesOnLeaveChatroom instead")
BOOL autoLoadConversations
Definition: AgoraChatOptions.h:267
NSString * pushKitCertName
Definition: AgoraChatOptions.h:181
BOOL includeSendMessageInMessageListener
Definition: AgoraChatOptions.h:249
BOOL autoAcceptFriendInvitation
Definition: AgoraChatOptions.h:120
BOOL isAutoAcceptFriendInvitation __deprecated_msg("Use autoAcceptFriendInvitation instead")
BOOL useReplacedMessageContents
Definition: AgoraChatOptions.h:239
BOOL isAutoTransferMessageAttachments
Definition: AgoraChatOptions.h:161
AgoraChatLogLevel logLevel
Definition: AgoraChatOptions.h:62
BOOL isAutoAcceptGroupInvitation __deprecated_msg("Use autoAcceptGroupInvitation instead")
NSString * customDeviceName
Definition: AgoraChatOptions.h:227
NSInteger customOSType
Definition: AgoraChatOptions.h:219
BOOL loadEmptyConversations
Definition: AgoraChatOptions.h:211
NSString * appkey
Definition: AgoraChatOptions.h:45
BOOL sortMessageByServerTime
Definition: AgoraChatOptions.h:153
BOOL deleteMessagesOnLeaveChatroom
Definition: AgoraChatOptions.h:96
BOOL regardImportMessagesAsRead
Definition: AgoraChatOptions.h:258