hyphenate_SDK3.0 3.9.9.2
hyphenate java IM SDK
类 | Public 成员函数 | 所有成员列表
com.hyphenate.chat.EMOptions类 参考

类

class  AreaCode
 

Public 成员函数

boolean getRequireAck ()
 
void setRequireAck (boolean requireAck)
 
boolean getRequireDeliveryAck ()
 
boolean getFpaEnable ()
 
void setFpaEnable (boolean fpaEnable)
 
void setRequireDeliveryAck (boolean requireDeliveryAck)
 
boolean getAcceptInvitationAlways ()
 
void setAcceptInvitationAlways (boolean value)
 
void setDeleteMessagesAsExitGroup (boolean delete)
 
boolean isDeleteMessagesAsExitGroup ()
 
boolean deleteMessagesOnLeaveGroup ()
 
void setAutoAcceptGroupInvitation (boolean value)
 
boolean isAutoAcceptGroupInvitation ()
 
boolean autoAcceptGroupInvitations ()
 
void allowChatroomOwnerLeave (boolean allowed)
 
boolean isChatroomOwnerLeaveAllowed ()
 
boolean canChatroomOwnerLeave ()
 
void setDeleteMessagesAsExitChatRoom (boolean delete)
 
boolean isDeleteMessagesAsExitChatRoom ()
 
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 ()
 
EMPushConfig getPushConfig ()
 
void setPushConfig (EMPushConfig pushConfig)
 
boolean isEnableStatistics ()
 
void setEnableStatistics (boolean enableStatistics)
 
void setAreaCode (int code)
 
int getAreaCode ()
 

详细描述

提供 SDK 聊天相关的设置。 用户可以用来配置 SDK 的各种参数、选项， 比如，发送消息加密，是否自动接受加好友邀请。

成员函数说明

◆ allowChatroomOwnerLeave()

void com.hyphenate.chat.EMOptions.allowChatroomOwnerLeave ( boolean  allowed)

设置是否允许聊天室所有者离开并删除会话记录。

参数
allowed是否允许聊天室所有者离开。
  • （默认） true：允许聊天室所有者离开；
  • false：不允许聊天室所有者离开，聊天室所有者离开时不再接收任何消息并删除会话记录。

◆ autoAcceptGroupInvitations()

boolean com.hyphenate.chat.EMOptions.autoAcceptGroupInvitations ( )

获取是否自动接受加群邀请。

返回
返回是否自动接受加群邀请。
  • （默认） true：自动接受加群邀请；
  • false：不自动接受加群邀请。

◆ canChatroomOwnerLeave()

boolean com.hyphenate.chat.EMOptions.canChatroomOwnerLeave ( )

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

返回
- （默认）true：离开并不保留会话记录；
  • false：离开保留会话记录。

◆ deleteMessagesOnLeaveChatroom()

boolean com.hyphenate.chat.EMOptions.deleteMessagesOnLeaveChatroom ( )

获取退出(主动和被动退出)聊天室时是否删除聊天消息。

返回
-（默认）true：退出聊天室时删除聊天室相关消息记录。
  • false：离开聊天室时保留会话记录。

◆ deleteMessagesOnLeaveGroup()

boolean com.hyphenate.chat.EMOptions.deleteMessagesOnLeaveGroup ( )

获取退出(主动和被动退出)群组时是否删除聊天消息。

返回
- （默认）true: 退出群组时删除群组消息。
  • false: 退出群组时不删除群组消息。

◆ enableDNSConfig()

void com.hyphenate.chat.EMOptions.enableDNSConfig ( boolean  enable)

设置是否关闭 DNS。

参数
enable是否关闭 DNS。
  • （默认）true：关闭 DNS，私有云部署需要关闭；
  • false：不关闭 DNS。

◆ getAcceptInvitationAlways()

boolean com.hyphenate.chat.EMOptions.getAcceptInvitationAlways ( )

获取是否自动接受加好友邀请。

返回
是否自动接受加好友邀请。
  • （默认）true：自动接受好友邀请。
  • false：不自动接收好友邀请。

◆ getAccessToken() [1/2]

String com.hyphenate.chat.EMOptions.getAccessToken ( )

获取本地保存的访问 token。

返回
访问 token。

◆ getAccessToken() [2/2]

String com.hyphenate.chat.EMOptions.getAccessToken ( boolean  b)

是否从服务器获取访问 token。

参数
b是否从服务器获取。
  • true：从服务器获取访问 token；
  • false：不从服务器获取访问 token。
返回
访问 token。

◆ getAppKey()

String com.hyphenate.chat.EMOptions.getAppKey ( )

获取 app key。

◆ getAutodownloadThumbnail()

boolean com.hyphenate.chat.EMOptions.getAutodownloadThumbnail ( )

获取是否自动下载缩略图。

返回
是否自动下载缩略图。
  • （默认）true：自动下载；
  • false：不自动下载。

◆ getAutoLogin()

boolean com.hyphenate.chat.EMOptions.getAutoLogin ( )

获取是否开启了自动登录。

返回
- （默认）true：已设置为自动登录；
  • false：未设置为自动登录。

◆ getAutoTransferMessageAttachments()

boolean com.hyphenate.chat.EMOptions.getAutoTransferMessageAttachments ( )

获取是否使用 Chat 服务器进行上传下载。

返回
是否自动使用 Chat 服务器进行上传下载。
  • （默认）true：自动使用 Chat 服务器进行上传下载；
  • false：不自动使用 Chat 服务器上传下载，自定义上传下载路径。

◆ getDnsUrl()

String com.hyphenate.chat.EMOptions.getDnsUrl ( )

获取 DNS 地址。

返回
DNS 地址。

◆ getEnableDNSConfig()

boolean com.hyphenate.chat.EMOptions.getEnableDNSConfig ( )

获取是否关闭 DNS。

返回
返回是否关闭 DNS。
  • （默认）true：关闭 DNS。
  • false：不关闭 DNS。

◆ getFixedInterval()

int com.hyphenate.chat.EMOptions.getFixedInterval ( )

获取固定的心跳间隔。

返回
心跳时间间隔，单位为秒。

◆ getFpaEnable()

boolean com.hyphenate.chat.EMOptions.getFpaEnable ( )

获取是否开启fpa。

返回
是否开启fpa。
  • （默认）false： 没有开启fpa。
  • true：已经开启fpa；

◆ getImPort()

int com.hyphenate.chat.EMOptions.getImPort ( )

获取设置的 im 消息服务器端口号，一般为私有部署服务，在开发者想实现数据隔离、特别注重数据安全时使用，如有需求请联系商务。

返回
端口号。

◆ getImServer()

String com.hyphenate.chat.EMOptions.getImServer ( )

获取设置的 im 消息服务器地址，一般为私有部署服务，在开发者想实现数据隔离、特别注重数据安全时使用，如有需求请联系商务。

返回
im 消息服务器地址。

◆ getPushConfig()

EMPushConfig com.hyphenate.chat.EMOptions.getPushConfig ( )

获取用户设置的推送相关配置。

返回
推送配置。

◆ getReportServer()

String com.hyphenate.chat.EMOptions.getReportServer ( )

获取设置的数据上报服务器地址，一般为私有部署服务，在开发者想实现数据隔离、特别注重数据安全时使用，如有需求请联系商务。

返回
数据上报服务器地址，有可能为空。

◆ getRequireAck()

boolean com.hyphenate.chat.EMOptions.getRequireAck ( )

获取是否需要消息接收方发送已读回执的设置。

返回
是否要求消息的接收方发送已读回执。
  • （默认）true：需要已读回执；
  • `false：不需要已读回执。

◆ getRequireDeliveryAck()

boolean com.hyphenate.chat.EMOptions.getRequireDeliveryAck ( )

获取送达回执设置。

返回
是否需要送达回执。
  • （默认）true：要求消息的接受方发送送达回执；
  • false： 不要求消息的接受方发送送达回执。

◆ getRestServer()

String com.hyphenate.chat.EMOptions.getRestServer ( )

获取设置的 REST 服务器地址，一般为私有部署服务，在开发者想实现数据隔离、特别注重数据安全时使用，如有需求请联系商务。

返回
REST 服务器地址。

◆ getUsingHttpsOnly()

boolean com.hyphenate.chat.EMOptions.getUsingHttpsOnly ( )

获取是否只使用 HTTPS 进行 REST 操作。

返回
是否只使用 HTTPS。
  • （默认）true 只使用 HTTPS 进行 REST 操作；
  • false 可以使用 HTTPS 和 HTTP 进行 REST 操作。

◆ getVersion()

String com.hyphenate.chat.EMOptions.getVersion ( )

获取 SDK 版本号。

返回
SDK 版本号。

◆ isAutoAcceptGroupInvitation()

boolean com.hyphenate.chat.EMOptions.isAutoAcceptGroupInvitation ( )

获取是否自动接受加群邀请。

返回
返回是否自动接受加群邀请。
  • （默认） true：自动接受加群邀请；
  • false：不自动接受加群邀请。
弃用:
使用 EMOptions#autoAcceptGroupInvitations() 替代。

◆ isChatroomOwnerLeaveAllowed()

boolean com.hyphenate.chat.EMOptions.isChatroomOwnerLeaveAllowed ( )

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

返回
- （默认）true：离开时不保留会话；
  • false：离开保留会话。
弃用:
使用 EMOptions#canChatroomOwnerLeave() 代替。

◆ isDeleteMessagesAsExitChatRoom()

boolean com.hyphenate.chat.EMOptions.isDeleteMessagesAsExitChatRoom ( )

获取退出(主动和被动退出)聊天室时是否删除聊天消息。

返回
- （默认）true：退出聊天室时删除聊天室相关消息记录。
  • false：离开聊天室时保留会话记录。
弃用:
使用 EMOptions#deleteMessagesOnLeaveChatroom() 替代。

◆ isDeleteMessagesAsExitGroup()

boolean com.hyphenate.chat.EMOptions.isDeleteMessagesAsExitGroup ( )

获取退出(主动和被动退出)群组时是否删除聊天消息。

返回
- （默认）true: 退出群组时删除群组消息。
  • false: 退出群组时不删除群组消息。
弃用:
使用 EMOptions#deleteMessagesOnLeaveGroup() 替代。

◆ isEnableStatistics()

boolean com.hyphenate.chat.EMOptions.isEnableStatistics ( )

获取是否启动统计。

返回
- （默认）true：启用统计；
  • false：不启用统计。

◆ isSortMessageByServerTime()

boolean com.hyphenate.chat.EMOptions.isSortMessageByServerTime ( )

获取是否按照服务器收到时间进行排序。

返回
返回是否按照服务器收到的时间排序。
  • （默认）true：按服务器收到消息时间进行排序；
  • false：不按服务器收到消息时间进行排序。

◆ setAcceptInvitationAlways()

void com.hyphenate.chat.EMOptions.setAcceptInvitationAlways ( boolean  value)

设置是否自动接受加好友邀请。

参数
value是否自动接受加好友邀请。
  • （默认）true：自动接受好友邀请。
  • false：不自动接收好友邀请。

◆ setAppKey()

void com.hyphenate.chat.EMOptions.setAppKey ( String  appkey)

设置 app key。

参数
appkey创建 app 时在 console 后台上注册的 app 唯一识别符。

◆ setAreaCode()

void com.hyphenate.chat.EMOptions.setAreaCode ( int  code)

设置区域代号，使用边缘节点时遵循区域限制

参数
code区域代号。
  • （默认）AREA_CODE_GLOB：不限制区域。

◆ setAutoAcceptGroupInvitation()

void com.hyphenate.chat.EMOptions.setAutoAcceptGroupInvitation ( boolean  value)

设置是否自动接受加群邀请。

参数
value是否自动接受加群邀请。
  • （默认）true：自动接受加群申请；
  • false: 不自动接受加群申请。

◆ setAutoDownloadThumbnail()

void com.hyphenate.chat.EMOptions.setAutoDownloadThumbnail ( boolean  autodownload)

是否自动下载缩略图。

参数
autodownload是否自动下载缩略图。
  • （默认）true：自动下载；
  • false：不自动下载。

◆ setAutoLogin()

void com.hyphenate.chat.EMOptions.setAutoLogin ( boolean  autoLogin)

开启/关闭自动登录。

参数
autoLogin
  • （默认）true：自动登录；
  • false：不自动登录。

◆ setAutoTransferMessageAttachments()

void com.hyphenate.chat.EMOptions.setAutoTransferMessageAttachments ( boolean  transfer)

设置是否自动将消息附件上传到 Chat 服务器。

参数
transfer是否自动上传到 Chat 服务器。
  • （默认）true：自动使用 Chat 服务器上传下载；
  • false：不自动使用 Chat 服务器上传下载，自定义上传下载路径。

◆ setDeleteMessagesAsExitChatRoom()

void com.hyphenate.chat.EMOptions.setDeleteMessagesAsExitChatRoom ( boolean  delete)

设置退出(主动和被动退出)聊天室时是否删除聊天消息。

参数
delete- （默认）true：退出聊天室时删除聊天室相关消息记录。
  • false：离开聊天室时保留会话记录。

◆ setDeleteMessagesAsExitGroup()

void com.hyphenate.chat.EMOptions.setDeleteMessagesAsExitGroup ( boolean  delete)

设置退出(主动和被动退出)群组时是否删除聊天消息。

参数
delete
  • （默认）true: 退出群组时删除群组消息。
  • false: 退出群组时不删除群组消息。

◆ setDnsUrl()

void com.hyphenate.chat.EMOptions.setDnsUrl ( String  dnsUrl)

设置 DNS 地址。

参数
dnsUrlDNS 地址。

◆ setEnableStatistics()

void com.hyphenate.chat.EMOptions.setEnableStatistics ( boolean  enableStatistics)

设置是否启用统计。 需要在调用 EMClient#init(Context, EMOptions) 之前进行设置。

参数
enableStatistics是否启用统计。
  • true：启用统计；
  • （默认）false：不启用统计。

◆ setFixedHBInterval()

void com.hyphenate.chat.EMOptions.setFixedHBInterval ( int  interval)

设置固定的心跳间隔，不设置时会自动探测最佳心跳间隔。

参数
interval心跳时间间隔，单位为秒，建议范围为 30s~300s 之间。

◆ setFpaEnable()

void com.hyphenate.chat.EMOptions.setFpaEnable ( boolean  fpaEnable)

设置是否开启fpa。

参数
fpaEnable是否开启fpa。
  • （默认）false：不开启。
  • true：开启。

◆ setImPort()

void com.hyphenate.chat.EMOptions.setImPort ( int  imPort)

设置 im 消息服务器端口号，一般为私有部署服务，在开发者想实现数据隔离、特别注重数据安全时使用，如有需求请联系商务。

参数
imPort端口号。

◆ setIMServer()

void com.hyphenate.chat.EMOptions.setIMServer ( String  imServer)

设置 im 消息服务器地址，一般为私有部署服务，在开发者想实现数据隔离、特别注重数据安全时使用，如有需求请联系商务。

参数
imServerim 消息服务器地址。

◆ setPushConfig()

void com.hyphenate.chat.EMOptions.setPushConfig ( EMPushConfig  pushConfig)

设置推送相关配置。

参数
pushConfig推送相关配置。

◆ setReportServer()

void com.hyphenate.chat.EMOptions.setReportServer ( String  reportServer)

设置数据上报服务器地址，一般为私有部署服务，在开发者想实现数据隔离、特别注重数据安全时使用，如有需求请联系商务。

参数
reportServer数据上报服务器地址。

◆ setRequireAck()

void com.hyphenate.chat.EMOptions.setRequireAck ( boolean  requireAck)

设置是否需要接受方发送已读回执。

参数
requireAck是否需要接收方发送已读回执。
  • （默认）true：需要发送已读回执；
  • false：不需要发送已读回执。

◆ setRequireDeliveryAck()

void com.hyphenate.chat.EMOptions.setRequireDeliveryAck ( boolean  requireDeliveryAck)

设置是否需要接受方发送送达回执。

参数
requireDeliveryAck是否需要送达回执。
  • （默认）true：需要送达回执。
  • false：不需要发送送达回执。

◆ setRestServer()

void com.hyphenate.chat.EMOptions.setRestServer ( String  restServer)

设置 REST 服务器地址，一般在开发者想实现数据隔离、特别注重数据安全时使用，如有需求请联系商务获取指定的服务器地址。

参数
restServerREST 服务器地址。

◆ setSortMessageByServerTime()

void com.hyphenate.chat.EMOptions.setSortMessageByServerTime ( boolean  sortByServerTime)

设置是否按照服务器收到的时间对消息进行排序。

参数
sortByServerTime是否按照服务器收到的时间对消息进行排序。
  • （默认）true：按服务器收到消息时间进行排序；
  • false：不按服务器收到消息时间进行排序。

◆ setUsingHttpsOnly()

void com.hyphenate.chat.EMOptions.setUsingHttpsOnly ( boolean  _usingHttpsOnly)

设置只使用 HTTPS 进行 REST 操作。

参数
_usingHttpsOnly是否只使用 HTTPS。
  • （默认）true：只使用 HTTPS 进行 REST 操作；
  • false：可以使用 HTTPS 和 HTTP 进行 REST 操作。
该类的文档由以下文件生成:
制作者 doxygen 1.9.2