Libsoftphone/cz.acrobits.libsoftphone/Preferences

Preferences

open class Preferences

Preferences.

This class is used for storing preference keys.

Constructors

constructor()

Types

interface Factory

Preferences factory.

IncomingEventTreatment

class IncomingEventTreatment

Incoming event treatment.

open inner class Key<Type> : Preferences.ROKey<Type>

Read-write preference key.

NoSuchKeyException

class NoSuchKeyException : IllegalStateException

Exception thrown when no such key exists.

open inner class ROKey<Type>

Read-only preference key.

TooLateToOverrideDefaultException

class TooLateToOverrideDefaultException : IllegalStateException

Exception thrown when default value of a key is overridden too late.

Properties

autoSpeakerOnTablet

val autoSpeakerOnTablet: Preferences.Key<Boolean>

Whether to switch audio to speaker when device is tablet.

val bnsIncoming: Preferences.Key<Boolean>

Whether to enable Background Noise Suppression for incoming audio.

val bnsOutgoing: Preferences.Key<Boolean>

Whether to enable Background Noise Suppression for outgoing audio.

builtinDnsClientMinTtlSeconds

val builtinDnsClientMinTtlSeconds: Preferences.Key<Integer>

cardDavPrincipalUrl

val cardDavPrincipalUrl: Preferences.Key<String>

cardDavUsername

val cardDavUsername: Preferences.Key<String>

checkForVoiceMail

val checkForVoiceMail: Preferences.Key<Boolean>

Whether to check for voice mail.

contactSortOrder

val contactSortOrder: Preferences.Key<String>

Contact sort order.

val contactSources: Preferences.Key<String>

List of contact sources.

echoSuppression

val echoSuppression: Preferences.Key<Boolean>

Whether to enable acoustic echo suppression.

enableDualStack

val enableDualStack: Preferences.Key<Boolean>

forwardingAdhoc

val forwardingAdhoc: Preferences.Key<Boolean>

forwardingEnabled

val forwardingEnabled: Preferences.Key<Boolean>

forwardingNumber

val forwardingNumber: Preferences.Key<String>

googleAskForLogin

val googleAskForLogin: Preferences.Key<Boolean>

googleAuthorizationCode

val googleAuthorizationCode: Preferences.Key<String>

val googleClientId: Preferences.Key<String>

googleCodeVerifier

val googleCodeVerifier: Preferences.Key<String>

googleRedirectUrl

val googleRedirectUrl: Preferences.Key<String>

importFavorites

val importFavorites: Preferences.Key<Boolean>

incomingCallsMode

val incomingCallsMode: Preferences.Key<String>

Incoming calls mode.

initialWizardSteps

val initialWizardSteps: Preferences.ROKey<String>

keepCellularNetworkActive

val keepCellularNetworkActive: Preferences.Key<Boolean>

Keep cellular network active.

val keypadVolume: Preferences.Key<Integer>

val lastDialedUri: Preferences.Key<String>

Last dialed URI.

lastRateAppQuery

val lastRateAppQuery: Preferences.Key<Long>

val locationPolicy: Preferences.Key<String>

Controls if location information is disabled/optional/required for calls.

locationPolicyIntervalSeconds

val locationPolicyIntervalSeconds: Preferences.Key<Integer>

Interval between location updates for calls in seconds.

maxNumberOfConcurrentCalls

val maxNumberOfConcurrentCalls: Preferences.ROKey<Integer>

Maximal number of concurrent calls.

networkChangeResetStrategy

val networkChangeResetStrategy: Preferences.Key<String>

networkConstraint

val networkConstraint: Preferences.Key<String>

networkMeterEnabled

val networkMeterEnabled: Preferences.Key<Boolean>

val networkUse: Preferences.Key<String>

Network use settings.

office365AskForLogin

val office365AskForLogin: Preferences.Key<Boolean>

office365AuthorizationCode

val office365AuthorizationCode: Preferences.Key<String>

office365RedirectUrl

val office365RedirectUrl: Preferences.Key<String>

playbackBlockDurationInMilliseconds

val playbackBlockDurationInMilliseconds: Preferences.Key<Integer>

preferPlatformDnsClient

val preferPlatformDnsClient: Preferences.Key<Boolean>

proximitySensorLock

val proximitySensorLock: Preferences.Key<Boolean>

Whether to use proximity sensor for locking the screen during a call.

pushAppIdPrefix

val pushAppIdPrefix: Preferences.ROKey<String>

Prefix for default push app id.

pushNotificationsEnabled

val pushNotificationsEnabled: Preferences.Key<Boolean>

Whether push notifications are enabled.

rateAfterCallCount

val rateAfterCallCount: Preferences.Key<Integer>

val rateAppEnabled: Preferences.Key<Boolean>

recordingStorage

val recordingStorage: Preferences.Key<String>

recordWarningBeep

val recordWarningBeep: Preferences.Key<Boolean>

Whether to play warning beep when recording.

ringerSettingOverride

val ringerSettingOverride: Preferences.Key<RingerSetting>

Ringer setting override.

samplingRateOverride

val samplingRateOverride: Preferences.Key<Integer>

Sampling rate override.

showAccountTitleForActiveCalls

val showAccountTitleForActiveCalls: Preferences.Key<String>

Defines the possibility to display account title hint (withing call or call notifications UI for example) values: "auto" - account hint available if more than one account is active.

val sipisDisabled: Preferences.Key<Boolean>

Whether usage of the SIPIS server is disabled.

sipMessageCapture

val sipMessageCapture: Preferences.Key<Boolean>

Whether to capture SIP messages.

speakerOnDisplayDown

val speakerOnDisplayDown: Preferences.Key<Boolean>

Whether to switch audio to speaker when device is turned display down.

systemAudioProcessing

val systemAudioProcessing: Preferences.Key<Boolean>

When enabled, the app will NOT use its audio processing features, instead it will ask Android to do it.

t9ContactsSearch

val t9ContactsSearch: Preferences.Key<Boolean>

val trafficLogging: Preferences.Key<Boolean>

Whether to log traffic.

useLegacyStream

val useLegacyStream: Preferences.ROKey<Boolean>

Whether to use legacy stream.

useProximitySensorForIncomingCalls

val useProximitySensorForIncomingCalls: Preferences.Key<Boolean>

userAgentOverride

val userAgentOverride: Preferences.Key<String>

User agent used in network traffic.

useReliableAlarms

val useReliableAlarms: Preferences.Key<Boolean>

verifyCertificates

val verifyCertificates: Preferences.Key<Boolean>

Whether to verify certificates.

voiceMessageFormat

val voiceMessageFormat: Preferences.Key<String>

volumeBoostMicrophone

val volumeBoostMicrophone: Preferences.Key<Integer>

volumeBoostPlayback

val volumeBoostPlayback: Preferences.Key<Integer>

val wsContactsUrl: Preferences.Key<String>

Functions

open fun getKeyType(@NonNull name: String): Class<out Any>

Get type of a key.

open fun keyExists(@NonNull name: String): Boolean

Check if a key exists.

open fun logException(t: Throwable)