Voice

class Voice

SDK facade object. The inception point of all communications between client and SDK.

Types

Link copied to clipboard
object Companion
Link copied to clipboard

Voice SDK state with the string representation of the state.

Properties

Link copied to clipboard

Read-only property for the account id.

Link copied to clipboard

Current available active audio options.

Link copied to clipboard

Notification actions flow passing through user's interactions with notifications

Link copied to clipboard

Shared flow representing the audio option updates

Link copied to clipboard
val callMetricEvents: SharedFlow<Event>

Shared flow providing the SIP metric events

Link copied to clipboard

list of active calls.

Link copied to clipboard

Read-only property returning the String value indicating the Voice SDK component versions. Can be accessed only after initialization of the SDK

Link copied to clipboard

Current active audio option.

Link copied to clipboard

Read-only property for user's display name.

Link copied to clipboard

Read-only property to check if there are any Active calls at the moment.

Link copied to clipboard
Link copied to clipboard

True if bluetooth is available during a call, False otherwise

Link copied to clipboard
val logDataEntryFlow: SharedFlow<LogEntryData>
Link copied to clipboard
val loggedData: SharedFlow<VoiceLog>

Shared flow providing log data sent by the SDK

Link copied to clipboard

Read-only property for the user's phone number.

Link copied to clipboard

Read-only property used to receive registration data used in the SDK.

Link copied to clipboard

Property to get and set the ringtone to be played for an incoming call.

Link copied to clipboard

Read-only property returning the String value indicating the Voice SDK version.

Link copied to clipboard
val state: StateFlow<Voice.State>

StateFlow that can be collected to receive State updates.

Link copied to clipboard
val tokenExpirationEvents: SharedFlow<Unit>

Shared flow providing token expiration events sent by the SDK

Link copied to clipboard

Read-only property for user's id.

Link copied to clipboard

the current active call.

Link copied to clipboard
val voiceCallReport: SharedFlow<String>

Shared flow providing call reports

Link copied to clipboard

Shared flow representing the voice call states

Functions

Link copied to clipboard
suspend fun activate(configuration: Configuration)

Activates the SDK. All fields from both, session and user configurations must be set, otherwise the activation will throw a RegistrationException

Link copied to clipboard
suspend fun deactivate()

Destroys the internal SDK components. It should be called by app upon user logout.

Link copied to clipboard
fun init(application: Application)

Initializes SDK internal components and log listener which is used to send some useful logging information to the application. Must be called once per application lifecycle.

Link copied to clipboard

Checks if necessary configuration data is present.

Link copied to clipboard

Checks if the received notification is for Incoming call that the SDK can process.

Link copied to clipboard
fun onDestroy()

Clears Disposables on SDK

Link copied to clipboard
suspend fun placeCall(contact: VoiceContact): VoiceCallResult

Places an outgoing call.

Link copied to clipboard

Handles an incoming call.

Link copied to clipboard

Updates the audio option during a call.

Link copied to clipboard

Update display authentication token at any point after a successful registration.

Link copied to clipboard
fun updateContact(callUniqueId: UUID, voiceContact: VoiceContact)

To update contact information on the call object

Link copied to clipboard

Update display name at any point after successful registration

Link copied to clipboard

Update InboundCallPath at any point after a successful registration.

Link copied to clipboard
suspend fun updatePhoneNumber(phoneNumber: String?): ResultWrapper<Unit>

Update phone number at any point after successful registration

Link copied to clipboard

Updates push token at any point after successful registration

Link copied to clipboard
fun voiceCallStateForId(callUniqueId: UUID, sharedScope: CoroutineScope): SharedFlow<VoiceCallState.Updated>