#import <AgoraChatOptions.h>
◆ __deprecated_msg [1/6]
Whether to automatically accept friend requests.
YES
: Yes.
- (Default)
NO
: No.
◆ __deprecated_msg [2/6]
Whether to automatically accept group invitations.
- (Default)
YES
: Yes.
NO
: No.
◆ __deprecated_msg [3/6]
Whether to automatically download thumbnails of images and videos and voice messages.
- (Default)
YES
: Yes.
NO
: No.
◆ __deprecated_msg [4/6]
Whether to allow the chat room owner to leave the chat room.
- (Default)
YES
: Yes.
NO
: No.
◆ __deprecated_msg [5/6]
Whether to delete all the chat room messages when leaving the chat room.
- (Default)
YES
: Yes.
NO
: No.
◆ __deprecated_msg [6/6]
◆ optionsWithAppkey:
+ (instancetype _Nonnull) optionsWithAppkey: |
|
(NSString *_Nonnull) |
aAppkey |
|
Gets an SDK options instance.
- Parameters
-
- Returns
- The SDK options instance.
◆ 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
The app key, which is the unique identifier of the project.
◆ area
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.
◆ autoLoadConversations
- (BOOL) autoLoadConversations |
|
readwritenonatomicassign |
Whether to automatically load the conversation list:
- YES:Automatically load.
- (Default) YES:Automatically load.
◆ canChatroomOwnerLeave
- (BOOL) canChatroomOwnerLeave |
|
readwritenonatomicassign |
Whether to allow the chat room owner to leave the room.
- (Default)
YES
: Yes.
NO
: No.
◆ chatPort
◆ chatServer
◆ 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
◆ 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
◆ 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.
◆ enableTLSConnection
- (BOOL) enableTLSConnection |
|
readwritenonatomicassign |
Whether to enable TLS encryption when connecting to chatServer.The default value is NO.
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).
◆ includeSendMessageInMessageListener
- (BOOL) includeSendMessageInMessageListener |
|
readwritenonatomicassign |
Whether the sent message is included in ChatManagerDelegate#messagesDidReceive
.
- YES:Yes. Besides the received message, the sent message is also included in
ChatManagerDelegate#messagesDidReceive
.
- (Default) NO:No. Only the received message is included in
ChatManagerDelegate#messagesDidReceive
.
◆ isAutoLogin
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
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.
◆ loginExtensionInfo
- (NSString*) loginExtensionInfo |
|
readwritenonatomicassign |
The extended information carried during login can be a JSON string. The current string length is limited to 1024 characters.
◆ 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.
◆ regardImportMessagesAsRead
- (BOOL) regardImportMessagesAsRead |
|
readwritenonatomicassign |
Whether to set messages from the server side as read:
- YES:Read. After the messages are imported, the number of unread messages specified with
AgoraChatConversation#unreadMessagesCount
remains unchanged.
- (Default) NO:Unread. After the messages are imported, the value of
AgoraChatConversation#unreadMessagesCount
is increased.
◆ restServer
◆ 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.
◆ useReplacedMessageContents
- (BOOL) useReplacedMessageContents |
|
readwritenonatomicassign |
Whether the server returns the sender the text message with the content replaced during text moderation:
- YES:Return the adjusted message to the sender.
- (Default) NO:Return the original message to the sender.
This attribute can be set only with the initializeSDKWithOptions
method. The attribute setting cannot be changed during the app runtime.
◆ usingHttpsOnly
Whether to only use the HTTPS protocol.
YES
: Yes.
- (Default)
NO
: No.
◆ workPathCopiable
- (BOOL) workPathCopiable |
|
readwritenonatomicassign |
Whether the SDK work path is copiable.
- YES:Copiable.
- (Default)NO:Uncopiable.
The documentation for this class was generated from the following file: