#import <AgoraChatOptions.h>

类 AgoraChatOptions 继承关系图:

类方法
(instancetype _Nonnull)	+ optionsWithAppkey:

(instancetype _Nonnull)	+ optionsWithAppId:

属性
NSString *	appkey

NSString *	appId

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

NSString *	apnsCertName

NSString *	pushKitCertName

AreaCode	area

BOOL	enableStatistics

BOOL	loadEmptyConversations

NSInteger	customOSType

NSString *	customDeviceName

BOOL	useReplacedMessageContents

BOOL	includeSendMessageInMessageListener

BOOL	regardImportMessagesAsRead

BOOL	autoLoadConversations

NSString *	loginExtensionInfo

BOOL	workPathCopiable

BOOL	enableDnsConfig

int	chatPort

NSString *	chatServer

NSString *	restServer

BOOL	enableTLSConnection

NSString *	dnsURL

详细描述

The SDK options.

函数文档

◆ optionsWithAppId:

+ (instancetype _Nonnull) optionsWithAppId: (NSString *_Nonnull) appId

Gets an SDK options instance.

参数

appId The App Id.

返回: The SDK options instance.

◆ optionsWithAppkey:

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

Gets an SDK options instance.

参数

aAppkey The App Key.

返回: 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.

◆ appId

- (NSString*) appId

readnonatomiccopy

The appId, which is the unique identifier of the project.

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

◆ 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

- (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.

由 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.

由 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.

由 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.

由 category AgoraChatOptions(PrivateDeploy) 提供.

◆ 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

由 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

- (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

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

- (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

由 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.

◆ 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

- (BOOL) usingHttpsOnly

readwritenonatomicassign

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.

该类的文档由以下文件生成:

AgoraChat.framework/Headers/AgoraChatOptions.h

类方法

属性

详细描述

函数文档

◆ optionsWithAppId:

◆ optionsWithAppkey:

属性说明

◆ apnsCertName

◆ appId

◆ appkey

◆ area

◆ autoAcceptFriendInvitation

◆ autoAcceptGroupInvitation

◆ autoDownloadThumbnail

◆ autoLoadConversations

◆ canChatroomOwnerLeave

◆ chatPort

◆ chatServer

◆ customDeviceName

◆ customOSType

◆ deleteMessagesOnLeaveChatroom

◆ deleteMessagesOnLeaveGroup

◆ dnsURL

◆ enableConsoleLog

◆ enableDeliveryAck

◆ enableDnsConfig

◆ enableRequireReadAck

◆ enableStatistics

◆ enableTLSConnection

◆ includeSendMessageInMessageListener

◆ isAutoLogin

◆ isAutoTransferMessageAttachments

◆ loadEmptyConversations

◆ loginExtensionInfo

◆ logLevel

◆ pushKitCertName

◆ regardImportMessagesAsRead

◆ restServer

◆ sortMessageByServerTime

◆ useReplacedMessageContents

◆ usingHttpsOnly

◆ workPathCopiable