类 | |
class | AreaCode |
提供 SDK 聊天相关的设置。 用户可以用来配置 SDK 的各种参数、选项, 比如,发送消息加密,是否自动接受加好友邀请。
void io.agora.chat.ChatOptions.allowChatroomOwnerLeave | ( | boolean | allowed | ) |
设置是否允许聊天室所有者离开并删除会话记录。
allowed | 是否允许聊天室所有者离开。
|
boolean io.agora.chat.ChatOptions.autoAcceptGroupInvitations | ( | ) |
获取是否自动接受加群邀请。
true
:自动接受加群邀请;false
:不自动接受加群邀请。 boolean io.agora.chat.ChatOptions.canChatroomOwnerLeave | ( | ) |
获取是否允许聊天室所有者离开。
true
:离开并不保留会话记录;false
:离开保留会话记录。 boolean io.agora.chat.ChatOptions.deleteMessagesOnLeaveChatroom | ( | ) |
获取退出(主动和被动退出)聊天室时是否删除聊天消息。
true
:退出聊天室时删除聊天室相关消息记录。false
:离开聊天室时保留会话记录。 boolean io.agora.chat.ChatOptions.deleteMessagesOnLeaveGroup | ( | ) |
获取退出(主动和被动退出)群组时是否删除聊天消息。
true
: 退出群组时删除群组消息。false
: 退出群组时不删除群组消息。 void io.agora.chat.ChatOptions.enableDNSConfig | ( | boolean | enable | ) |
设置是否关闭 DNS。
enable | 是否关闭 DNS。
|
boolean io.agora.chat.ChatOptions.getAcceptInvitationAlways | ( | ) |
获取是否自动接受加好友邀请。
true
:自动接受好友邀请。false
:不自动接收好友邀请。 String io.agora.chat.ChatOptions.getAccessToken | ( | ) |
获取本地保存的访问 token。
String io.agora.chat.ChatOptions.getAccessToken | ( | boolean | b | ) |
是否从服务器获取访问 token。
b | 是否从服务器获取。
|
String io.agora.chat.ChatOptions.getAppKey | ( | ) |
获取 app key。
boolean io.agora.chat.ChatOptions.getAutodownloadThumbnail | ( | ) |
获取是否自动下载缩略图。
true
:自动下载;false
:不自动下载。 boolean io.agora.chat.ChatOptions.getAutoLogin | ( | ) |
获取是否开启了自动登录。
true
:已设置为自动登录;false
:未设置为自动登录。 boolean io.agora.chat.ChatOptions.getAutoTransferMessageAttachments | ( | ) |
获取是否使用 Chat 服务器进行上传下载。
true
:自动使用 Chat 服务器进行上传下载;false
:不自动使用 Chat 服务器上传下载,自定义上传下载路径。 String io.agora.chat.ChatOptions.getDnsUrl | ( | ) |
获取 DNS 地址。
boolean io.agora.chat.ChatOptions.getEnableDNSConfig | ( | ) |
获取是否关闭 DNS。
true
:关闭 DNS。false
:不关闭 DNS。 int io.agora.chat.ChatOptions.getFixedInterval | ( | ) |
获取固定的心跳间隔。
boolean io.agora.chat.ChatOptions.getFpaEnable | ( | ) |
获取是否开启fpa。
false
: 没有开启fpa。true
:已经开启fpa; int io.agora.chat.ChatOptions.getImPort | ( | ) |
获取设置的 im 消息服务器端口号,一般为私有部署服务,在开发者想实现数据隔离、特别注重数据安全时使用,如有需求请联系商务。
String io.agora.chat.ChatOptions.getImServer | ( | ) |
获取设置的 im 消息服务器地址,一般为私有部署服务,在开发者想实现数据隔离、特别注重数据安全时使用,如有需求请联系商务。
PushConfig io.agora.chat.ChatOptions.getPushConfig | ( | ) |
获取用户设置的推送相关配置。
String io.agora.chat.ChatOptions.getReportServer | ( | ) |
获取设置的数据上报服务器地址,一般为私有部署服务,在开发者想实现数据隔离、特别注重数据安全时使用,如有需求请联系商务。
boolean io.agora.chat.ChatOptions.getRequireAck | ( | ) |
获取是否需要消息接收方发送已读回执的设置。
true
:需要已读回执;boolean io.agora.chat.ChatOptions.getRequireDeliveryAck | ( | ) |
获取送达回执设置。
true
:要求消息的接受方发送送达回执;false
: 不要求消息的接受方发送送达回执。 String io.agora.chat.ChatOptions.getRestServer | ( | ) |
获取设置的 REST 服务器地址,一般为私有部署服务,在开发者想实现数据隔离、特别注重数据安全时使用,如有需求请联系商务。
boolean io.agora.chat.ChatOptions.getUsingHttpsOnly | ( | ) |
获取是否只使用 HTTPS 进行 REST 操作。
true
只使用 HTTPS 进行 REST 操作;false
可以使用 HTTPS 和 HTTP 进行 REST 操作。 String io.agora.chat.ChatOptions.getVersion | ( | ) |
获取 SDK 版本号。
boolean io.agora.chat.ChatOptions.isAutoAcceptGroupInvitation | ( | ) |
获取是否自动接受加群邀请。
true
:自动接受加群邀请;false
:不自动接受加群邀请。boolean io.agora.chat.ChatOptions.isChatroomOwnerLeaveAllowed | ( | ) |
boolean io.agora.chat.ChatOptions.isDeleteMessagesAsExitChatRoom | ( | ) |
获取退出(主动和被动退出)聊天室时是否删除聊天消息。
true
:退出聊天室时删除聊天室相关消息记录。false
:离开聊天室时保留会话记录。boolean io.agora.chat.ChatOptions.isDeleteMessagesAsExitGroup | ( | ) |
获取退出(主动和被动退出)群组时是否删除聊天消息。
true
: 退出群组时删除群组消息。false
: 退出群组时不删除群组消息。boolean io.agora.chat.ChatOptions.isEnableStatistics | ( | ) |
获取是否启动统计。
true
:启用统计;false
:不启用统计。 boolean io.agora.chat.ChatOptions.isSortMessageByServerTime | ( | ) |
获取是否按照服务器收到时间进行排序。
true
:按服务器收到消息时间进行排序;false
:不按服务器收到消息时间进行排序。 void io.agora.chat.ChatOptions.setAcceptInvitationAlways | ( | boolean | value | ) |
设置是否自动接受加好友邀请。
value | 是否自动接受加好友邀请。
|
void io.agora.chat.ChatOptions.setAppKey | ( | String | appkey | ) |
设置 app key。
appkey | 创建 app 时在 console 后台上注册的 app 唯一识别符。 |
void io.agora.chat.ChatOptions.setAreaCode | ( | int | code | ) |
设置区域代号,使用边缘节点时遵循区域限制
code | 区域代号。
|
void io.agora.chat.ChatOptions.setAutoAcceptGroupInvitation | ( | boolean | value | ) |
设置是否自动接受加群邀请。
value | 是否自动接受加群邀请。
|
void io.agora.chat.ChatOptions.setAutoDownloadThumbnail | ( | boolean | autodownload | ) |
是否自动下载缩略图。
autodownload | 是否自动下载缩略图。
|
void io.agora.chat.ChatOptions.setAutoLogin | ( | boolean | autoLogin | ) |
开启/关闭自动登录。
autoLogin |
|
void io.agora.chat.ChatOptions.setAutoTransferMessageAttachments | ( | boolean | transfer | ) |
设置是否自动将消息附件上传到 Chat 服务器。
transfer | 是否自动上传到 Chat 服务器。
|
void io.agora.chat.ChatOptions.setDeleteMessagesAsExitChatRoom | ( | boolean | delete | ) |
设置退出(主动和被动退出)聊天室时是否删除聊天消息。
delete | - (默认)true :退出聊天室时删除聊天室相关消息记录。
|
void io.agora.chat.ChatOptions.setDeleteMessagesAsExitGroup | ( | boolean | delete | ) |
设置退出(主动和被动退出)群组时是否删除聊天消息。
delete |
|
void io.agora.chat.ChatOptions.setDnsUrl | ( | String | dnsUrl | ) |
设置 DNS 地址。
dnsUrl | DNS 地址。 |
void io.agora.chat.ChatOptions.setEnableStatistics | ( | boolean | enableStatistics | ) |
设置是否启用统计。 需要在调用 ChatClient#init(Context, ChatOptions) 之前进行设置。
enableStatistics | 是否启用统计。
|
void io.agora.chat.ChatOptions.setFixedHBInterval | ( | int | interval | ) |
设置固定的心跳间隔,不设置时会自动探测最佳心跳间隔。
interval | 心跳时间间隔,单位为秒,建议范围为 30s~300s 之间。 |
void io.agora.chat.ChatOptions.setFpaEnable | ( | boolean | fpaEnable | ) |
设置是否开启fpa。
fpaEnable | 是否开启fpa。
|
void io.agora.chat.ChatOptions.setImPort | ( | int | imPort | ) |
设置 im 消息服务器端口号,一般为私有部署服务,在开发者想实现数据隔离、特别注重数据安全时使用,如有需求请联系商务。
imPort | 端口号。 |
void io.agora.chat.ChatOptions.setIMServer | ( | String | imServer | ) |
设置 im 消息服务器地址,一般为私有部署服务,在开发者想实现数据隔离、特别注重数据安全时使用,如有需求请联系商务。
imServer | im 消息服务器地址。 |
void io.agora.chat.ChatOptions.setPushConfig | ( | PushConfig | pushConfig | ) |
设置推送相关配置。
pushConfig | 推送相关配置。 |
void io.agora.chat.ChatOptions.setReportServer | ( | String | reportServer | ) |
设置数据上报服务器地址,一般为私有部署服务,在开发者想实现数据隔离、特别注重数据安全时使用,如有需求请联系商务。
reportServer | 数据上报服务器地址。 |
void io.agora.chat.ChatOptions.setRequireAck | ( | boolean | requireAck | ) |
设置是否需要接受方发送已读回执。
requireAck | 是否需要接收方发送已读回执。
|
void io.agora.chat.ChatOptions.setRequireDeliveryAck | ( | boolean | requireDeliveryAck | ) |
设置是否需要接受方发送送达回执。
requireDeliveryAck | 是否需要送达回执。
|
void io.agora.chat.ChatOptions.setRestServer | ( | String | restServer | ) |
设置 REST 服务器地址,一般在开发者想实现数据隔离、特别注重数据安全时使用,如有需求请联系商务获取指定的服务器地址。
restServer | REST 服务器地址。 |
void io.agora.chat.ChatOptions.setSortMessageByServerTime | ( | boolean | sortByServerTime | ) |
设置是否按照服务器收到的时间对消息进行排序。
sortByServerTime | 是否按照服务器收到的时间对消息进行排序。
|
void io.agora.chat.ChatOptions.setUsingHttpsOnly | ( | boolean | _usingHttpsOnly | ) |
设置只使用 HTTPS 进行 REST 操作。
_usingHttpsOnly | 是否只使用 HTTPS。
|