SwitchboardSDK/com.synervoz.switchboard.sdk

Package-level declarations

Types

Link copied to clipboard
typealias ListenerID = Int

Identifies an event listener registered with Switchboard.addEventListener.

Link copied to clipboard
typealias ObjectID = String

Identifies a Switchboard object (an engine or a node within it).

Link copied to clipboard
object Switchboard

Entry point for the Switchboard SDK.

Link copied to clipboard
interface SwitchboardEventCallback

Receives events emitted by Switchboard objects.

Link copied to clipboard
class SwitchboardException(message: String) : Exception

Thrown when a Switchboard operation fails and the error is surfaced as an exception.

Link copied to clipboard
data class SwitchboardResult<T>(val success: Boolean, val value: T? = null, val error: String? = null)

The result of a Switchboard SDK operation.

Functions

Link copied to clipboard
fun <T> SwitchboardResult<T>.valueOrDefault(default: T): T

Returns the value on success, or default if the result is an error.

Link copied to clipboard
fun <T> SwitchboardResult<T>.valueOrThrow(): T

Returns the value on success, or throws SwitchboardException if the result is an error.