文档中心
即时通讯 (环信)
Console 官网 社区 技术支持
简体中文
search-icon

即时通讯 IM iOS API 参考

AgoraChatClient IAgoraChatManager AgoraChatMessage AgoraChatConversation IAgoraChatContactManager IAgoraChatGroupManager IAgoraChatroomManager IAgoraChatPresenceManager IAgoraChatThreadManager IAgoraChatPushManager IAgoraChatUserInfoManager

#import <AgoraChatOptions.h>

类 AgoraChatOptions 继承关系图:

构造函数

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

类方法

(instancetype _Nonnull) + optionsWithAppkey:
 

属性

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 enableDnsConfig
 
int chatPort
 
NSString * chatServer
 
NSString * restServer
 
NSString * dnsURL
 

详细描述

SDK 的设置选项。

函数文档

◆ __deprecated_msg [1/6]

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

自动同意好友申请, 默认为 NO。

◆ __deprecated_msg [2/6]

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

用户自动同意群邀请, 默认为 YES。

◆ __deprecated_msg [3/6]

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

是否自动下载图片和视频缩略图及语音消息, 默认为 YES。

◆ __deprecated_msg [4/6]

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

是否允许聊天室所有者离开, 默认为 YES。

◆ __deprecated_msg [5/6]

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

离开聊天室时是否删除所有消息, 默认为 YES。

◆ __deprecated_msg [6/6]

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

离开群组时是否删除该群所有消息, 默认为 YES。

由 category AgoraChatOptions(PrivateDeploy) 提供.

◆ optionsWithAppkey:

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

获取实例。

参数
aAppkeyapp key。
返回
SDK 设置项实例。

属性说明

◆ apnsCertName

- (NSString*) apnsCertName
readwritenonatomiccopy

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

消息推送的证书名称。该参数只能在调用 initializeSDKWithOptions 时设置，且 app 运行过程中不可以修改。

◆ appkey

- (NSString*) appkey
readnonatomiccopy

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

◆ area

- (AreaCode) area
readwritenonatomicassign

区域代号。

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

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

◆ autoAcceptFriendInvitation

- (BOOL) autoAcceptFriendInvitation
readwritenonatomicassign

是否自动同意好友邀请。默认值为 NO。

◆ autoAcceptGroupInvitation

- (BOOL) autoAcceptGroupInvitation
readwritenonatomicassign

是否自动接受群邀请。默认值为 YES。

◆ autoDownloadThumbnail

- (BOOL) autoDownloadThumbnail
readwritenonatomicassign

是否自动下载图片和视频缩略图及语音消息，默认为 YES。

◆ canChatroomOwnerLeave

- (BOOL) canChatroomOwnerLeave
readwritenonatomicassign

是否允许聊天室所有者离开，默认为 YES。

◆ chatPort

- (int) chatPort
readwritenonatomicassign

Chat 服务器端口。

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

由 category AgoraChatOptions(PrivateDeploy) 提供.

◆ chatServer

- (NSString*) chatServer
readwritenonatomiccopy

The chat 服务器地址。

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

由 category AgoraChatOptions(PrivateDeploy) 提供.

◆ deleteMessagesOnLeaveChatroom

- (BOOL) deleteMessagesOnLeaveChatroom
readwritenonatomicassign

离开聊天室时是否删除所有消息，默认为 YES。

◆ deleteMessagesOnLeaveGroup

- (BOOL) deleteMessagesOnLeaveGroup
readwritenonatomicassign

离开群组时是否删除该群所有消息，默认为 YES。

◆ dnsURL

- (NSString*) dnsURL
readwritenonatomiccopy

DNS URL 地址。

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

由 category AgoraChatOptions(PrivateDeploy) 提供.

◆ enableConsoleLog

- (BOOL) enableConsoleLog
readwritenonatomicassign

控制台是否输出日志。默认值为 NO。

◆ enableDeliveryAck

- (BOOL) enableDeliveryAck
readwritenonatomicassign

是否发送消息送达回执，默认为 NO，如果设置为 YES，SDK 收到单聊消息时会自动发送送达回执。

◆ enableDnsConfig

- (BOOL) enableDnsConfig
readwritenonatomicassign

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

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

由 category AgoraChatOptions(PrivateDeploy) 提供.

◆ enableFpa

- (BOOL) enableFpa
readwritenonatomicassign

是否打开FPA加速功能，默认关闭

◆ enableRequireReadAck

- (BOOL) enableRequireReadAck
readwritenonatomicassign

是否需要接收信息接收方已读回执。默认值为 YES。

◆ enableStatistics

- (BOOL) enableStatistics
readwritenonatomicassign

是否开启消息流量统计，默认不开启。

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

◆ isAutoLogin

- (BOOL) isAutoLogin
readwritenonatomicassign

是否自动登录，默认为 YES。

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

◆ isAutoTransferMessageAttachments

- (BOOL) isAutoTransferMessageAttachments
readwritenonatomicassign

是否自动上传或者下载消息中的附件，默认值为 YES。

◆ logLevel

- (AgoraChatLogLevel) logLevel
readwritenonatomicassign

默认值为 AgoraChatLogLevelDebug，表示所有等级的日志。

◆ pushKitCertName

- (NSString*) pushKitCertName
readwritenonatomiccopy

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

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

◆ restServer

- (NSString*) restServer
readwritenonatomiccopy

REST 服务器地址。

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

由 category AgoraChatOptions(PrivateDeploy) 提供.

◆ sortMessageByServerTime

- (BOOL) sortMessageByServerTime
readwritenonatomicassign

从数据库加载消息时是否按服务器时间排序，默认值为 YES，表示按按服务器时间排序。

◆ usingHttpsOnly

- (BOOL) usingHttpsOnly
readwritenonatomicassign

是否只使用 HTTPS 协议。默认值为 NO。

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