@asteriskzuo/react-native-easemob
Version:
easemob chat sdk of react-native.
146 lines (145 loc) • 4.61 kB
TypeScript
/**
* 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.
*/
export declare class ChatOptions {
/**
* The app key you got from the console when create an app.
*/
appKey: string;
/**
* Enables/Disables automatic login.
*
* `true`: (default) Enables automatic login;
* `false`: Disables automatic login.
*/
autoLogin: boolean;
/**
* Debug mode or not.
*/
debugModel: boolean;
/**
* Whether to accept friend invitations from other users automatically.
*
* `true`: (default) Accepts friend invitations automatically;
* `false`: Do not accept friend invitations automatically.
*/
acceptInvitationAlways: boolean;
/**
* Whether to accept group invitations automatically.
*
* `true`: (default) Accepts group invitations automatically;
* `false`: Do not accept group invitations automatically.
*/
autoAcceptGroupInvitation: boolean;
/**
* Whether the read receipt is required.
*
* `true`: (default) The read receipt is required;
* `false`: The read receipt is not required.
*/
requireAck: boolean;
/**
* Whether the delivery receipt is required.
*
* `true`: (default) The read receipt is required;
* `false`: The read receipt is not required.
*/
requireDeliveryAck: boolean;
/**
* Whether to delete the group message when leaving a group.
*
* `true`: (default) Delete the messages when leaving the group.
* `false`: Do not delete the messages when leaving a group.
*/
deleteMessagesAsExitGroup: boolean;
/**
* Whether to delete the chat room message when leaving the chat room.
*
* `true`: (default) 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.
*/
deleteMessagesAsExitChatRoom: boolean;
/**
* Whether to allow the chat room owner to leave the chat room.
*
* `true`: (default) Allow the chat room owner to leave the chat room.
* `false`: Do not allow the chat room owner to leave the chat room.
*/
isChatRoomOwnerLeaveAllowed: boolean;
/**
* Whether to sort messages by the server received time.
*
* `true`: (default) Sort messages by the server received time;
* `false`: Do not sort messages by the server received time.
*/
sortMessageByServerTime: boolean;
/**
* Sets whether only HTTPS is used for REST operations.
*
* `true`: (default) Only HTTPS is used.
* `false`: Allow to use both HTTP and HTTPS.
*/
usingHttpsOnly: boolean;
/**
* Whether to upload the message attachments automatically to the chat server.
*
* `true`: (default) 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.
*/
serverTransfer: boolean;
/**
* Whether to auto download the thumbnail.
*
* `true`: (default) Download the thumbnail automatically;
* `false`: Do not download the thumbnail automatically.
*/
isAutoDownload: boolean;
/**
* Sets whether to disable DNS.
*
* `true`: (default) Enable DNS;
* `false`: Do not enable DNS.
*/
enableDNSConfig: boolean;
/**
* The DNS url.
*/
dnsUrl: string;
/**
* The custom REST server.
*/
restServer: string;
/**
* The custom im message server url.
*/
imServer: string;
/**
* The custom im server port.
*/
imPort: number;
constructor(params: {
appKey: string;
autoLogin?: boolean;
debugModel?: boolean;
acceptInvitationAlways?: boolean;
autoAcceptGroupInvitation?: boolean;
requireAck?: boolean;
requireDeliveryAck?: boolean;
deleteMessagesAsExitGroup?: boolean;
deleteMessagesAsExitChatRoom?: boolean;
isChatRoomOwnerLeaveAllowed?: boolean;
sortMessageByServerTime?: boolean;
usingHttpsOnly?: boolean;
serverTransfer?: boolean;
isAutoDownload?: boolean;
enableDNSConfig?: boolean;
dnsUrl?: string;
restServer?: string;
imServer?: string;
imPort?: number;
});
}