Optional
acceptOptional
areaOptional
autoOptional
autoOptional
customOptional
customOSType?: numberOptional
debugOptional
deleteOptional
deleteOptional
dnsOptional
enableDNSConfig?: booleanOptional
enableOptional
enableTLS?: booleanOptional
imOptional
imOptional
isOptional
isOptional
logOptional
logOptional
messagesOptional
pushOptional
regardOptional
requireOptional
requireOptional
restOptional
serverOptional
sortOptional
useOptional
usingWhether to accept friend invitations from other users automatically.
true
: Yes.false
: No.The App Key you get from the console when creating a chat app. It is the unique identifier of your app.
The area code.
This attribute is used to restrict the scope of accessible edge nodes. The default value is GLOB
. See ChatAreaCode.
This attribute can be set only when you call ChatClient.init. The attribute setting cannot be changed during the app runtime.
Whether to accept group invitations automatically.
true
: Yes.false
: No.Whether to enable automatic login.
true
: Enables automatic login.false
: Disables automatic login.Optional
customCustom device name.
This attribute does not take effect when customOSType
is set to -1
.
An application scenario is as follows: User A wants to log in to a mobile phone and a tablet with the same user account. Then the user sets customOSType
to 1
and customDeviceName
to foo
.
Optional
customOSTypeCustom system type.
Whether to output the debug information.
true
: Yes.false
: No.Whether to delete the historical messages of the chat room in the memory and local database when leaving the chat room (either voluntarily or passively).
true
: Yes.false
: No.Whether to delete the historical messages of the group stored in the memory and local database when leaving a group (either voluntarily or passively).
true
: Yes.false
: No.The URL of the DNS server.
Whether to disable DNS.
true
: Yes.false
: No. DNS needs to be disabled for private deployment.Whether to include empty conversations when the SDK loads conversations from the local database:
true
: Yes. Empty conversations are included.false
: No. Empty conversations are excluded.Whether to enable TLS connection, which takes effect during initialization and is false
by default.
The custom port of the IM server.
The custom port is used when you implement data isolation and data security during private deployment.
If you need the port, contact our business manager.
The custom address of the IM message server.
This address is used when you implement data isolation and data security during private deployment.
If you need the address, contact our business manager.
Whether to automatically download the thumbnail.
true
: Yes.false
: No.Whether to allow the chat room owner to leave the chat room.
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.Optional
logGlobal flag for printing logs.
Optional
logWhether to activate the timestamp of the log.
Whether the sent message is included in ChatMessageEventListener.onMessagesReceived
.
true
: Yes. Besides the received message, the sent message is also included in ChatMessageEventListener.onMessagesReceived
.false
: No. Only the received message is included in ChatMessageEventListener.onMessagesReceived
.Optional
pushThe push configuration.
Whether to set messages from the server side as read.
true
: Yes.false
: No.Whether to require the message read receipt from the recipient.
true
: Yes.false
: No.This property does not take effect for ChatManager.sendConversationReadAck.
Whether to require the delivery receipt.
Note
Only valid for single chat messages. ChatMessageChatType.PeerChat
true
: Yes.false
: No.The custom address of the REST server.
This address is used when you implement data isolation and data security during private deployment.
If you need the address, contact our business manager.
Whether to upload the message attachments automatically to the chat server.
true
: Yes.false
: No. A custom path is used.Whether to sort the messages in the reverse chronological order of the time when they are received by the server.
true
: Yes;false
: No. Messages are sorted in the reverse chronological order of the time when they are created.Whether the server returns the sender the text message with the content replaced during text moderation:
true
: Yes.false
: No. The server returns the original message to the sender.Whether only HTTPS is used for REST operations.
true
: Only HTTPS is supported.false
: Both HTTP and HTTPS are allowed.
The chat setting class that defines parameters and options of the SDK, including whether to encrypt the messages before sending them and whether to automatically accept the friend invitations.