AgoraChatSDK 1.0.7
Instance Methods | Class Methods | Properties | List of all members
AgoraChatOptions Class Reference

#import <AgoraChatOptions.h>

Inheritance diagram for AgoraChatOptions:

Instance Methods

(BOOL isDeleteMessagesWhenExitGroup) - __deprecated_msg
 
(BOOL isDeleteMessagesWhenExitChatRoom) - __deprecated_msg
 
(BOOL isChatroomOwnerLeaveAllowed) - __deprecated_msg
 
(BOOL isAutoAcceptGroupInvitation) - __deprecated_msg
 
(BOOL isAutoAcceptFriendInvitation) - __deprecated_msg
 
(BOOL isAutoDownloadThumbnail) - __deprecated_msg
 

Class Methods

(instancetype _Nonnull) + optionsWithAppkey:
 

Properties

NSString * appkey
 
BOOL enableConsoleLog
 
AgoraChatLogLevel logLevel
 
BOOL usingHttpsOnly
 
BOOL isAutoLogin
 
BOOL deleteMessagesOnLeaveGroup
 
BOOL deleteMessagesOnLeaveChatroom
 
BOOL canChatroomOwnerLeave
 
BOOL autoAcceptGroupInvitation
 
BOOL autoAcceptFriendInvitation
 
BOOL autoDownloadThumbnail
 
BOOL enableRequireReadAck
 
BOOL enableDeliveryAck
 
BOOL sortMessageByServerTime
 
BOOL isAutoTransferMessageAttachments
 
BOOL enableFpa
 
NSString * apnsCertName
 
NSString * pushKitCertName
 
BOOL enableDnsConfig
 
int chatPort
 
NSString * chatServer
 
NSString * restServer
 
NSString * dnsURL
 

Detailed Description

The SDK setting options.

Method Documentation

◆ __deprecated_msg [1/6]

- (BOOL isAutoAcceptFriendInvitation) __deprecated_msg ("Use autoAcceptFriendInvitation instead") 

Whether to automatically approve friend request. The default value is NO.

◆ __deprecated_msg [2/6]

- (BOOL isAutoAcceptGroupInvitation) __deprecated_msg ("Use autoAcceptGroupInvitation instead") 

Whether to automatically accept group invitation. The default value is YES.

◆ __deprecated_msg [3/6]

- (BOOL isAutoDownloadThumbnail) __deprecated_msg ("Use autoDownloadThumbnail instead") 

Whether to automatically download thumbnail of image&video and audio. The default value is YES.

◆ __deprecated_msg [4/6]

- (BOOL isChatroomOwnerLeaveAllowed) __deprecated_msg ("Use canChatroomOwnerLeave instead") 

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

◆ __deprecated_msg [5/6]

- (BOOL isDeleteMessagesWhenExitChatRoom) __deprecated_msg ("Use deleteMessagesOnLeaveChatroom instead") 

Whether to delete all the chat room messages when leaving the chat room. The default value is YES.

◆ __deprecated_msg [6/6]

- (BOOL isDeleteMessagesWhenExitGroup) __deprecated_msg ("Use deleteMessagesOnLeaveGroup instead") 

Whether to delete all the group messages when leaving the group. The default value is YES.

Provided by category AgoraChatOptions(PrivateDeploy).

◆ optionsWithAppkey:

+ (instancetype _Nonnull) optionsWithAppkey: (NSString *_Nonnull)  aAppkey

Gets a SDK setting options instance.

Parameters
aAppkeyThe app key.
Returns
The SDK setting options instance.

Property Documentation

◆ apnsCertName

- (NSString*) apnsCertName
readwritenonatomiccopy

The certificate name of Apple Push Notification Service.

Ensure that you set this parameter when calling initializeSDKWithOptions. During the app runtime, you can not change the settings.

◆ appkey

- (NSString*) appkey
readnonatomiccopy

The app key, which is the unique identifier of the project.

◆ autoAcceptFriendInvitation

- (BOOL) autoAcceptFriendInvitation
readwritenonatomicassign

Whether to automatically approve contact request. The default value is NO.

◆ autoAcceptGroupInvitation

- (BOOL) autoAcceptGroupInvitation
readwritenonatomicassign

Whether to automatically accept group invitation. The default value is YES.

◆ autoDownloadThumbnail

- (BOOL) autoDownloadThumbnail
readwritenonatomicassign

Whether to automatically download image or video thumbnails and voice messages. The default value is YES.

◆ canChatroomOwnerLeave

- (BOOL) canChatroomOwnerLeave
readwritenonatomicassign

Whether to allow the chatroom owner leave the room. The default value is YES.

◆ chatPort

- (int) chatPort
readwritenonatomicassign

The chat server port.

This property is effective only when enableDnsConfig is NO. Can only be set when initializing the SDK with initializeSDKWithOptions: , cannot be altered in runtime.

Provided by category AgoraChatOptions(PrivateDeploy).

◆ chatServer

- (NSString*) chatServer
readwritenonatomiccopy

The chat server.

This property is effective only when enableDnsConfig is NO. Can only be set when initializing the SDK with initializeSDKWithOptions: , cannot be altered in runtime.

Provided by category AgoraChatOptions(PrivateDeploy).

◆ deleteMessagesOnLeaveChatroom

- (BOOL) deleteMessagesOnLeaveChatroom
readwritenonatomicassign

Whether to delete all the chat room messages when leaving the chat room. The default value is YES.

◆ deleteMessagesOnLeaveGroup

- (BOOL) deleteMessagesOnLeaveGroup
readwritenonatomicassign

Whether to delete all the group messages when leaving the group. The default value is YES.

◆ dnsURL

- (NSString*) dnsURL
readwritenonatomiccopy

The DNS url.

This property is effective only when enableDnsConfig is YES. Can only be set when initializing the SDK with initializeSDKWithOptions: , cannot be altered in runtime.

Provided by category AgoraChatOptions(PrivateDeploy).

◆ enableConsoleLog

- (BOOL) enableConsoleLog
readwritenonatomicassign

Whether to print logs on Console. The default value is NO.

◆ enableDeliveryAck

- (BOOL) enableDeliveryAck
readwritenonatomicassign

Whether to send the message delivery receipt. The default value is NO. If you set it to YES, the SDK automatically send a delivery receipt when you receive a chat message.

◆ enableDnsConfig

- (BOOL) enableDnsConfig
readwritenonatomicassign

Whether to allow using DNS. The default value is YES.

Can only be set when initializing the SDK initializeSDKWithOptions: , cannot be altered in runtime.

Provided by category AgoraChatOptions(PrivateDeploy).

◆ enableFpa

- (BOOL) enableFpa
readwritenonatomicassign

Whether to enable fpa feature. The default value is NO.

◆ enableRequireReadAck

- (BOOL) enableRequireReadAck
readwritenonatomicassign

Whether need to receive the message read receipt. The default value is YES.

◆ isAutoLogin

- (BOOL) isAutoLogin
readwritenonatomicassign

Whether to enable automatic login. The default value is YES.

You need to set this parameter before the SDK is initialized.

◆ isAutoTransferMessageAttachments

- (BOOL) isAutoTransferMessageAttachments
readwritenonatomicassign

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

◆ logLevel

- (AgoraChatLogLevel) logLevel
readwritenonatomicassign

The log output level. The default value is AgoraChatLogLevelDebug, which means all log levels.

◆ pushKitCertName

- (NSString*) pushKitCertName
readwritenonatomiccopy

The certificate name of Apple PushKit Service.

Ensure that you set this parameter when calling initializeSDKWithOptions. During the app runtime, you can not change the settings.

◆ restServer

- (NSString*) restServer
readwritenonatomiccopy

The REST server.

This property is effective only when enableDnsConfig is NO. Can only be set when initializing the SDK with initializeSDKWithOptions: , cannot be altered in runtime

Provided by category AgoraChatOptions(PrivateDeploy).

◆ sortMessageByServerTime

- (BOOL) sortMessageByServerTime
readwritenonatomicassign

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

◆ usingHttpsOnly

- (BOOL) usingHttpsOnly
readwritenonatomicassign

Whether to only use the HTTPS protocol. The default value is NO.


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