hyphenate_SDK3.0  3.8.5
hyphenatejavaIMSDK
Public 成员函数 | 所有成员列表
com.hyphenate.chat.EMOptions类 参考

Public 成员函数

boolean getRequireAck ()
 
void setRequireAck (boolean requireAck)
 
boolean getRequireDeliveryAck ()
 
void setRequireDeliveryAck (boolean requireDeliveryAck)
 
boolean getAcceptInvitationAlways ()
 
void setAcceptInvitationAlways (boolean value)
 
void setDeleteMessagesAsExitGroup (boolean delete)
 
boolean isDeleteMessagesAsExitGroup ()
 
void setAutoAcceptGroupInvitation (boolean value)
 
boolean isAutoAcceptGroupInvitation ()
 
void allowChatroomOwnerLeave (boolean allowed)
 
boolean isChatroomOwnerLeaveAllowed ()
 
void setDeleteMessagesAsExitChatRoom (boolean delete)
 
boolean isDeleteMessagesAsExitChatRoom ()
 
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 ()
 
String getFCMNumber ()
 
void setFCMNumber (String number)
 
boolean isUseFCM ()
 
void setUseFCM (boolean useFCM)
 
void setMipushConfig (String mipushAppid, String mipushAppkey)
 
EMChatConfigPrivate.EMMipushConfig getMipushConfig ()
 
void enableDNSConfig (boolean enable)
 
boolean getEnableDNSConfig ()
 
void setUseHttps (boolean _useHttps)
 
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)
 

详细描述

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

成员函数说明

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

设置是否允许聊天室owner离开并删除会话记录 设置为true后owner不再接受任何消息

参数
allowed是否允许聊天室owner离开
void com.hyphenate.chat.EMOptions.enableDNSConfig ( boolean  enable)

设置是否关闭DNS 默认为true,私有云部署需要关闭

参数
enable是否关闭DNS
boolean com.hyphenate.chat.EMOptions.getAcceptInvitationAlways ( )

获取是否自动接受加好友邀请,缺省值为true

返回
是否自动接受加好友邀请
String com.hyphenate.chat.EMOptions.getAccessToken ( )

获取本地保存的访问令牌

返回
访问令牌
String com.hyphenate.chat.EMOptions.getAccessToken ( boolean  b)

是否从服务器获取访问令牌

参数
b是否从服务器获取
返回
访问令牌
String com.hyphenate.chat.EMOptions.getAppKey ( )

获取appkey

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

获取是否自动下载缩略图,默认为true

返回
是否自动下载缩略图
boolean com.hyphenate.chat.EMOptions.getAutoLogin ( )

获取是否自动登录

返回
返回true表示已设置为自动登录
boolean com.hyphenate.chat.EMOptions.getAutoTransferMessageAttachments ( )

获取是否使用Chat服务器进行上传下载,默认值是true

返回
布尔值,是否上传到Chat服务器
String com.hyphenate.chat.EMOptions.getDnsUrl ( )

获取dns地址

返回
dns 地址
boolean com.hyphenate.chat.EMOptions.getEnableDNSConfig ( )

获取是否关闭DNS,默认为true

返回
返回是否关闭DNS
String com.hyphenate.chat.EMOptions.getFCMNumber ( )

获取FCM(GCM升级版->FCM)推送id

弃用:
使用 EMPushConfig#getFcmSenderId() 代替
int com.hyphenate.chat.EMOptions.getFixedInterval ( )

获取固定的心跳间隔

返回
心跳时间间隔,单位为秒
int com.hyphenate.chat.EMOptions.getImPort ( )

获取设置的im 服务器端口号

返回
端口号
String com.hyphenate.chat.EMOptions.getImServer ( )

获取设置的im 服务器地址

返回
im服务器地址
EMChatConfigPrivate.EMMipushConfig com.hyphenate.chat.EMOptions.getMipushConfig ( )

获取用于小米推送的appid和appkey

弃用:
使用 EMPushConfig#getMiAppId() 代替
EMPushConfig com.hyphenate.chat.EMOptions.getPushConfig ( )

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

返回
推送配置
String com.hyphenate.chat.EMOptions.getReportServer ( )

获取设置的数据上报服务器地址

返回
数据上报服务器地址,有可能为空
boolean com.hyphenate.chat.EMOptions.getRequireAck ( )

获取已读确认设置,缺省值为true 如果设为true,会要求消息的接受方发送已读回执。

返回
是否要求消息的接收方发送已读回执
boolean com.hyphenate.chat.EMOptions.getRequireDeliveryAck ( )

获取送达确认设置,缺省值为false 如果设为true,会要求消息的接受方发送送达回执

返回
是否需要送达回执
String com.hyphenate.chat.EMOptions.getRestServer ( )

获取设置的rest 服务器地址

返回
rest服务器地址
boolean com.hyphenate.chat.EMOptions.getUsingHttpsOnly ( )

获取是否只使用https进行REST操作,默认值是false

返回
是否只使用https
String com.hyphenate.chat.EMOptions.getVersion ( )

获取SDK版本号

返回
SDK版本号
boolean com.hyphenate.chat.EMOptions.isAutoAcceptGroupInvitation ( )

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

返回
返回是否自动接受加群邀请
boolean com.hyphenate.chat.EMOptions.isChatroomOwnerLeaveAllowed ( )

获取是否允许聊天室owner离开

返回
true:离开并不保留会话记录;false:离开保留会话记录
boolean com.hyphenate.chat.EMOptions.isDeleteMessagesAsExitChatRoom ( )

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

返回
返回true表示删除群组相关消息记录,默认为true
boolean com.hyphenate.chat.EMOptions.isDeleteMessagesAsExitGroup ( )

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

返回
true为删除群组相关消息
boolean com.hyphenate.chat.EMOptions.isEnableStatistics ( )

是否启动统计

返回
布尔值
boolean com.hyphenate.chat.EMOptions.isSortMessageByServerTime ( )

是否按照服务器收到时间进行排序,默认是false

返回
返回是否按照服务器收到的时间排序
boolean com.hyphenate.chat.EMOptions.isUseFCM ( )

获取是否使用谷歌FCM推送

弃用:
FCM推送转移到应用层,不再需要此api
void com.hyphenate.chat.EMOptions.setAcceptInvitationAlways ( boolean  value)

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

参数
value是否自动接受加好友邀请
void com.hyphenate.chat.EMOptions.setAppKey ( String  appkey)

设置appkey

参数
appkey
void com.hyphenate.chat.EMOptions.setAutoAcceptGroupInvitation ( boolean  value)

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

参数
value
void com.hyphenate.chat.EMOptions.setAutoDownloadThumbnail ( boolean  autodownload)

是否自动下载缩略图 默认是true,自动下载

参数
autodownload布尔值,是否自动下载缩略图
void com.hyphenate.chat.EMOptions.setAutoLogin ( boolean  autoLogin)

设置自动登录

参数
autoLogin
void com.hyphenate.chat.EMOptions.setAutoTransferMessageAttachments ( boolean  transfer)

是否自动将消息附件上传到Chat服务器 默认为true,使用Chat服务器上传下载

参数
transfer是否上传到Chat服务器
void com.hyphenate.chat.EMOptions.setDeleteMessagesAsExitChatRoom ( boolean  delete)

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

参数
deletetrue为删除聊天室相关消息记录
void com.hyphenate.chat.EMOptions.setDeleteMessagesAsExitGroup ( boolean  delete)

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

参数
deleteTrue为删除群组相关消息,默认值为true
void com.hyphenate.chat.EMOptions.setDnsUrl ( String  dnsUrl)

设置dns地址

参数
dnsUrl
void com.hyphenate.chat.EMOptions.setEnableStatistics ( boolean  enableStatistics)

设置是否启用统计

参数
enableStatistics
void com.hyphenate.chat.EMOptions.setFCMNumber ( String  number)

设置FCM(GCM升级版->FCM)推送id

参数
numberFCM 推送ID
弃用:
使用 EMPushConfig.Builder#enableFCM(String) 代替
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
void com.hyphenate.chat.EMOptions.setMipushConfig ( String  mipushAppid,
String  mipushAppkey 
)

设置用于小米推送的appid和appkey

参数
mipushAppid小米推送的appid
mipushAppkey小米推送的appkey
弃用:
使用 EMPushConfig.Builder#enableMiPush(String, String) 代替
void com.hyphenate.chat.EMOptions.setPushConfig ( EMPushConfig  pushConfig)

设置推送相关配置

参数
pushConfig推送相关配置
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)

设置是否需要接受方送达确认,默认false

参数
requireDeliveryAck是否需要送达确认
void com.hyphenate.chat.EMOptions.setRestServer ( String  restServer)

设置rest 服务器地址

参数
restServer
void com.hyphenate.chat.EMOptions.setSortMessageByServerTime ( boolean  sortByServerTime)

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

参数
sortByServerTime
void com.hyphenate.chat.EMOptions.setUseFCM ( boolean  useFCM)

设置是否开启谷歌FCM推送

参数
useFCM谷歌FCM推送开关
弃用:
FCM推送转移到应用层,不再需要此api
void com.hyphenate.chat.EMOptions.setUseHttps ( boolean  _useHttps)

允许使用https协议,默认值是true

参数
_useHttps是否使用https协议
弃用:
使用 setUsingHttpsOnly(boolean) 代替
void com.hyphenate.chat.EMOptions.setUsingHttpsOnly ( boolean  _usingHttpsOnly)

只使用https进行REST操作

参数
_usingHttpsOnly是否只使用https

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