Libsoftphone/cz.acrobits.libsoftphone/Instance/Registration

Registration

class Registration

Methods for manipulating registration of the accounts.

If feature Multiple Accounts is provided, all registered accounts are identified by either account ID or account index. Whether it is better to use ID or index depends on the situation as there are some advantages and some disadvantages for either approach.

Account indexes have constant time complexity. However, they may not identify the same account after some methods, which are marked as having such side effect. Account indexes are generally preserved over application restart but your code should not depend on that.

Account IDs, on the other hand, have logarithmic time complexity but are persistent and identify the same account until the account is deleted.

Constructors

Link copied to clipboard
constructor()

Functions

Link copied to clipboard
@MainThread
open fun addBlf(@Nullable accountId: String, uri: String, @NonNull blfSource: String, @NonNull blfSourceItemId: String)
Adds a new BLF uri to the list of subscribed uris.
Link copied to clipboard
@MainThread
@Nullable
open fun addSubscription(@NonNull request: SubscriptionRequest): String
Adds a new subscription.
Link copied to clipboard
@MainThread
open fun checkBalance(@IntRange(from = 0) index: Int)
@MainThread
open fun checkBalance(@Nullable accountId: String)
Check balance of an account.
Link copied to clipboard
@MainThread
open fun deleteAccount(@IntRange(from = 0) index: Int)
Delete an account Calling this method invalidates account indexes higher than index.
@MainThread
open fun deleteAccount(@Nullable accountId: String)
Delete an account.
Link copied to clipboard
@MainThread
open fun excludeNonStandardSipHeader(@IntRange(from = 0) index: Int, @NonNull method: String, @NonNull responseCode: String, @NonNull name: String)
@MainThread
open fun excludeNonStandardSipHeader(@Nullable accountId: String, @NonNull method: String, @NonNull responseCode: String, @NonNull name: String)
Exclude non-standard SIP header.
Link copied to clipboard
Link copied to clipboard
@CheckResult
@MainThread
@NonNull
open fun getAccount(@IntRange(from = 0) index: Int): AccountXml
@CheckResult
@MainThread
@Nullable
open fun getAccount(@Nullable accountId: String): AccountXml
Get account XML.
Link copied to clipboard
@CheckResult
@MainThread
@IntRange(from = 0)
open fun getAccountCount(): Int
Get number of accounts.
Link copied to clipboard
@CheckResult
@MainThread
@NonNull
open fun getAccountId(@IntRange(from = 0) index: Int): String
Get account ID for an account index.
Link copied to clipboard
@CheckResult
@MainThread
@Nullable
open fun getAccountIdForSelector(@NonNull selector: String): String
Get account ID for a SIPIS server selector.
Link copied to clipboard
@CheckResult
@MainThread
@IntRange(from = "-1")
open fun getAccountIndex(@Nullable account: String): Int
Get index of an account.
Link copied to clipboard
@CheckResult
@MainThread
@NonNull
open fun getAccounts(): Array<String>
Get IDs of all accounts.
Link copied to clipboard
@CheckResult
@MainThread
open fun getAllBlfUris(@Nullable accountId: String): Array<String>
Retrieves an array of all subscribed BLF uris.
Link copied to clipboard
@CheckResult
@MainThread
open fun getAllSubscriptionIds(@Nullable accountId: String): Array<String>
Retrieves an array of all subscription identifiers.
Link copied to clipboard
@CheckResult
@MainThread
@NonNull
open fun getBalance(@IntRange(from = 0) index: Int): Balance.Record
@CheckResult
@MainThread
@NonNull
open fun getBalance(@Nullable accountId: String): Balance.Record
Get balance record of an account.
Link copied to clipboard
@MainThread
open fun getBlf(@Nullable accountId: String, @NonNull uri: String): BusyLampField
Get dialog info for the given URI and account if available.
Link copied to clipboard
@CheckResult
@MainThread
@Nullable
open fun getDefaultAccount(): AccountXml
Get default account XML.
Link copied to clipboard
@CheckResult
@MainThread
@Nullable
open fun getDefaultAccountId(): String
Get default account ID.
Link copied to clipboard
@CheckResult
@MainThread
@IntRange(from = "-1")
open fun getDefaultAccountIndex(): Int
Get index of the default account.
Link copied to clipboard
@CheckResult
@MainThread
open fun getDisabledAccountIndexes(): Array<Int>
Get indexes of all disabled account.
Link copied to clipboard
@CheckResult
@MainThread
@NonNull
open fun getDisabledAccounts(): Array<String>
Get IDs of all disabled accounts.
Link copied to clipboard
@CheckResult
@MainThread
open fun getEnabledAccountIndexes(): Array<Int>
Get indexes of all enabled accounts.
Link copied to clipboard
@CheckResult
@MainThread
@NonNull
open fun getEnabledAccounts(): Array<String>
Get IDs of all enabled accounts.
Link copied to clipboard
@CheckResult
@MainThread
@NonNull
open fun getRegistrationState(@IntRange(from = 0) index: Int): RegistrationState
@CheckResult
@MainThread
@NonNull
open fun getRegistrationState(@Nullable accountId: String): RegistrationState
Get registration state of an account.
Link copied to clipboard
@CheckResult
@MainThread
@Nullable
open fun getVoicemail(@IntRange(from = 0) index: Int): Voicemail.Record
@CheckResult
@MainThread
@Nullable
open fun getVoicemail(@Nullable accountId: String): Voicemail.Record
Get voicemail record for an account.
Link copied to clipboard
@MainThread
open fun includeNonStandardSipHeader(@IntRange(from = 0) index: Int, @NonNull method: String, @NonNull responseCode: String, @NonNull name: String, @NonNull value: String)
@MainThread
open fun includeNonStandardSipHeader(@Nullable accountId: String, @NonNull method: String, @NonNull responseCode: String, @NonNull name: String, @NonNull value: String)
Include non-standard SIP header.
Link copied to clipboard
@CheckResult
@MainThread
open fun isAccountEnabled(@IntRange(from = 0) index: Int): Boolean
@CheckResult
@MainThread
open fun isAccountEnabled(@Nullable accountId: String): Boolean
Check if an account is enabled.
Link copied to clipboard
@MainThread
open fun isDndActive(@Nullable accountId: String): Boolean
Check whether Do-not-Disturb mode is active on an account.
Link copied to clipboard
Link copied to clipboard
@MainThread
open fun moveAccount(@IntRange(from = 0) from: Int, @IntRange(from = 0) to: Int)
Move an account to another index.
Link copied to clipboard
@CheckResult
@MainThread
@Nullable
open fun queryRate(@IntRange(from = 0) index: Int, @NonNull number: PeerAddress, @NonNull callback: RateCallback): Handle
@CheckResult
@MainThread
@Nullable
open fun queryRate(@IntRange(from = 0) index: Int, @NonNull number: String, @NonNull callback: RateCallback): Handle
@CheckResult
@MainThread
@Nullable
open fun queryRate(@Nullable accountId: String, @NonNull number: PeerAddress, @NonNull callback: RateCallback): Handle
@CheckResult
@MainThread
@Nullable
open fun queryRate(@Nullable accountId: String, @NonNull number: String, @NonNull callback: RateCallback): Handle
Query rate record for a number.
Link copied to clipboard
@CheckResult
@MainThread
open fun readyForCallThrough(@IntRange(from = 0) index: Int): Boolean
@CheckResult
@MainThread
open fun readyForCallThrough(@Nullable accountId: String): Boolean
Check if an account supports call-through.
Link copied to clipboard
@CheckResult
@MainThread
open fun readyForMessaging(@IntRange(from = 0) index: Int): Boolean
@CheckResult
@MainThread
open fun readyForMessaging(@Nullable accountId: String): Boolean
Check if an account supports messaging.
Link copied to clipboard
@CheckResult
@MainThread
open fun readyForVideo(@IntRange(from = 0) index: Int): Boolean
@CheckResult
@MainThread
open fun readyForVideo(@Nullable accountId: String): Boolean
Check if an account supports video.
Link copied to clipboard
@CheckResult
@MainThread
open fun readyForWebCallback(@IntRange(from = 0) index: Int): Boolean
@CheckResult
@MainThread
open fun readyForWebCallback(@Nullable accountId: String): Boolean
Check if an account supports call-through.
Link copied to clipboard
@MainThread
open fun removeBlf(@Nullable accountId: String, @NonNull uri: String, @NonNull blfSource: String, @NonNull blfSourceItemId: String)
Removes a BLF uri from the list of subscribed uris.
Link copied to clipboard
@MainThread
open fun removeSubscription(@NonNull subscriptionId: String)
Removes subscription.
Link copied to clipboard
Link copied to clipboard
@MainThread
@Nullable
open fun saveAccount(@NonNull account: AccountXml): String
Save an account.
Link copied to clipboard
@MainThread
open fun setDefaultAccount(@IntRange(from = "-1") index: Int)
@MainThread
open fun setDefaultAccount(@Nullable accountId: String)
Set default account Using this method requires feature Multiple Accounts.
Link copied to clipboard
@MainThread
open fun setImmediateDnd(@Nullable accountId: String, dnd: Boolean)
Link copied to clipboard
@CheckResult
@MainThread
open fun supportsWebCallback(@NonNull account: Xml): Boolean
TODO Document this
Link copied to clipboard
@MainThread
open fun updateAll()
Update all accounts.
Link copied to clipboard
Generated by Dokka
© 2026 Copyright