Config class
Base configuration class for common parameters
- Implementers
Constructors
- Config.new({required String sipCallerIDName, required String sipCallerIDNumber, String? notificationToken, bool? autoReconnect, LogLevel logLevel = LogLevel.all, required bool debug, CustomLogger? customLogger, String? ringTonePath, String? ringbackPath, int? reconnectionTimeout, Region region = Region.auto, bool fallbackOnRegionFailure = true, bool forceRelayCandidate = false})
- Base configuration class for common parameters
Properties
- autoReconnect → bool?
-
Flag to decide whether or not to attempt a reconnect (3 attempts) in the case of a login failure with legitimate credentials
final
- customLogger → CustomLogger?
-
Custom logger to use for logging - if left null the default logger will be used which uses the Logger package
final
- debug → bool
-
Flag to enable debug logs
final
- fallbackOnRegionFailure → bool
-
Whether the SDK should default to AUTO after attempting and failing to connect to a specified region
final
- forceRelayCandidate → bool
-
Controls whether the SDK should force TURN relay for peer connections.
When enabled, the SDK will only use TURN relay candidates for ICE gathering,
which prevents the "local network access" permission popup from appearing.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- logLevel → LogLevel
-
Log level to set for SDK Logging
final
- notificationToken → String?
-
Token used to register the device for notifications if required (FCM or APNS)
final
- reconnectionTimeout ↔ int?
-
reconnectionTimeout in milliseconds (Default 60 seconds)
getter/setter pair
- region → Region
-
The region to use for the connection (Auto by default)
final
- ringbackPath → String?
-
Path to the ringback file (audio to play when calling)
final
- ringTonePath → String?
-
Path to the ringtone file (audio to play when receiving a call)
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sipCallerIDName → String
-
Name associated with the SIP account
final
- sipCallerIDNumber → String
-
Number associated with the SIP account
final
Methods
-
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