AgoraChatSDK 1.2.0
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
 
AreaCode area
 
BOOL enableStatistics
 
BOOL loadEmptyConversations
 
NSInteger customOSType
 
NSString * customDeviceName
 
BOOL enableDnsConfig
 
int chatPort
 
NSString * chatServer
 
NSString * restServer
 
NSString * dnsURL
 

Detailed Description

The SDK options.

Method Documentation

◆ __deprecated_msg [1/6]

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

Whether to automatically accept friend requests.

  • YES: Yes.
  • (Default) NO: No.

◆ __deprecated_msg [2/6]

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

Whether to automatically accept group invitations.

  • (Default)YES: Yes.
  • NO: No.

◆ __deprecated_msg [3/6]

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

Whether to automatically download thumbnails of images and videos and voice messages.

  • (Default) YES: Yes.
  • NO: No.

◆ __deprecated_msg [4/6]

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

Whether to allow the chat room owner to leave the chat room.

  • (Default)YES: Yes.
  • NO: No.

◆ __deprecated_msg [5/6]

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

Whether to delete all the chat room messages when leaving the chat room.

  • (Default)YES: Yes.
  • NO: No.

◆ __deprecated_msg [6/6]

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

Whether to delete all the group messages when leaving the group.

  • (Default)YES: Yes.
  • NO: No.

Provided by category AgoraChatOptions(PrivateDeploy).

◆ optionsWithAppkey:

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

Gets an SDK options instance.

Parameters
aAppkeyThe App Key.
Returns
The SDK options instance.

Property Documentation

◆ apnsCertName

- (NSString*) apnsCertName
readwritenonatomiccopy

The certificate name of Apple Push Notification Service (APNs).

This attribute is specific to APNs.

This attribute can be set only when you call initializeSDKWithOptions. The attribute setting cannot be changed during app runtime.

◆ appkey

- (NSString*) appkey
readnonatomiccopy

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

◆ area

- (AreaCode) area
readwritenonatomicassign

The area code.

This attribute is used to restrict the scope of accessible edge nodes. The default value is AreaCodeGLOB.

This attribute can be set only when you call initializeSDKWithOptions. The attribute setting cannot be changed during the app runtime.

◆ autoAcceptFriendInvitation

- (BOOL) autoAcceptFriendInvitation
readwritenonatomicassign

Whether to automatically accept friend requests.

  • (Default) YES: Yes.
  • NO: No.

◆ autoAcceptGroupInvitation

- (BOOL) autoAcceptGroupInvitation
readwritenonatomicassign

Whether to automatically accept group invitations.

  • (Default) YES: Yes.
  • NO: No.

◆ autoDownloadThumbnail

- (BOOL) autoDownloadThumbnail
readwritenonatomicassign

Whether to automatically download thumbnails of images and videos and voice messages.

  • (Default) YES: Yes.
  • NO: No.

◆ canChatroomOwnerLeave

- (BOOL) canChatroomOwnerLeave
readwritenonatomicassign

Whether to allow the chat room owner to leave the room.

  • (Default) YES: Yes.
  • NO: No.

◆ 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).

◆ customDeviceName

- (NSString*) customDeviceName
readwriteatomicstrong

The custom device name.

This attribute can be set only when you call the initializeSDKWithOptions method. The attribute setting cannot be changed during the app runtime.

◆ customOSType

- (NSInteger) customOSType
readwritenonatomicassign

The custom system type.

This attribute can be set only when you call the initializeSDKWithOptions method. The attribute setting cannot be changed during app runtime.

◆ deleteMessagesOnLeaveChatroom

- (BOOL) deleteMessagesOnLeaveChatroom
readwritenonatomicassign

Whether to delete all the chat room messages when leaving the chat room.

  • (Default) YES: Yes.
  • NO: No.

◆ deleteMessagesOnLeaveGroup

- (BOOL) deleteMessagesOnLeaveGroup
readwritenonatomicassign

Whether to delete all the group messages when leaving the group.

  • (Default) YES: Yes.
  • NO: No.

◆ 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 the Console.

  • YES: Yes.
  • (Default) NO: No.

◆ enableDeliveryAck

- (BOOL) enableDeliveryAck
readwritenonatomicassign

Whether to send the message delivery receipt.

  • YES: Upon the reception of a one-to-one message, the SDK automatically sends a delivery receipt.
  • NO: No.

◆ 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 the FPA feature.

  • YES: Yes.
  • (Default) NO: No.

◆ enableRequireReadAck

- (BOOL) enableRequireReadAck
readwritenonatomicassign

Whether to receive the message read receipt.

  • (Default) YES: Yes.
  • NO: No.

◆ enableStatistics

- (BOOL) enableStatistics
readwritenonatomicassign

Whether to enable message statistics.

  • YES: Yes.
  • (Default) NO: No.

This attribute can be set only when you call initializeSDKWithOptions. The attribute setting cannot be changed during the app runtime.

◆ isAutoLogin

- (BOOL) isAutoLogin
readwritenonatomicassign

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

  • (Default) YES: Yes.
  • NO: No.

You need to set this parameter before the SDK is initialized; otherwise, the setting does not take effect.

◆ isAutoTransferMessageAttachments

- (BOOL) isAutoTransferMessageAttachments
readwritenonatomicassign

Whether to automatically upload or download the attachment in the message.

  • (Default) YES: Yes.
  • NO: No.

◆ loadEmptyConversations

- (BOOL) loadEmptyConversations
readwritenonatomicassign

Whether to include empty conversations when the SDK loads conversations from the local database:

  • YES: Empty conversations are included.

(Default) NO: Empty conversations are excluded.

This attribute can be set only when you call the initializeSDKWithOptions method. The attribute setting cannot be changed during app runtime.

◆ logLevel

- (AgoraChatLogLevel) logLevel
readwritenonatomicassign

The log level.

  • AgoraChatLogLevelDebug: All logs;
  • AgoraChatLogLevelWarning: Warnings and errors.
  • AgoraChatLogLevelError: Errors.

◆ pushKitCertName

- (NSString*) pushKitCertName
readwritenonatomiccopy

The certificate name of Apple PushKit Service.

This attribute is specific to Apple PushKit Service.

This attribute can be set only when you call initializeSDKWithOptions. The attribute setting cannot be changed during app runtime.

◆ 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 the server's reception time when loading messages from the database.

  • (Default) YES: Yes. Messages are sorted by the time when the server receives them.
  • NO: No.

◆ usingHttpsOnly

- (BOOL) usingHttpsOnly
readwritenonatomicassign

Whether to only use the HTTPS protocol.

  • YES: Yes.
  • (Default) NO: No.
The documentation for this class was generated from the following file:
Generated by doxygen 1.9.4