AgoraOptions Class Reference

#import <AgoraOptions.h>

Inheritance diagram for AgoraOptions:

Instance Methods
(BOOL isSandboxMode)	- EM_DEPRECATED_IOS
(BOOL usingHttps)	- EM_DEPRECATED_IOS

Class Methods
(instancetype)	+ optionsWithAppkey:

Properties
NSString *	appkey
BOOL	enableConsoleLog
AgoraLogLevel	logLevel
BOOL	usingHttpsOnly
BOOL	isAutoLogin
BOOL	isDeleteMessagesWhenExitGroup
BOOL	isDeleteMessagesWhenExitChatRoom
BOOL	isChatroomOwnerLeaveAllowed
BOOL	isAutoAcceptGroupInvitation
BOOL	isAutoAcceptFriendInvitation
BOOL	isAutoDownloadThumbnail
BOOL	enableRequireReadAck
BOOL	enableDeliveryAck
BOOL	sortMessageByServerTime
BOOL	isAutoTransferMessageAttachments
NSString *	apnsCertName
NSString *	pushKitCertName
BOOL	enableDnsConfig
int	chatPort
NSString *	chatServer
NSString *	restServer
NSString *	dnsURL
NSDictionary *	extension

Detailed Description

SDK setting options

Method Documentation

- (BOOL isSandboxMode) EM_DEPRECATED_IOS		(3_0_0)
		(3_2_2)

Whether using development environment, default is NO

Can only be set when initializing the sdk with [AgoraChatClient initializeSDKWithOptions:], can't be altered in runtime.

- (BOOL usingHttps) EM_DEPRECATED_IOS		(3_0_0)
		(3_2_1)

Whether using https, default is YES

+ (instancetype) optionsWithAppkey:

(NSString *)

aAppkey

Get a SDK setting options instance

Parameters

aAppkey

App‘s unique identifier

Returns

SDK’s setting options instance

Property Documentation

- (NSString*) apnsCertName

readwritenonatomiccopy

Certificate name of Apple Push Notification Service

Can only be set when initializing the SDK with [AgoraChatClient initializeSDKWithOptions:], can't be altered in runtime.

- (NSString*) appkey

readnonatomiccopy

Application's unique identifier

- (int) chatPort

readwritenonatomicassign

IM server port

chatPort is Only effective when isDNSEnabled is NO. Can only be set when initializing the SDK with [AgoraChatClient initializeSDKWithOptions:], cannot be altered in runtime

Provided by category AgoraOptions(PrivateDeploy).

- (NSString*) chatServer

readwritenonatomiccopy

IM server

chatServer is Only effective when isDNSEnabled is NO. Can only be set when initializing the SDK with [AgoraChatClient initializeSDKWithOptions:], cannot be altered in runtime

Provided by category AgoraOptions(PrivateDeploy).

- (NSString*) dnsURL

readwritenonatomiccopy

DNS url

dnsURL Only effective when isDNSEnabled is YES. Can only be set when initializing the SDK with [AgoraChatClient initializeSDKWithOptions:], cannot be altered in runtime

Provided by category AgoraOptions(PrivateDeploy).

- (BOOL) enableConsoleLog

readwritenonatomicassign

Whether print log to console, default is NO

- (BOOL) enableDeliveryAck

readwritenonatomicassign

Whether to send delivery acknowledgement, default is NO. If set to YES, SDK will automatically send a delivery acknowledgement when receiving a chat message

- (BOOL) enableDnsConfig

readwritenonatomicassign

Whether to allow using DNS, default is YES

Can only be set when initializing the SDK [AgoraChatClient initializeSDKWithOptions:], cannot be altered in runtime

Provided by category AgoraOptions(PrivateDeploy).

- (BOOL) enableRequireReadAck

readwritenonatomicassign

whether receive message read by receiving user event

- (NSDictionary*) extension

readwritenonatomicstrong

Options extension

Provided by category AgoraOptions(PrivateDeploy).

- (BOOL) isAutoAcceptFriendInvitation

readwritenonatomicassign

Whether to automatically approve friend request, default is NO

- (BOOL) isAutoAcceptGroupInvitation

readwritenonatomicassign

Whether to automatically accept group invitation, default is YES

- (BOOL) isAutoDownloadThumbnail

readwritenonatomicassign

Whether to automatically download thumbnail of image&video and audio, default is YES

- (BOOL) isAutoLogin

readwritenonatomicassign

Whether auto login, default is YES

The Settings are only valid before the SDK is initialized.

- (BOOL) isAutoTransferMessageAttachments

readwritenonatomicassign

Whether to automatically upload or download the attachment in the message, default is YES.

- (BOOL) isChatroomOwnerLeaveAllowed

readwritenonatomicassign

if allow chat room's owner can leave the chat room, default is YES.

- (BOOL) isDeleteMessagesWhenExitChatRoom

readwritenonatomicassign

Whether to delete all the chat room messages when leaving the chat room, default is YES

- (BOOL) isDeleteMessagesWhenExitGroup

readwritenonatomicassign

Whether to delete all the group messages when leaving the group, default is YES

- (AgoraLogLevel) logLevel

readwritenonatomicassign

Log output level, default is AgoraLogLevelDebug

- (NSString*) pushKitCertName

readwritenonatomiccopy

Certificate name of Apple PushKit Service

Can only be set when initializing the SDK with [AgoraChatClient initializeSDKWithOptions:], can't be altered in runtime.

- (NSString*) restServer

readwritenonatomiccopy

REST server

restServer Only effective when isDNSEnabled is NO. Can only be set when initializing the SDK with [AgoraChatClient initializeSDKWithOptions:], cannot be altered in runtime

Provided by category AgoraOptions(PrivateDeploy).

- (BOOL) sortMessageByServerTime

readwritenonatomicassign

Whether to sort messages by server received time when loading message from database, default is YES.

- (BOOL) usingHttpsOnly

readwritenonatomicassign

Whether using https only, default is NO

---

The documentation for this class was generated from the following file:

• AgoraChat.framework/Headers/AgoraOptions.h