CredentialConfig class
Creates an instance of CredentialConfig which can be used to log in
Uses the sipUser and sipPassword fields to log in sipCallerIDName and sipCallerIDNumber will be the Name and Number associated notificationToken is the token used to register the device for notifications if required (FCM or APNS) The autoReconnect flag decided whether or not to attempt a reconnect (3 attempts) in the case of a login failure with legitimate credentials logLevel is the log level to set for SDK Logging debug flag to enable debug logs which will collect stats for each call and provide WebRTC stats to view in the portal ringTonePath is the path to the ringtone file (audio to play when receiving a call) ringbackPath is the path to the ringback file (audio to play when calling) customLogger is a custom logger to use for logging - if left null the default logger will be used which uses the Logger package forceRelayCandidate controls whether the SDK should force TURN relay for peer connections (default: false)
Constructors
- CredentialConfig.new({required String sipUser, required String sipPassword, required String sipCallerIDName, required String sipCallerIDNumber, String? notificationToken, bool? autoReconnect, required LogLevel logLevel, required bool debug, String? ringTonePath, String? ringbackPath, CustomLogger? customLogger, int? reconnectionTimeout, Region region = Region.auto, bool fallbackOnRegionFailure = true, bool forceRelayCandidate = false})
- Creates an instance of CredentialConfig which can be used to log in
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
finalinherited
- customLogger → CustomLogger?
-
Custom logger to use for logging - if left null the default logger will be used which uses the Logger package
finalinherited
- debug → bool
-
Flag to enable debug logs
finalinherited
- fallbackOnRegionFailure → bool
-
Whether the SDK should default to AUTO after attempting and failing to connect to a specified region
finalinherited
- 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.
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- logLevel → LogLevel
-
Log level to set for SDK Logging
finalinherited
- notificationToken → String?
-
Token used to register the device for notifications if required (FCM or APNS)
finalinherited
- reconnectionTimeout ↔ int?
-
reconnectionTimeout in milliseconds (Default 60 seconds)
getter/setter pairinherited
- region → Region
-
The region to use for the connection (Auto by default)
finalinherited
- ringbackPath → String?
-
Path to the ringback file (audio to play when calling)
finalinherited
- ringTonePath → String?
-
Path to the ringtone file (audio to play when receiving a call)
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sipCallerIDName → String
-
Name associated with the SIP account
finalinherited
- sipCallerIDNumber → String
-
Number associated with the SIP account
finalinherited
- sipPassword → String
-
SIP password to log in with. Either a SIP Credential from the Portal or a Generated Credential from the API
final
- sipUser → String
-
SIP username to log in with. Either a SIP Credential from the Portal or a Generated Credential from the API
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