hyphenate_SDK4.0 4.10.0
hyphenate java IM SDK
|
提供 SDK 聊天相关的设置。
用户可以用来配置 SDK 的各种参数、选项,
比如,发送消息加密,是否自动接受加好友邀请。
void com.hyphenate.chat.EMOptions.allowChatroomOwnerLeave | ( | boolean | allowed | ) |
设置是否允许聊天室所有者离开并删除会话记录。
allowed | 是否允许聊天室所有者离开。
|
boolean com.hyphenate.chat.EMOptions.autoAcceptGroupInvitations | ( | ) |
获取是否自动接受加群邀请。
true
:自动接受加群邀请;false
:不自动接受加群邀请。 boolean com.hyphenate.chat.EMOptions.canChatroomOwnerLeave | ( | ) |
获取是否允许聊天室所有者离开。
true
:允许聊天室所有者离开;false
:不允许聊天室所有者离开。 boolean com.hyphenate.chat.EMOptions.deleteMessagesOnLeaveChatroom | ( | ) |
获取退出(主动和被动退出)聊天室时是否删除聊天消息。
true
:退出聊天室时删除聊天室相关消息记录。false
:离开聊天室时保留会话记录。 boolean com.hyphenate.chat.EMOptions.deleteMessagesOnLeaveGroup | ( | ) |
获取退出(主动和被动退出)群组时是否删除聊天消息。
true
: 退出群组时删除群组消息。false
: 退出群组时不删除群组消息。 void com.hyphenate.chat.EMOptions.enableDNSConfig | ( | boolean | enable | ) |
设置是否关闭 DNS。
enable | 是否关闭 DNS。
|
boolean com.hyphenate.chat.EMOptions.getAcceptInvitationAlways | ( | ) |
获取是否自动接受加好友邀请。
true
:自动接受好友邀请。false
:不自动接收好友邀请。 String com.hyphenate.chat.EMOptions.getAccessToken | ( | ) |
获取本地保存的访问 token。
String com.hyphenate.chat.EMOptions.getAccessToken | ( | boolean | b | ) |
是否从服务器获取访问 token。
b | 是否从服务器获取。
|
String com.hyphenate.chat.EMOptions.getAppKey | ( | ) |
获取 app key。
int com.hyphenate.chat.EMOptions.getAreaCode | ( | ) |
获取区域代号。
区域代码参数用于限制边缘节点的访问范围。
boolean com.hyphenate.chat.EMOptions.getAutodownloadThumbnail | ( | ) |
获取是否自动下载缩略图。
true
:自动下载;false
:不自动下载。 boolean com.hyphenate.chat.EMOptions.getAutoLogin | ( | ) |
获取是否开启了自动登录。
true
:已设置为自动登录;false
:未设置为自动登录。 boolean com.hyphenate.chat.EMOptions.getAutoTransferMessageAttachments | ( | ) |
获取是否使用 Chat 服务器进行上传下载。
true
:自动使用 Chat 服务器进行上传下载;false
:不自动使用 Chat 服务器上传下载,自定义上传下载路径。 String com.hyphenate.chat.EMOptions.getCustomDeviceName | ( | ) |
获取当前设备的自定义名称。
int com.hyphenate.chat.EMOptions.getCustomOSPlatform | ( | ) |
获取登录设备的自定义平台代号。
String com.hyphenate.chat.EMOptions.getDnsUrl | ( | ) |
获取 DNS 地址。
boolean com.hyphenate.chat.EMOptions.getEnableDNSConfig | ( | ) |
获取是否关闭 DNS。
true
:关闭 DNS。false
:不关闭 DNS。 int com.hyphenate.chat.EMOptions.getFixedInterval | ( | ) |
获取固定的心跳间隔。
int com.hyphenate.chat.EMOptions.getImPort | ( | ) |
获取设置的 im 消息服务器端口号,一般为私有部署服务,在开发者想实现数据隔离、特别注重数据安全时使用,如有需求请联系商务。
String com.hyphenate.chat.EMOptions.getImServer | ( | ) |
获取设置的 im 消息服务器地址,一般为私有部署服务,在开发者想实现数据隔离、特别注重数据安全时使用,如有需求请联系商务。
String com.hyphenate.chat.EMOptions.getLoginCustomExt | ( | ) |
获取自定义设备扩展信息。
String com.hyphenate.chat.EMOptions.getNativeLibBasePath | ( | ) |
获取设置的 native 库的路径。
EMPushConfig com.hyphenate.chat.EMOptions.getPushConfig | ( | ) |
获取用户设置的推送相关配置。
String com.hyphenate.chat.EMOptions.getReportServer | ( | ) |
获取设置的数据上报服务器地址,一般为私有部署服务,在开发者想实现数据隔离、特别注重数据安全时使用,如有需求请联系商务。
boolean com.hyphenate.chat.EMOptions.getRequireAck | ( | ) |
获取是否需要消息接收方发送已读回执的设置。
true
:需要已读回执;boolean com.hyphenate.chat.EMOptions.getRequireDeliveryAck | ( | ) |
获取送达回执设置。
true
:要求消息的接受方发送送达回执;false
: 不要求消息的接受方发送送达回执。 String com.hyphenate.chat.EMOptions.getRestServer | ( | ) |
获取设置的 REST 服务器地址,一般为私有部署服务,在开发者想实现数据隔离、特别注重数据安全时使用,如有需求请联系商务。
boolean com.hyphenate.chat.EMOptions.getUsingHttpsOnly | ( | ) |
获取是否只使用 HTTPS 进行 REST 操作。
true
只使用 HTTPS 进行 REST 操作;false
可以使用 HTTPS 和 HTTP 进行 REST 操作。 String com.hyphenate.chat.EMOptions.getVersion | ( | ) |
获取 SDK 版本号。
boolean com.hyphenate.chat.EMOptions.isAutoAcceptGroupInvitation | ( | ) |
获取是否自动接受加群邀请。
true
:自动接受加群邀请;false
:不自动接受加群邀请。boolean com.hyphenate.chat.EMOptions.isAutoLoadAllConversations | ( | ) |
获取是否在登录成功后自动加载所有会话到缓存里。
true
:自动加载;false
:不自动加载。 boolean com.hyphenate.chat.EMOptions.isChatroomOwnerLeaveAllowed | ( | ) |
获取是否允许聊天室所有者离开。
true
:允许。即使聊天室所有者离开,该所有者仍具有聊天室的所有权限,只不过不再接收任何消息。false
:不允许。 boolean com.hyphenate.chat.EMOptions.isDeleteMessagesAsExitChatRoom | ( | ) |
获取退出(主动和被动退出)聊天室时是否删除聊天消息。
true
:删除。false
:保留。boolean com.hyphenate.chat.EMOptions.isDeleteMessagesAsExitGroup | ( | ) |
获取退出(主动和被动退出)群组时是否删除聊天消息。
true
: 退出群组时删除群组消息。false
: 退出群组时不删除群组消息。boolean com.hyphenate.chat.EMOptions.isEnableStatistics | ( | ) |
获取是否开启了本地消息的流量统计功能。
true
:开启;false
:关闭。 boolean com.hyphenate.chat.EMOptions.isEnableTLSConnection | ( | ) |
获取是否开启 TLS 连接。
true
:开启 TLS 连接;false
:未开启 TLS 连接。 boolean com.hyphenate.chat.EMOptions.isIncludeSendMessageInMessageListener | ( | ) |
发送成功的消息是否在 EMMessageListener#onMessageReceived(java.util.List) 中回调给用户。
true
:是。发送成功的消息包含在EMMessageListener#onMessageReceived(java.util.List) 中。false
:否。EMMessageListener#onMessageReceived(java.util.List) 中只包含接收的消息。 boolean com.hyphenate.chat.EMOptions.isLoadEmptyConversations | ( | ) |
检查从数据库加载会话时是否包含空会话。
false
:不包括;true
:包括。 boolean com.hyphenate.chat.EMOptions.isSortMessageByServerTime | ( | ) |
获取是否按照服务器收到时间进行排序。
true
:按服务器收到消息时间进行排序;false
:不按服务器收到消息时间进行排序。 boolean com.hyphenate.chat.EMOptions.isUseReplacedMessageContents | ( | ) |
获取当发送的文本消息的内容被文本审核(Moderation)服务替换时,是否需要返回给发送方。
boolean com.hyphenate.chat.EMOptions.regardImportedMsgAsRead | ( | ) |
\~chinese 是否将通过服务器导入的消息设置为已读: @return 是否将通过服务器导入的消息设置为已读: - `true`:将导入消息置为已读。 - (默认)`false`:不将导入消息置为已读。 \~english Whether to set messages imported from the server side as read. @return Whether to set messages imported from the server side as read: - `true`: Read. After the messages are imported, the number of unread messages returned by `EMConversation#getUnreadMsgCount() remains unchanged.
remains unchanged.
: Unread. After the messages are imported, the number of unread messages returned by
EMConversation::getUnreadMsgCount() is increased. void com.hyphenate.chat.EMOptions.setAcceptInvitationAlways | ( | boolean | value | ) |
设置是否自动接受加好友邀请。
value | 是否自动接受加好友邀请。
|
void com.hyphenate.chat.EMOptions.setAppKey | ( | String | appkey | ) |
设置 app key。
appkey | 创建 app 时在 console 后台上注册的 app 唯一识别符。 |
void com.hyphenate.chat.EMOptions.setAreaCode | ( | int | code | ) |
设置区域代号。
code | 区域代号。该参数用于限制边缘节点的访问范围,默认值为 AREA_CODE_GLOB ,表示不限制区域。应用运行时不能对该参数进行修改。 |
void com.hyphenate.chat.EMOptions.setAutoAcceptGroupInvitation | ( | boolean | value | ) |
设置是否自动接受加群邀请。
value | 是否自动接受加群邀请。
|
void com.hyphenate.chat.EMOptions.setAutoDownloadThumbnail | ( | boolean | autodownload | ) |
是否自动下载缩略图。
autodownload | 是否自动下载缩略图。
|
void com.hyphenate.chat.EMOptions.setAutoLoadAllConversations | ( | boolean | autoLoadAllConversations | ) |
设置是否在登录成功后自动加载所有会话到缓存里。
需要在调用 EMClient#init(Context, EMOptions) 之前进行设置。
autoLoadAllConversations | 是否自动加载所有会话。
|
void com.hyphenate.chat.EMOptions.setAutoLogin | ( | boolean | autoLogin | ) |
开启/关闭自动登录。
autoLogin | 是否开启自动登录:
|
void com.hyphenate.chat.EMOptions.setAutoTransferMessageAttachments | ( | boolean | transfer | ) |
设置是否自动将消息附件上传到 Chat 服务器。
transfer | 是否自动上传到 Chat 服务器。
|
void com.hyphenate.chat.EMOptions.setCustomDeviceName | ( | @NonNull String | customDeviceName | ) |
设置当前设备自定义名称。
设置当前设备自定义名称旨在多设备登录时区分设备。
你可以通过 EMClient#getLoggedInDevicesFromServer(String, String) 获取指定账号的多个登录设备的信息。
需要在调用 EMClient#init(Context, EMOptions) 之前设置当前设备自定义名称。
customDeviceName | 自定义设备名称。该参数不支持空字符串和 null 值,默认使用设备型号,例如 HUAWEICOL-AL10。 |
void com.hyphenate.chat.EMOptions.setCustomOSPlatform | ( | int | platform | ) |
void com.hyphenate.chat.EMOptions.setDeleteMessagesAsExitChatRoom | ( | boolean | delete | ) |
设置退出(主动和被动退出)聊天室时是否删除聊天消息。
delete | 退出(主动和被动退出)聊天室时是否删除聊天消息:
|
void com.hyphenate.chat.EMOptions.setDeleteMessagesAsExitGroup | ( | boolean | delete | ) |
设置退出(主动和被动退出)群组时是否删除聊天消息。
delete |
|
void com.hyphenate.chat.EMOptions.setDnsUrl | ( | String | dnsUrl | ) |
设置 DNS 地址。
dnsUrl | DNS 地址。 |
void com.hyphenate.chat.EMOptions.setEnableStatistics | ( | boolean | enableStatistics | ) |
设置是否开启本地消息的流量统计功能。
需要在调用 EMClient#init(Context, EMOptions) 之前进行设置。
enableStatistics | 是否开启消息流量统计功能:
|
void com.hyphenate.chat.EMOptions.setEnableTLSConnection | ( | boolean | enableTLSConnection | ) |
设置是否开启 TLS 连接。
该设置只在私有部署时使用。
需要在调用 EMClient#init(Context, EMOptions) 之前进行设置。
enableTLSConnection | 是否开启 TLS 连接。
|
void com.hyphenate.chat.EMOptions.setFixedHBInterval | ( | int | interval | ) |
设置固定的心跳间隔,不设置时会自动探测最佳心跳间隔。
interval | 心跳时间间隔,单位为秒,建议范围为 30s~300s 之间。 |
void com.hyphenate.chat.EMOptions.setImPort | ( | int | imPort | ) |
设置 im 消息服务器端口号,一般为私有部署服务,在开发者想实现数据隔离、特别注重数据安全时使用,如有需求请联系商务。
imPort | 端口号。 |
void com.hyphenate.chat.EMOptions.setIMServer | ( | String | imServer | ) |
设置 im 消息服务器地址,一般为私有部署服务,在开发者想实现数据隔离、特别注重数据安全时使用,如有需求请联系商务。
imServer | im 消息服务器地址。 |
void com.hyphenate.chat.EMOptions.setIncludeSendMessageInMessageListener | ( | boolean | include | ) |
设置发送成功的消息是否在 EMMessageListener#onMessageReceived(java.util.List) 中回调给用户。
include | 发送成功的消息是否回调给用户。
|
void com.hyphenate.chat.EMOptions.setLoadEmptyConversations | ( | boolean | isLoadEmptyConversations | ) |
设置从数据库加载会话时是否包含空会话。
需要在调用 EMClient#init(Context, EMOptions) 之前进行设置。
isLoadEmptyConversations | 从数据库加载会话时是否包含空会话:
|
void com.hyphenate.chat.EMOptions.setLoginCustomExt | ( | @NonNull String | ext | ) |
设置当前设备自定义扩展信息。
未初始化 SDK 或使用自动登录时,需在调用 EMClient#init(Context, EMOptions) 方法之前设置当前设备扩展信息。
若应用已完成初始化且使用手动登录,若要修改自定义信息,在下次调用 EMClient#login(String,String,EMCallBack) 或 EMClient#loginWithToken(String,String,EMCallBack) 之前设置自定义信息。
ext | 自定义设备扩展信息。该参数不支持 null 值。长度限制为 1024 个字符。 |
若用户因登录了当前设备而将另一台设备踢下线,向被踢下线设备发通知时会携带当前设备的自定义扩展信息。
void com.hyphenate.chat.EMOptions.setNativeLibBasePath | ( | @NonNull String | path | ) |
设置 native 库的路径。
path | native 库的路径。
|
void com.hyphenate.chat.EMOptions.setPushConfig | ( | EMPushConfig | pushConfig | ) |
设置推送相关配置。
pushConfig | 推送相关配置。 |
void com.hyphenate.chat.EMOptions.setRegardImportedMsgAsRead | ( | boolean | regardImportedMsgAsRead | ) |
\~chinese 设置是否将通过服务器导入的消息设置为已读: @return 是否将通过服务器导入的消息设置为已读: - `true`:将导入消息置为已读。 - (默认)`false`:不将导入消息置为已读。 \~english Sets whether to set messages imported from the server side as read. @return Whether to set messages imported from the server side as read: - `true`: Read. After the messages are imported, the number of unread messages returned by `EMConversation#getUnreadMsgCount() remains unchanged.
remains unchanged.
: Unread. After the messages are imported, the number of unread messages returned by
EMConversation::getUnreadMsgCount() is increased. void com.hyphenate.chat.EMOptions.setReportServer | ( | String | reportServer | ) |
设置数据上报服务器地址,一般为私有部署服务,在开发者想实现数据隔离、特别注重数据安全时使用,如有需求请联系商务。
reportServer | 数据上报服务器地址。 |
void com.hyphenate.chat.EMOptions.setRequireAck | ( | boolean | requireAck | ) |
设置是否需要接受方发送已读回执。
requireAck | 是否需要接收方发送已读回执。
|
void com.hyphenate.chat.EMOptions.setRequireDeliveryAck | ( | boolean | requireDeliveryAck | ) |
设置是否需要接受方发送送达回执。
requireDeliveryAck | 是否需要送达回执。
|
void com.hyphenate.chat.EMOptions.setRestServer | ( | String | restServer | ) |
设置 REST 服务器地址,一般在开发者想实现数据隔离、特别注重数据安全时使用,如有需求请联系商务获取指定的服务器地址。
restServer | REST 服务器地址。 |
void com.hyphenate.chat.EMOptions.setSortMessageByServerTime | ( | boolean | sortByServerTime | ) |
设置是否按照服务器收到的时间对消息进行排序。
sortByServerTime | 是否按照服务器收到的时间对消息进行排序。
|
void com.hyphenate.chat.EMOptions.setUseReplacedMessageContents | ( | boolean | useReplacedMessageContents | ) |
设置当发送的文本消息的内容被文本审核(Moderation)服务替换时,是否需要返回给发送方。
该方法只能在调用 EMClient#init(Context, EMOptions) 前才能调用。
useReplacedMessageContents | 是否将内容替换后的消息返回给发送方。
|
void com.hyphenate.chat.EMOptions.setUsingHttpsOnly | ( | boolean | _usingHttpsOnly | ) |
设置只使用 HTTPS 进行 REST 操作。
_usingHttpsOnly | 是否只使用 HTTPS。
|