ChatOptions class - agora_chat_sdk library

Constructors

ChatOptions({required String appKey, bool autoLogin = true, bool debugModel = false, bool acceptInvitationAlways = false, bool autoAcceptGroupInvitation = false, bool requireAck = true, bool requireDeliveryAck = false, bool deleteMessagesAsExitGroup = true, bool deleteMessagesAsExitChatRoom = true, bool isChatRoomOwnerLeaveAllowed = true, bool sortMessageByServerTime = true, bool usingHttpsOnly = true, bool serverTransfer = true, bool isAutoDownloadThumbnail = true, bool enableDNSConfig = true, String? dnsUrl, String? restServer, int? imPort, String? imServer, int chatAreaCode = ChatAreaCode.GLOB, bool enableEmptyConversation = false, String? deviceName, int? osType}): Sets the app options.

Properties

acceptInvitationAlways → bool: Whether to accept friend invitations from other users automatically.
final
appKey → String: The app key that you get from the console when creating the app.
final
autoAcceptGroupInvitation → bool: Whether to accept group invitations automatically.
final
autoLogin → bool: Whether to enable automatic login.
final
chatAreaCode → int: The area code. This attribute is used to restrict the scope of accessible edge nodes. The default value is AreaCodeGLOB. This attribute can be set only when you call ChatClient.init. The attribute setting cannot be changed during the app runtime.
final
debugModel → bool: Whether to output the debug information. Make sure to call the method after initializing the ChatClient using ChatClient.init.
final
deleteMessagesAsExitChatRoom → bool: Whether to delete the chat room messages when leaving the chat room.
final
deleteMessagesAsExitGroup → bool: Whether to delete the group messages when leaving a group.
final
deviceName → String?: Custom device name.
final
dnsUrl → String?: The DNS URL.
final
enableDNSConfig → bool: Whether to enable DNS.
final
enableEmptyConversation → bool: Whether to include empty conversations when the SDK loads conversations from the local database:
final
hashCode → int: The hash code for this object.
read-onlyinherited
imPort → int?: The custom IM server port.
final
imServer → String?: The custom IM message server url.
final
isAutoDownloadThumbnail → bool: Whether to automatically download the thumbnail.
final
isChatRoomOwnerLeaveAllowed → bool: Whether to allow the chat room owner to leave the chat room.
final
osType → int?: Custom system type.
final
requireAck → bool: Whether to require read receipt after sending a message.
final
requireDeliveryAck → bool: Whether to require the delivery receipt after sending a message.
final
restServer → String?: The custom REST server.
final
runtimeType → Type: A representation of the runtime type of the object.
read-onlyinherited
serverTransfer → bool: Whether to upload the message attachments automatically to the chat server.
final
sortMessageByServerTime → bool: Whether to sort the messages by the time when the messages are received by the server.
final
usingHttpsOnly → bool: Whether only HTTPS is used for REST operations.
final

Methods

enableAPNs(String certName) → void: Enables Apple Push Notification service (APNs) on iOS devices.
enableFCM(String appId) → void: Enable Firebase Cloud Messaging (FCM) push on devices that support Google Play.
enableHWPush() → void: Enable Huawei Push on Huawei devices.
enableMeiZuPush(String appId, String appKey) → void: Enable MeiZu Push on MeiZu devices. Param appId The app ID for MeiZu Push. Param appKey The app key for MeiZu Push.
enableMiPush(String appId, String appKey) → void: Enable Mi Push on Mi devices.
enableOppoPush(String appKey, String secret) → void: Enable OPPO PUSH on OPPO devices.
enableVivoPush() → void: Enable vivo Push on vivo devices.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toString() → String: A string representation of this object.
override

Operators

operator ==(Object other) → bool: The equality operator.
inherited