hyphenate_SDK4.0 4.2.3-lite
hyphenate java IM SDK
|
Public Member Functions | |
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) |
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.
void com.hyphenate.chat.EMOptions.allowChatroomOwnerLeave | ( | boolean | allowed | ) |
Sets whether to allow the chat room owner to leave the chat room.
allowed | Whether to allow the owner of chat room to leave.
|
boolean com.hyphenate.chat.EMOptions.canChatroomOwnerLeave | ( | ) |
Gets whether to allow owner of chat room to leave.
true
: allow owner of chat room to leave;false
: do not allow owner of chat room to leave. boolean com.hyphenate.chat.EMOptions.deleteMessagesOnLeaveChatroom | ( | ) |
Gets whether to delete the chat room message when leaving the chat room.
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. void com.hyphenate.chat.EMOptions.enableDNSConfig | ( | boolean | enable | ) |
Sets whether to disable DNS.
true
: Disable DNS;false
: Do not disable DNS. String com.hyphenate.chat.EMOptions.getAccessToken | ( | ) |
Gets the access token from the local database.
String com.hyphenate.chat.EMOptions.getAccessToken | ( | boolean | b | ) |
Whether to get the access token from the server.
b | Whether to get the access token from server.
|
String com.hyphenate.chat.EMOptions.getAppKey | ( | ) |
Gets the app key.
boolean com.hyphenate.chat.EMOptions.getAutodownloadThumbnail | ( | ) |
Gets whether to download the thumbnail automatically.
true
: Download the thumbnail automatically;false
: Do not download the thumbnail automatically. boolean com.hyphenate.chat.EMOptions.getAutoLogin | ( | ) |
Checks whether the automatic login is enabled.
true
: Automatic login is enabled;false
: Automatic login is disabled. boolean com.hyphenate.chat.EMOptions.getAutoTransferMessageAttachments | ( | ) |
Gets whether to upload the message attachments automatically to the chat server.
true
: Use the default way to upload and download the message attachments by chat server;false
: Do not use the default way to upload and download the message attachments by chat server, using a customized path instead. String com.hyphenate.chat.EMOptions.getDnsUrl | ( | ) |
Gets the DNS url.
boolean com.hyphenate.chat.EMOptions.getEnableDNSConfig | ( | ) |
Gets whether to disable DNS.
true
: Disable DNS;false
: Do not disable DNS.int com.hyphenate.chat.EMOptions.getFixedInterval | ( | ) |
Gets the fixed heart beat interval.
int com.hyphenate.chat.EMOptions.getImPort | ( | ) |
Gets the im server port.
String com.hyphenate.chat.EMOptions.getImServer | ( | ) |
Gets the im server url.
String com.hyphenate.chat.EMOptions.getReportServer | ( | ) |
Gets the report server.
boolean com.hyphenate.chat.EMOptions.getRequireAck | ( | ) |
Gets whether the read receipt is required by the message receiver.
true
: The read receipt is required;false
: The read receipt is not required. boolean com.hyphenate.chat.EMOptions.getRequireDeliveryAck | ( | ) |
Gets whether the delivery receipt is required.
true
: The read receipt is required;false
: The read receipt is not required. String com.hyphenate.chat.EMOptions.getRestServer | ( | ) |
Gets the REST server.
boolean com.hyphenate.chat.EMOptions.getUsingHttpsOnly | ( | ) |
Gets whether only HTTPS is used for REST operations.
true
: Only HTTPS is used;false
: Both HTTP and HTTPS can be used. String com.hyphenate.chat.EMOptions.getVersion | ( | ) |
Gets the SDK version.
boolean com.hyphenate.chat.EMOptions.isLoadEmptyConversations | ( | ) |
Checks whether to include empty conversations when the SDK loads conversations from server.
false
: Empty conversations are excluded.true
: Empty conversations are included. boolean com.hyphenate.chat.EMOptions.isSortMessageByServerTime | ( | ) |
Gets whether to sort messages by the server received time.
true
: Sort messages by the server received time;false
: Do not sort messages by the server received time. void com.hyphenate.chat.EMOptions.setAppKey | ( | String | appkey | ) |
Sets the app key.
appkey | The app key you got from the console when create an app. |
void com.hyphenate.chat.EMOptions.setAutoDownloadThumbnail | ( | boolean | autodownload | ) |
Sets whether to auto download the thumbnail.
autodownload | Whether to download the thumbnail automatically.
|
void com.hyphenate.chat.EMOptions.setAutoLogin | ( | boolean | autoLogin | ) |
Enables/Disables automatic login.
autoLogin |
|
void com.hyphenate.chat.EMOptions.setAutoTransferMessageAttachments | ( | boolean | transfer | ) |
Sets whether to upload the message attachments automatically to the chat server.
transfer | Whether to upload the message attachments to the chat server.
|
void com.hyphenate.chat.EMOptions.setDeleteMessagesAsExitChatRoom | ( | boolean | delete | ) |
Sets whether to delete the chat room message when leaving the chat room.
delete | -(Default)true : Delete the chat room related message record when leaving the chat room.
|
void com.hyphenate.chat.EMOptions.setDnsUrl | ( | String | dnsUrl | ) |
Sets the DNS url.
dnsUrl | The DNS url. |
void com.hyphenate.chat.EMOptions.setFixedHBInterval | ( | int | interval | ) |
Sets a fixed heartbeat interval. If not set, the optimal heartbeat interval is automatically detected.
interval | The interval of heart beat, in seconds (30~300). |
void com.hyphenate.chat.EMOptions.setImPort | ( | int | imPort | ) |
Sets the custom im server port.
imPort | The im server port. |
void com.hyphenate.chat.EMOptions.setIMServer | ( | String | imServer | ) |
Sets the custom im message server url.
imServer | The im message server url. |
void com.hyphenate.chat.EMOptions.setLoadEmptyConversations | ( | boolean | isLoadEmptyConversations | ) |
Sets whether to include empty conversations when the SDK loads conversations from server.
As for the call sequence, this method comes before EMClient#init(Context, EMOptions).
isLoadEmptyConversations | Whether to include empty conversations when the SDK loads conversations from server:
|
void com.hyphenate.chat.EMOptions.setReportServer | ( | String | reportServer | ) |
Sets the custom report server.
reportServer | The report server url. |
void com.hyphenate.chat.EMOptions.setRequireAck | ( | boolean | requireAck | ) |
Sets whether to require the read receipt.
requireAck | Whether the read receipt is required.
|
void com.hyphenate.chat.EMOptions.setRequireDeliveryAck | ( | boolean | requireDeliveryAck | ) |
Sets whether the delivery receipt is required.
requireDeliveryAck | Whether the delivery receipt is required.
|
void com.hyphenate.chat.EMOptions.setRestServer | ( | String | restServer | ) |
Sets the custom REST server.
restServer | The REST server url. |
void com.hyphenate.chat.EMOptions.setSortMessageByServerTime | ( | boolean | sortByServerTime | ) |
Sets whether to sort messages by server received time.
sortByServerTime |
|
void com.hyphenate.chat.EMOptions.setUsingHttpsOnly | ( | boolean | _usingHttpsOnly | ) |
Sets whether only HTTPS is used for REST operation.
_usingHttpsOnly | Whether only HTTPS is used.
|