hyphenate_SDK3.0 3.7.6.3
hyphenate java IM SDK
Public Member Functions | List of all members
com.hyphenate.chat.EMOptions Class Reference

Public Member Functions

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)
 
void setImPort (int imPort)
 
void setRestServer (String restServer)
 
String getReportServer ()
 
void setReportServer (String reportServer)
 
String getRestServer ()
 
String getImServer ()
 
int getImPort ()
 
String getRtcServer ()
 
void setRtcServer (String rtcServer)
 
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 ()
 
boolean isUseStereoInput ()
 
void setUseStereoInput (boolean useStereoInput)
 
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 setUseRtcConfig (boolean useRtcConfig)
 
boolean getUseRtcConfig ()
 
void setRtcConfigUrl (String rtcConfigUrl)
 
String getRtcConfigUrl ()
 

Detailed Description

chat options for IM enable/disable delivery ack, enable/disable server ack, enable/disable hyphenate friend management, etc..

Member Function Documentation

◆ allowChatroomOwnerLeave()

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

enable/disable allowing chat room owner to leave the chat room

Parameters
allowedif allow the owner of chat room leave

◆ getAcceptInvitationAlways()

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

get if accept the other's invitation to be your friend automatically

Returns
if accept invitation automatically

◆ getAppKey()

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

get app key

◆ getAutodownloadThumbnail()

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

is Auto download thumbnail, default value is true.

◆ getAutoLogin()

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

get login automatically

Returns

◆ getAutoTransferMessageAttachments()

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

Use Easemob sever to upload and download, default value is true.

◆ getFCMNumber()

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

get FCM sender id

@Deprecated Use EMPushConfig#getFcmSenderId() for instead.

◆ getImPort()

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

get the im server port

Returns

◆ getImServer()

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

get the im server

Returns

◆ getMipushConfig()

EMChatConfigPrivate.EMMipushConfig com.hyphenate.chat.EMOptions.getMipushConfig ( )

get the appid and appkey for Xiaomi Push

@Deprecated Use EMPushConfig#getMiAppId() and EMPushConfig#getMiAppKey() for instead.

◆ getReportServer()

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

get the report server

Returns

◆ getRequireAck()

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

get whether read ack is required for the message receiver.

Returns
whether read ack is required

◆ getRequireDeliveryAck()

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

get if delivery ack is required

Returns
if delivery ack is required

◆ getRestServer()

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

get the rest server

Returns

◆ getUsingHttpsOnly()

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

Only use https for rest operation, default value is false

Returns

◆ isAutoAcceptGroupInvitation()

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

get if accept group invitation automatically

Returns

◆ isChatroomOwnerLeaveAllowed()

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

if allow owner of chat room leave

Returns
true–do not keep conversation when leave

◆ isDeleteMessagesAsExitChatRoom()

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

get if deleting the chat room message after existing the chat room

Returns
true–delete the messages

◆ isDeleteMessagesAsExitGroup()

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

get if deleting the group message after existing the group

Returns
true–delete the messages

◆ isSortMessageByServerTime()

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

whether sort messages by server received time, default value is false

◆ isUseFCM()

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

Whether to use Google FCM push

◆ isUseStereoInput()

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

Set if use stereo input, should be set before init().

Parameters
useStereoInput

◆ setAcceptInvitationAlways()

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

enable/disable accept the friend invitation automatically

Parameters
value

◆ setAppKey()

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

set app key

Parameters
appkey

◆ setAutoAcceptGroupInvitation()

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

set if accept group invitation automatically

Parameters
value

◆ setAutoDownloadThumbnail()

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

Set Whether auto download thumbnail, default value is true.

Parameters
autodownload

◆ setAutoLogin()

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

set login automatically

Parameters
autoLogin

◆ setAutoTransferMessageAttachments()

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

Whether the message attachment is automatically uploaded to the Hyphenate server, default value is true, the default way to upload and download by Easemob.

Parameters
transfer

◆ setDeleteMessagesAsExitChatRoom()

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

enable/disable deleting the chat room message after existing the chat room

Parameters
deletetrue–delete the messages, default is true

◆ setDeleteMessagesAsExitGroup()

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

enable/disable deleting the group message after existing the group

Parameters
deletetrue–delete the messages, default is true

◆ setFCMNumber()

void com.hyphenate.chat.EMOptions.setFCMNumber ( String  number)

set FCM sender id

Parameters
number– FCM sender id

@Deprecated Use EMPushConfig.Builder#enableFCM(String) for instead.

◆ setImPort()

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

set the custom im server port, default is 443

Parameters
imPort

◆ setIMServer()

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

set the custom im server

Parameters
imServer

◆ setMipushConfig()

void com.hyphenate.chat.EMOptions.setMipushConfig ( String  mipushAppid,
String  mipushAppkey 
)

set the appid and appkey for Xiaomi Push

Parameters
mipushAppid
mipushAppkey

@Deprecated Use EMPushConfig.Builder#enableMiPush(String, String) for instead.

◆ setReportServer()

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

set the custom report server

Parameters
reportServer

◆ setRequireAck()

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

enable/disable the read ack of receipt

Parameters
requireAck

◆ setRequireDeliveryAck()

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

enable/disable deliver ack

Parameters
requireDeliveryAck

◆ setRestServer()

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

set the custom rest server

Parameters
restServer

◆ setRtcConfigUrl()

void com.hyphenate.chat.EMOptions.setRtcConfigUrl ( String  rtcConfigUrl)

Set audio and video multi-cluster deployment rtcConfigUrl

Parameters
rtcConfigUrl

◆ setRtcServer()

void com.hyphenate.chat.EMOptions.setRtcServer ( String  rtcServer)

set the custom RTC server

Parameters
rtcServer

◆ setUseFCM()

void com.hyphenate.chat.EMOptions.setUseFCM ( boolean  useFCM)

Enable or disable Google FCM push

Parameters
useFCM– Google FCM push switch

◆ setUseHttps()

void com.hyphenate.chat.EMOptions.setUseHttps ( boolean  _useHttps)
Deprecated:
allow use https for rest operation, default value is true

◆ setUseRtcConfig()

void com.hyphenate.chat.EMOptions.setUseRtcConfig ( boolean  useRtcConfig)

Sets whether audio-video multi-cluster deployment is enabled

Parameters
useRtcConfig

◆ setUsingHttpsOnly()

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

Only use https for rest operation, default value is false

Parameters
_usingHttpsOnly

The documentation for this class was generated from the following file: