hyphenate_SDK4.0 4.8.0
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 ()
 
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 ()
 
int getCustomOSPlatform ()
 
void setCustomOSPlatform (int platform)
 
String getCustomDeviceName ()
 
void setCustomDeviceName (@NonNull String customDeviceName)
 
void setLoginCustomExt (@NonNull String ext)
 
String getLoginCustomExt ()
 
boolean isLoadEmptyConversations ()
 
void setLoadEmptyConversations (boolean isLoadEmptyConversations)
 
boolean isUseReplacedMessageContents ()
 
void setUseReplacedMessageContents (boolean useReplacedMessageContents)
 
boolean isIncludeSendMessageInMessageListener ()
 
void setIncludeSendMessageInMessageListener (boolean include)
 
boolean regardImportedMsgAsRead ()
 
void setRegardImportedMsgAsRead (boolean regardImportedMsgAsRead)
 
void setNativeLibBasePath (@NonNull String path)
 
String getNativeLibBasePath ()
 
void setEnableTLSConnection (boolean enableTLSConnection)
 
boolean isEnableTLSConnection ()
 
void setAutoLoadAllConversations (boolean autoLoadAllConversations)
 
boolean isAutoLoadAllConversations ()
 

Detailed Description

The settings of the chat SDK.

You can set parameters and options of the SDK.

For example, whether to encrypt the messages before sending, whether to automatically accept the friend invitations.

Member Function Documentation

◆ allowChatroomOwnerLeave()

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

Sets whether to allow the chat room owner to leave the chat room.

Parameters
allowedWhether to allow the chat room owner to leave the chat room.
  • (Default)true: Yes. Even if the chat room owner leaves the chat room, the owner still has all privileges, except for receiving messages in the chat room.
  • false: No. The chat room owner cannot leave the chat room.

◆ autoAcceptGroupInvitations()

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

Gets whether to accept group invitations automatically.

Returns
Returns the result of whether to accept group invitation automatically.
  • (Default)true: Accept group invitations automatically.
  • false: Do not accept group invitations automatically.

◆ canChatroomOwnerLeave()

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

Gets whether to allow owner of chat room to leave.

Returns
- (Default)true: Yes.
  • false: No. The chat room owner cannot leave the chat room.

◆ deleteMessagesOnLeaveChatroom()

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

Gets whether to delete the chat room message when leaving the chat room.

Returns
- (Default)true: Delete the chat room related message record when leaving the chat room.
  • false: Do not delete the chat room related message record when leaving the chat room.

◆ deleteMessagesOnLeaveGroup()

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

Gets whether to delete the group message when leaving a group.

Returns
- (Default)true: Delete the messages when leaving a group.
  • false: Do not delete the messages when leaving a group.

◆ enableDNSConfig()

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

Sets whether to disable DNS.

Parameters
enableWhether to disable DNS:
  • (Default)true: Disable DNS;
  • false: Do not disable DNS.

◆ getAcceptInvitationAlways()

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

Gets whether to accept other user's friend invitations automatically.

Returns
Whether to accept friend invitation automatically.
  • (Default)true: Accepting friend invitation automatically.
  • false: Do not accepting friend invitation automatically.

◆ getAccessToken() [1/2]

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

Gets the access token from the local database.

Returns
The access token.

◆ getAccessToken() [2/2]

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

Whether to get the access token from the server.

Parameters
bWhether to get the access token from server.
  • (Default) true: Get the access token from server.
  • false: Do not get the access token from server.
Returns
The access token.

◆ getAppKey()

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

Gets the app key.

◆ getAreaCode()

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

Gets the area code.

This parameter is used to restrict the scope of accessible edge nodes.

Returns
The area code.

◆ getAutodownloadThumbnail()

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

Gets whether to download the thumbnail automatically.

Returns
Whether to download the thumbnail automatically.
  • (Default)true: Download the thumbnail automatically;
  • false: Do not download the thumbnail automatically.

◆ getAutoLogin()

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

Checks whether the automatic login is enabled.

Returns
- (Default)true: Automatic login is enabled;
  • false: Automatic login is disabled.

◆ getAutoTransferMessageAttachments()

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

Gets whether to upload the message attachments automatically to the chat server.

Returns
Whether to upload the message attachments automatically to the chat server.
  • (Default)true: Yes.
  • false: No. A custom path is used to for uploading.

◆ getCustomDeviceName()

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

Gets the custom name of the current device.

Returns
The custom name of the current device.

◆ getCustomOSPlatform()

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

Gets the custom platform code of a login device.

Returns
The custom platform code of the login device.

◆ getDnsUrl()

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

Gets the DNS url.

Returns
The DNS url.

◆ getEnableDNSConfig()

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

Gets whether to disable DNS.

  • (Default) true: Disable DNS;
  • false: Do not disable DNS.
Returns
Returns whether to disable DNS.

◆ getFixedInterval()

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

Gets the fixed heartbeat interval.

Returns
The heartbeat interval in seconds.

◆ getImPort()

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

Gets the custom IM server port.

Returns
The custom IM server port.

◆ getImServer()

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

Gets the custom IM message server URL.

Returns
The custom IM message server URL.

◆ getLoginCustomExt()

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

Gets the custom device extension information.

Returns
The custom device extension information.

◆ getNativeLibBasePath()

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

Gets the path of native library.

Returns
The specified path of native library. If the path is not set, it is empty.

◆ getPushConfig()

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

Gets the push configurations.

◆ getReportServer()

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

Gets the URL of the custom server for data reporting.

Returns
The URL of the server for data reporting, which may be null.

◆ getRequireAck()

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

Gets whether the read receipt is required by the message receiver.

Returns
Whether the read receipt is required.
  • (Default) true: The read receipt is required;
  • false: The read receipt is not required.

◆ getRequireDeliveryAck()

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

Gets whether the delivery receipt is required.

Returns
Whether the delivery receipt is required.
  • (Default)true: The read receipt is required;
  • false: The read receipt is not required.

◆ getRestServer()

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

Gets the custom REST server URL.

Returns
The custom REST server URL.

◆ getUsingHttpsOnly()

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

Gets whether only HTTPS is used for REST operations.

Returns
Whether only HTTPS is used for REST operations.
  • (Default) true: Only HTTPS is used;
  • false: Both HTTP and HTTPS can be used.

◆ getVersion()

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

Gets the SDK version.

Returns
The SDK version.

◆ isAutoAcceptGroupInvitation()

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

Gets whether to accept a group invitation automatically.

Returns
Returns the result of whether to accept group invitation automatically.
  • (Default)true: Accept group invitations automatically;
  • false: Do not accept group invitations automatically.
Deprecated:
Use EMOptions#autoAcceptGroupInvitations() instead.

◆ isAutoLoadAllConversations()

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

Gets whether to automatically load all conversations into the memory upon a successful login.

Returns
Whether to automatically load all conversations.
  • (Default)true: Automatically load all conversations.
  • false: Do not automatically load all conversations.

◆ isChatroomOwnerLeaveAllowed()

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

Gets whether to allow the owner of chat room to leave.

Returns
Whether to allow the owner of chat room to leave:
  • (Default)true: Yes. Even if the chat room owner leaves the chat room, the owner still has all privileges, except for receiving messages in the chat room.
  • false: When the owner leave do keep the conversation.
Deprecated:
Use EMOptions#canChatroomOwnerLeave() instead.

◆ isDeleteMessagesAsExitChatRoom()

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

Gets whether to delete the chat room message when leaving the chat room.

Returns
- (Default)true: Delete the chat room related message record when leaving the chat room.
  • false: Do not delete the chat room related message record when leaving the chat room.
Deprecated:
Use EMOptions#deleteMessagesOnLeaveChatroom() instead.

◆ isDeleteMessagesAsExitGroup()

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

Gets whether to delete the group message when leaving a group.

Returns
- (Default)true: Delete the messages when leaving a group.
  • false: Do not delete the messages when leaving a group.
Deprecated:
Use EMOptions#deleteMessagesOnLeaveGroup() instead.

◆ isEnableStatistics()

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

Checks whether the traffic statistics collection is enabled for local messages.

Returns
Whether the message traffic statistics collection is enabled:
  • true: Enabled;
  • (Default)false: Disabled.

◆ isEnableTLSConnection()

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

Gets whether the TLS connection is enabled.

Returns
Whether the TLS connection is enabled.
  • true: The TLS connection is enabled.
  • false: The TLS connection is disabled.

◆ isIncludeSendMessageInMessageListener()

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

Whether the sent message is included in EMMessageListener#onMessageReceived(java.util.List).

Returns
Whether the sent message is included in EMMessageListener#onMessageReceived(java.util.List).

◆ isLoadEmptyConversations()

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

Checks whether to include empty conversations when the SDK loads conversations from the local database.

Returns
Whether to include empty conversations when the SDK loads conversations from the local database.
  • (Default)false: Empty conversations are excluded.
  • true: Empty conversations are included.

◆ isSortMessageByServerTime()

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

Gets whether to sort messages by the time when the server received them.

Returns
Returns whether to sort messages by the time when the server received them.
  • (Default)true: Yes. Messages are sorted by the time when the server received them;
  • false: No. Messages are not sorted by the time when the server received them.

◆ isUseReplacedMessageContents()

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

Gets whether the server returns the sender the text message with the content replaced during text moderation.

Returns
Whether to return the adjusted message to the sender:
  • true: Yes.
  • (Default) false: No. The server returns the original message to the sender.

◆ regardImportedMsgAsRead()

boolean com.hyphenate.chat.EMOptions.regardImportedMsgAsRead ( )
   \~chinese
   是否将通过服务器导入的消息设置为已读:

   @return 是否将通过服务器导入的消息设置为已读:
   - `true`:将导入消息置为已读。
   - (默认)`false`:不将导入消息置为已读;

   \~english
   Whether to set messages from the server side as read.

   @return Whether to set messages from the server side as read:
   - `true`: Read. After the messages are imported, the number of unread messages obtained with `EMConversation#getUnreadMsgCount() remains unchanged.

remains unchanged.

◆ setAcceptInvitationAlways()

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

Sets whether to accept the friend invitation automatically.

Parameters
valueWhether to accept the friend invitation automatically.
  • (Default)true: Accepting friend invitation automatically.
  • false: Do not accepting friend invitation automatically.

◆ setAppKey()

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

Sets the app key.

Parameters
appkeyThe app key you got from the console when creating an app.

◆ setAreaCode()

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

Sets the area code.

Parameters
codeThe area code. This parameter is used to restrict the scope of accessible edge nodes. The default value is AREA_CODE_GLOB, indicating that no restriction is placed on the scope of accessible edge nodes. The parameter setting cannot be changed during the app runtime.

◆ setAutoAcceptGroupInvitation()

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

Sets whether to accept a group invitation automatically.

Parameters
valueWhether to accept group invitation automatically.
  • (Default)true: Accept group invitations automatically;
  • false: Do not accept group invitations automatically.

◆ setAutoDownloadThumbnail()

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

Sets whether to auto download the thumbnail.

Parameters
autodownloadWhether to download the thumbnail automatically.
  • (Default)true: Download the thumbnail automatically;
  • false: Do not download the thumbnail automatically.

◆ setAutoLoadAllConversations()

void com.hyphenate.chat.EMOptions.setAutoLoadAllConversations ( boolean  autoLoadAllConversations)

Sets whether to automatically load all conversations into the memory upon a successful login.

As for the call sequence, this method comes before EMClient#init(Context, EMOptions).

Parameters
autoLoadAllConversationsWhether to automatically load all conversations.
  • (Default)true: Automatically load all conversations.
  • false: Do not automatically load all conversations.

◆ setAutoLogin()

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

Enables/Disables automatic login.

Parameters
autoLogin
  • (Default)true: Enables automatic login;
  • false: Disables automatic login.

◆ setAutoTransferMessageAttachments()

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

Sets whether to upload the message attachments automatically to the chat server.

Parameters
transferWhether to automatically upload the message attachments to the chat server.
  • (Default) true: Yes.
  • false: No. A custom path is used to for uploading.

◆ setCustomDeviceName()

void com.hyphenate.chat.EMOptions.setCustomDeviceName ( @NonNull String  customDeviceName)

Sets a custom name for the current device.

Setting a custom name for the current device is intended to differentiate devices during multi-device login scenarios.

You can call EMClient#getLoggedInDevicesFromServer(String, String) to get the information of login devices of a specified account.

You can set the custom name for the current device before calling EMClient#init(Context, EMOptions).

Parameters
customDeviceNameThe custom name for the current device. The parameter value cannot be null or an empty string. The default value is the device model such as HUAWEICOL-AL10.

◆ setCustomOSPlatform()

void com.hyphenate.chat.EMOptions.setCustomOSPlatform ( int  platform)

Sets a custom platform code for the login device.

You need to set the custom platform code before calling EMClient#init(Context, EMOptions).

Parameters
platformThe custom platform code. The value range is 1-100.

◆ setDeleteMessagesAsExitChatRoom()

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

Sets whether to delete the chat room message when leaving the chat room.

Parameters
delete-(Default)true: Delete the chat room related message record when leaving the chat room.
  • false: Do not delete the chat room related message record when leaving the chat room.

◆ setDeleteMessagesAsExitGroup()

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

Sets whether to delete the group messages when leaving the group.

Parameters
delete
  • (Default)true: Delete the messages when leaving the group.
  • false: Do not delete the messages when leaving a group.

◆ setDnsUrl()

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

Sets the DNS url.

Parameters
dnsUrlThe DNS url.

◆ setEnableStatistics()

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

Sets whether to enable traffic statistics collection for local messages.

You need to enable traffic statistics collection before calling EMClient#init(Context, EMOptions).

Parameters
enableStatisticsWhether to enable the message traffic statistics collection:
  • true: Enable;
  • (Default)false: Disable.

◆ setEnableTLSConnection()

void com.hyphenate.chat.EMOptions.setEnableTLSConnection ( boolean  enableTLSConnection)

Sets whether to enable the TLS connection.

This setting is used only in private deployment.

As for the call sequence, this method comes before EMClient#init(Context, EMOptions).

Parameters
enableTLSConnectionWhether to enable the TLS connection.
  • true: Enables the TLS connection.
  • (Default)false: Disables the TLS connection.

◆ setFixedHBInterval()

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

Sets a fixed heartbeat interval.

If not set, the optimal heartbeat interval is automatically detected.

Parameters
intervalThe interval of heartbeat in seconds. The recommended value range is 30-300.

◆ setImPort()

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

Sets the custom IM server port.

Parameters
imPortThe custom IM server port.

◆ setIMServer()

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

Sets the custom IM message server URL.

Parameters
imServerThe custom IM message server URL.

◆ setIncludeSendMessageInMessageListener()

void com.hyphenate.chat.EMOptions.setIncludeSendMessageInMessageListener ( boolean  include)

Sets whether the sent message is included in EMMessageListener#onMessageReceived(java.util.List).

Parameters
includeWhether the sent message is included in EMMessageListener#onMessageReceived(java.util.List).

◆ setLoadEmptyConversations()

void com.hyphenate.chat.EMOptions.setLoadEmptyConversations ( boolean  isLoadEmptyConversations)

Sets whether to include empty conversations when the SDK loads conversations from the local database.

As for the call sequence, this method comes before EMClient#init(Context, EMOptions).

Parameters
isLoadEmptyConversationsWhether to include empty conversations when the SDK loads conversations from the local database:
  • true: Empty conversations are included.
  • (Default)false: Empty conversations are excluded.

◆ setLoginCustomExt()

void com.hyphenate.chat.EMOptions.setLoginCustomExt ( @NonNull String  ext)

Sets custom extension information for the current device.

If the SDK is not initialized or automatic login is used, you need to set the extension information of the current device before you call the method. If the SDK is initialized and manual login is used, you can set the extension information before your next call to the EMClient#login(String,String,EMCallBack) or EMClient#loginWithToken(String,String,EMCallBack) method.

Parameters
extThe custom extension information for the current device. The extension information can contain up to 1024 characters and cannot be null.

The extension information is contained in the notification sent to the device that is kicked offline due to the user's login to the current device.

◆ setNativeLibBasePath()

void com.hyphenate.chat.EMOptions.setNativeLibBasePath ( @NonNull String  path)

Sets the path of the native library.

Parameters
pathThe path of the native library.
  • If the path is empty or the method is not called, the SDK will use system.loadLibrary to search for and load the so library from the default library path.
  • If the path is not empty, the SDK will use System.load to search for and load the so library from the specified path. The path must be a valid private directory path of the app.
  • This method needs to be called before init.

◆ setPushConfig()

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

Sets the push options.

Parameters
pushConfigThe push configuration.

◆ setRegardImportedMsgAsRead()

void com.hyphenate.chat.EMOptions.setRegardImportedMsgAsRead ( boolean  regardImportedMsgAsRead)

Sets whether to set messages from the server side as read.

Parameters
regardImportedMsgAsReadWhether to set messages from the server side as read:
  • true: Read. After the messages are imported, the number of unread messages obtained with EMConversation#getUnreadMsgCount() remains unchanged.
  • (Default)false: Unread. After the messages are imported, the number of unread messages obtained withEMConversation::getUnreadMsgCount() is increased.

◆ setReportServer()

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

Sets the URL of the custom server for data reporting.

Parameters
reportServerThe URL of the custom server for data reporting.

◆ setRequireAck()

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

Sets whether to require the read receipt.

Parameters
requireAckWhether the read receipt is required.
  • (Default) true: The read receipt is required;
  • false: The read receipt is not required.

◆ setRequireDeliveryAck()

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

Sets whether the delivery receipt is required.

Parameters
requireDeliveryAckWhether the delivery receipt is required.
  • (Default)true: The delivery receipt is required;
  • false: The delivery receipt is not required.

◆ setRestServer()

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

Sets the custom REST server URL.

Parameters
restServerThe custom REST server URL.

◆ setSortMessageByServerTime()

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

Sets whether to sort messages by the time when the server received them.

Parameters
sortByServerTime
  • (Default)true: Sort messages by the time when the server received them;
  • false: Do not sort messages by the time when the server received them.

◆ setUseReplacedMessageContents()

void com.hyphenate.chat.EMOptions.setUseReplacedMessageContents ( boolean  useReplacedMessageContents)

Sets whether the server returns the sender the text message with the content replaced during text moderation:

As for the call sequence, this method comes before EMClient#init(Context, EMOptions).

Parameters
useReplacedMessageContentsWhether to return the adjusted message to the sender:
  • true: Yes.
  • (Default) false: No. The server returns the original message to the sender.

◆ setUsingHttpsOnly()

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

Sets whether only HTTPS is used for REST operation.

Parameters
_usingHttpsOnlyWhether only HTTPS is used.
  • (Default)true: Only HTTPS is used;
  • false: Both HTTP and HTTPS can be used.

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