EMOptions类 参考

#import <EMOptions.h>

类 EMOptions 继承关系图:

类方法
(instancetype _Nonnull)	+ optionsWithAppkey:
(instancetype _Nonnull)	+ optionsWithAppId:

属性
NSString *	appkey
NSString *	appId
BOOL	enableConsoleLog
EMLogLevel	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
NSString *	uiKitVersion
EMSDKPlatform	platform
NSInteger	dohVendor
BOOL	enableDnsConfig
int	chatPort
NSString *	chatServer
NSString *	restServer
BOOL	enableTLSConnection
NSString *	dnsURL
NSString *_Nullable	webSocketServer
int	webSocketPort

详细描述

SDK 的设置选项。

函数文档

+ (instancetype _Nonnull) optionsWithAppId:

(NSString *_Nonnull)

appId

获取 SDK 选项实例。

参数

appId

App Id。

返回

SDK 设置项实例。

+ (instancetype _Nonnull) optionsWithAppkey:

(NSString *_Nonnull)

aAppkey

获取 SDK 选项实例。

参数

aAppkey

App key。

返回

SDK 设置项实例。

属性说明

- (NSString*) apnsCertName

readwritenonatomiccopy

iOS 特有属性，APNs 推送证书的名称。

该参数只能在调用 initializeSDKWithOptions 时设置，且 app 运行过程中不可以修改。

- (NSString*) appId

readnonatomiccopy

appId，是项目的唯一标识。

- (NSString*) appkey

readnonatomiccopy

app key，是项目的唯一标识。

- (AreaCode) area

readwritenonatomicassign

区域代号。

该属性用于限制连接边缘节点的范围，默认为 AreaCodeGLOB。

该参数只能在调用 initializeSDKWithOptions 时设置，且 app 运行过程中不能修改。

- (BOOL) autoAcceptFriendInvitation

readwritenonatomicassign

是否自动同意好友邀请。

• （默认）YES：是；
• NO：否。

- (BOOL) autoAcceptGroupInvitation

readwritenonatomicassign

是否自动接受群邀请。

• （默认）YES：是；
• NO：否。

- (BOOL) autoDownloadThumbnail

readwritenonatomicassign

是否自动下载图片和视频的缩略图及语音消息。

• （默认）YES：是；
• NO：否。

- (BOOL) autoLoadConversations

readwritenonatomicassign

是否自动加载会话列表：

• YES：自动加载。
• （默认）YES：自动加载。

- (BOOL) canChatroomOwnerLeave

readwritenonatomicassign

是否允许聊天室所有者离开。

• （默认）YES：是；
• NO：否。

- (int) chatPort

readwritenonatomicassign

Chat 服务器端口。

enableDnsConfig 为 NO 时有效。只能在 initializeSDKWithOptions: 中设置，不能在程序运行过程中动态修改。

由 category EMOptions(PrivateDeploy) 提供.

- (NSString*) chatServer

readwritenonatomiccopy

The chat 服务器地址。

enableDnsConfig 为 NO 时生效。只能在 initializeSDKWithOptions: 中设置，不能在程序运行过程中动态修改。

由 category EMOptions(PrivateDeploy) 提供.

- (NSString*) customDeviceName

readwriteatomicstrong

自定义设备名称。

该属性只能在调用 initializeSDKWithOptions 时设置，而且 app 运行过程中不能修改该参数的设置。

- (NSInteger) customOSType

readwritenonatomicassign

自定义系统类型。

该属性只能在调用 initializeSDKWithOptions 时设置，而且 app 运行过程中不能修改该参数的设置。

- (BOOL) deleteMessagesOnLeaveChatroom

readwritenonatomicassign

离开聊天室时是否删除所有消息。

• （默认）YES：是；
• NO：否。

- (BOOL) deleteMessagesOnLeaveGroup

readwritenonatomicassign

离开群组时是否删除该群所有消息。

• （默认）YES：是；
• NO：否。

- (NSString*) dnsURL

readwritenonatomiccopy

DNS URL 地址。

enableDnsConfig为YES时生效，只能在 initializeSDKWithOptions: 中设置，不能在程序运行过程中动态修改。

由 category EMOptions(PrivateDeploy) 提供.

- (BOOL) enableConsoleLog

readwritenonatomicassign

控制台是否输出日志。

• YES：是；
• （默认）NO：否。

- (BOOL) enableDeliveryAck

readwritenonatomicassign

是否发送消息送达回执：

• YES：SDK 收到单聊消息时会自动发送送达回执；
• （默认）NO：否。

- (BOOL) enableDnsConfig

readwritenonatomicassign

是否允许使用 DNS, 默认为 YES。

只能在 initializeSDKWithOptions: 中设置，不能在程序运行过程中动态修改。

由 category EMOptions(PrivateDeploy) 提供.

- (BOOL) enableRequireReadAck

readwritenonatomicassign

是否需要接收已读回执。

• （默认）YES：是；
• NO：否。

- (BOOL) enableStatistics

readwritenonatomicassign

是否开启消息流量统计。

• YES：开启；
• （默认）NO: 关闭。

该参数只能在调用 initializeSDKWithOptions 时设置，且 app 运行过程中不能修改。

- (BOOL) enableTLSConnection

readwritenonatomicassign

连接chatServer时，是否启用TLS加密，同时控制webSocketServer和chatServer。默认为NO。

enableDnsConfig 为 NO 时生效。只能在 initializeSDKWithOptions: 中设置，不能在程序运行过程中动态修改。

由 category EMOptions(PrivateDeploy) 提供.

- (BOOL) includeSendMessageInMessageListener

readwritenonatomicassign

发送成功的消息是否在 ChatManagerDelegate::messagesDidReceive 中回调。

• YES：是。
• （默认）NO：否。

- (BOOL) isAutoLogin

readwritenonatomicassign

是否自动登录。

• （默认）YES：是；
• NO：否。

该参数需要在 SDK 初始化前设置，否则不生效。

- (BOOL) isAutoTransferMessageAttachments

readwritenonatomicassign

是否自动上传或者下载消息中的附件。

• （默认）YES：是；
• NO：否。

- (BOOL) loadEmptyConversations

readwritenonatomicassign

加载会话时是否包括空会话。

• YES：包含。

（默认）NO：不包含。

该属性只能在调用 initializeSDKWithOptions 时设置，而且 app 运行过程中不能修改该参数的设置。

- (NSString*) loginExtensionInfo

readwritenonatomicassign

登录时携带的扩展信息，可以是JSON 字符串，目前字符串长度 底层限制长度1024

- (EMLogLevel) logLevel

readwritenonatomicassign

日志级别：

• (默认)EMLogLevelDebug：所有等级的日志；
• EMLogLevelWarning：警告及错误；
• EMLogLevelError：错误。

- (EMSDKPlatform) platform

readwritenonatomicassign

SDK 平台。

• （默认）EMSDKPlatformNative：原生平台；

- (NSString*) pushKitCertName

readwritenonatomiccopy

iOS 特有属性，PushKit 的证书名称。

该参数只能在调用 initializeSDKWithOptions 时设置，且 app 运行过程中不可以修改。

- (BOOL) regardImportMessagesAsRead

readwritenonatomicassign

是否将服务器导入的消息设置为已读：

• YES：已读。会话的未读消息数 EMConversation::unreadMessagesCount 不发生变化。
• （默认）NO：未读。EMConversation::unreadMessagesCount 的数量会增加。

- (NSString*) restServer

readwritenonatomiccopy

REST 服务器地址。

enableDnsConfig 为 NO 时生效。只能在 initializeSDKWithOptions: 中设置，不能在程序运行过程中动态修改。

由 category EMOptions(PrivateDeploy) 提供.

- (BOOL) sortMessageByServerTime

readwritenonatomicassign

从数据库加载消息时是否按服务器时间排序。

• （默认）YES：按服务器时间排序；
• NO：否。

- (NSString*) uiKitVersion

readwritenonatomiccopy

UIKit 版本号。

• （默认）不设置。

- (BOOL) useReplacedMessageContents

readwritenonatomicassign

当发送的文本消息的内容被文本审核（Moderation）服务替换时，是否需要返回给发送方。

• YES：将内容替换后的消息返回给发送方。
• （默认）NO：将原消息返回给发送方。

该属性只能在调用 initializeSDKWithOptions 时设置，而且 app 运行过程中不能修改该参数的设置。

- (BOOL) usingHttpsOnly

readwritenonatomicassign

是否只使用 HTTPS 协议。

• YES：是：
• （默认）NO：否。

- (int) webSocketPort

readwritenonatomicassign

WebSocket 服务器端口。 enableDnsConfig 为 NO 时生效。只能在 initializeSDKWithOptions: 中设置，不能在程序运行过程中动态修改。

由 category EMOptions(PrivateDeploy) 提供.

- (NSString* _Nullable) webSocketServer

readwritenonatomiccopy

WebSocket 服务器地址。

enableDnsConfig 为 NO 时生效。只能在 initializeSDKWithOptions: 中设置，不能在程序运行过程中动态修改。

由 category EMOptions(PrivateDeploy) 提供.

- (BOOL) workPathCopiable

readwritenonatomicassign

SDK 的工作路径是否可备份。

• YES：可拷贝。
• （默认）NO：不可拷贝。

---

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

• HyphenateChat.framework/Headers/EMOptions.h