hyphenate_SDK4.0 4.2.3-lite
hyphenate java IM SDK
|
Public 成员函数 | |
boolean | getRequireAck () |
void | setRequireAck (boolean requireAck) |
boolean | getRequireDeliveryAck () |
void | setRequireDeliveryAck (boolean requireDeliveryAck) |
void | allowChatroomOwnerLeave (boolean allowed) |
boolean | canChatroomOwnerLeave () |
void | setDeleteMessagesAsExitChatRoom (boolean delete) |
boolean | deleteMessagesOnLeaveChatroom () |
boolean | isSortMessageByServerTime () |
void | setSortMessageByServerTime (boolean sortByServerTime) |
void | setAppKey (String appkey) |
String | getAppKey () |
void | setIMServer (String imServer) |
String | getImServer () |
void | setImPort (int imPort) |
int | getImPort () |
void | setRestServer (String restServer) |
String | getRestServer () |
String | getReportServer () |
void | setReportServer (String reportServer) |
void | setAutoLogin (boolean autoLogin) |
boolean | getAutoLogin () |
void | enableDNSConfig (boolean enable) |
boolean | getEnableDNSConfig () |
void | setUsingHttpsOnly (boolean _usingHttpsOnly) |
boolean | getUsingHttpsOnly () |
void | setAutoTransferMessageAttachments (boolean transfer) |
boolean | getAutoTransferMessageAttachments () |
void | setAutoDownloadThumbnail (boolean autodownload) |
boolean | getAutodownloadThumbnail () |
void | setFixedHBInterval (int interval) |
int | getFixedInterval () |
String | getVersion () |
String | getAccessToken () |
String | getAccessToken (boolean b) |
void | setDnsUrl (String dnsUrl) |
String | getDnsUrl () |
boolean | isLoadEmptyConversations () |
void | setLoadEmptyConversations (boolean isLoadEmptyConversations) |
提供 SDK 聊天相关的设置。
用户可以用来配置 SDK 的各种参数、选项,
比如,发送消息加密,是否自动接受加好友邀请。
void com.hyphenate.chat.EMOptions.allowChatroomOwnerLeave | ( | boolean | allowed | ) |
设置是否允许聊天室所有者离开并删除会话记录。
allowed | 是否允许聊天室所有者离开。
|
boolean com.hyphenate.chat.EMOptions.canChatroomOwnerLeave | ( | ) |
获取是否允许聊天室所有者离开。
true
:允许聊天室所有者离开;false
:不允许聊天室所有者离开。 boolean com.hyphenate.chat.EMOptions.deleteMessagesOnLeaveChatroom | ( | ) |
获取退出(主动和被动退出)聊天室时是否删除聊天消息。
true
:退出聊天室时删除聊天室相关消息记录。false
:离开聊天室时保留会话记录。 void com.hyphenate.chat.EMOptions.enableDNSConfig | ( | boolean | enable | ) |
设置是否关闭 DNS。
enable | 是否关闭 DNS。
|
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。
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.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.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.isLoadEmptyConversations | ( | ) |
检查从服务端加载会话时是否包含空会话。
false
:不包括;true
:包括。 boolean com.hyphenate.chat.EMOptions.isSortMessageByServerTime | ( | ) |
获取是否按照服务器收到时间进行排序。
true
:按服务器收到消息时间进行排序;false
:不按服务器收到消息时间进行排序。 void com.hyphenate.chat.EMOptions.setAppKey | ( | String | appkey | ) |
设置 app key。
appkey | 创建 app 时在 console 后台上注册的 app 唯一识别符。 |
void com.hyphenate.chat.EMOptions.setAutoDownloadThumbnail | ( | boolean | autodownload | ) |
是否自动下载缩略图。
autodownload | 是否自动下载缩略图。
|
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.setDeleteMessagesAsExitChatRoom | ( | boolean | delete | ) |
设置退出(主动和被动退出)聊天室时是否删除聊天消息。
delete | - (默认)true :退出聊天室时删除聊天室相关消息记录。
|
void com.hyphenate.chat.EMOptions.setDnsUrl | ( | String | dnsUrl | ) |
设置 DNS 地址。
dnsUrl | DNS 地址。 |
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.setLoadEmptyConversations | ( | boolean | isLoadEmptyConversations | ) |
设置从服务端加载会话时是否包含空会话。
需要在调用 EMClient#init(Context, EMOptions) 之前进行设置。
isLoadEmptyConversations | 从服务端加载会话时是否包含空会话:
|
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.setUsingHttpsOnly | ( | boolean | _usingHttpsOnly | ) |
设置只使用 HTTPS 进行 REST 操作。
_usingHttpsOnly | 是否只使用 HTTPS。
|