hyphenate_SDK3.0 4.0.0
hyphenate java IM SDK
|
Classes | |
class | AreaCode |
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.autoAcceptGroupInvitations | ( | ) |
Gets whether to accept group invitations automatically.
true
: Accept group invitations automatically.false
: Do not accept group invitations automatically. boolean com.hyphenate.chat.EMOptions.canChatroomOwnerLeave | ( | ) |
Gets whether to allow owner of chat room to leave.
true
: When the owner leave, do not keep the conversation;false
: When the owner leave, do keep the conversation. 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. boolean com.hyphenate.chat.EMOptions.deleteMessagesOnLeaveGroup | ( | ) |
Gets whether to delete the group message when leaving a group.
true
: Delete the messages when leaving a group.false
: Do not delete the messages when leaving a group. void com.hyphenate.chat.EMOptions.enableDNSConfig | ( | boolean | enable | ) |
Sets whether to disable DNS.
true
: Disable DNS;false
: Do not disable DNS. boolean com.hyphenate.chat.EMOptions.getAcceptInvitationAlways | ( | ) |
Gets whether to accept other user's friend invitations automatically.
true
: Accepting friend invitation automatically.false
: Do not accepting friend invitation automatically. 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.
boolean com.hyphenate.chat.EMOptions.getFpaEnable | ( | ) |
Gets whether the fpa function is used.
false
: the fpa function is not used.true
: the fpa function is used; int com.hyphenate.chat.EMOptions.getImPort | ( | ) |
Gets the im server port.
String com.hyphenate.chat.EMOptions.getImServer | ( | ) |
Gets the im server url.
EMPushConfig com.hyphenate.chat.EMOptions.getPushConfig | ( | ) |
Gets the push configuration setting options by user.
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.isAutoAcceptGroupInvitation | ( | ) |
Gets whether to accept a group invitation automatically.
true
: Accept group invitations automatically;false
: Do not accept group invitations automatically.boolean com.hyphenate.chat.EMOptions.isChatroomOwnerLeaveAllowed | ( | ) |
Gets whether to allow the owner of chat room to leave.
true
: When the owner leave, do not keep the conversation;false
: When the owner leave do keep the conversation. boolean com.hyphenate.chat.EMOptions.isDeleteMessagesAsExitChatRoom | ( | ) |
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.boolean com.hyphenate.chat.EMOptions.isDeleteMessagesAsExitGroup | ( | ) |
Gets whether to delete the group message when leaving a group.
true
: Delete the messages when leaving a group.false
: Do not delete the messages when leaving a group.boolean com.hyphenate.chat.EMOptions.isEnableStatistics | ( | ) |
Gets whether to enable the statistics.
true
: Enable statistics;false
: Do not enable statistics. 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.setAcceptInvitationAlways | ( | boolean | value | ) |
Sets whether to accept the friend invitation automatically.
value | Whether to accept the friend invitation automatically.
|
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.setAreaCode | ( | int | code | ) |
sets area code, will follow the area when using edge node.
code | area code.
|
void com.hyphenate.chat.EMOptions.setAutoAcceptGroupInvitation | ( | boolean | value | ) |
Sets whether to accept a group invitation automatically.
value | Whether to accept group invitation automatically.
|
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.setDeleteMessagesAsExitGroup | ( | boolean | delete | ) |
Sets whether to delete the group messages when leaving the group.
delete |
|
void com.hyphenate.chat.EMOptions.setDnsUrl | ( | String | dnsUrl | ) |
Sets the DNS url.
dnsUrl | The DNS url. |
void com.hyphenate.chat.EMOptions.setEnableStatistics | ( | boolean | enableStatistics | ) |
Sets whether to enable statistics. Sets before calling EMClient#init(Context, EMOptions).
enableStatistics | Whether to enable statistics.
|
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.setFpaEnable | ( | boolean | fpaEnable | ) |
sets Whether to use fpa function.
fpaEnable | Whether to use fpa function.
|
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.setPushConfig | ( | EMPushConfig | pushConfig | ) |
Sets the push configuration.
pushConfig | The push configuration. |
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.
|