ChatBuilder class
Initializes a new instance of the ChatBuilder
class.
@param domainBaseUrl The base URL for making API calls. @param storageFolderName The name of the local storage folder (optional). @param iOSContainerID The ID of the iOS container. @param licenseKey The license key for authentication. @param enableMobileNumberLogin Determines if login via mobile number is enabled (default is false). @param isTrialLicenceKey Indicates if the provided license key is a trial key (default is true). @param chatHistoryEnable Determines if chat history should be enabled (optional). @param enableDebugLog Determines if debug logging is enabled (default is false).
- Available extensions
Constructors
- ChatBuilder.new({required String domainBaseUrl, String storageFolderName = "Mirrorfly Flutter", required String iOSContainerID, required String licenseKey, bool enableMobileNumberLogin = false, bool isTrialLicenceKey = true, bool chatHistoryEnable = true, bool enableDebugLog = false, bool? enableAndroidCallKitUI = true})
- A builder class for creating chat configurations.
Properties
- chatHistoryEnable ↔ bool
-
Determines if chat history should be enabled. Optional.
getter/setter pair
- domainBaseUrl ↔ String
-
The base URL for making API calls.
getter/setter pair
- enableAndroidCallKitUI ↔ bool?
-
Determines whether the Android CallKit UI is enabled. Defaults to true.
If set to false, incoming calls will not trigger the call UI.
Instead, you will receive an event through the
onIncomingCallReceived
stream.getter/setter pair - enableDebugLog ↔ bool
-
Determines if debug logging is enabled. Defaults to false.
getter/setter pair
- enableMobileNumberLogin ↔ bool
-
Determines if login via mobile number is enabled. Defaults to false.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- iOSContainerID ↔ String
-
The ID of the App Groups container. Required for iOS platforms.
getter/setter pair
- isTrialLicenceKey ↔ bool
-
Indicates if the provided license key is a trial key. Defaults to true.
getter/setter pair
- licenseKey ↔ String
-
The license key for authentication.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- storageFolderName ↔ String
-
The name of the local storage folder. Optional.
getter/setter pair
Methods
-
build(
) → Map -
Available on ChatBuilder, provided by the BuilderParsing extension
Builds a map from the properties of aChatBuilder
instance. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited