Package com.orange.webcom.sdkv2

Exposes the main public API of the Webcom SDK.

Types

Canceled
Link copied to clipboard
data class Canceled : Notification.ControlNotification, Notifiable

Generic event to be notified when a subscription is canceled, that is deliberately stopped.

Notifiable
Link copied to clipboard
interface Notifiable

Represents an event that can be notified, ie received by a callback function as a Notification object.

Notification
Link copied to clipboard
interface Notification<out T : Notifiable>

Base interface for passing an event of type T to a callback function.

Subscription
Link copied to clipboard
interface Subscription

Represents a subscription to some event type.

Webcom
Link copied to clipboard
object Webcom

Exposes some useful static methods or properties to start using the Webcom SDK.

WebcomAbstractService
Link copied to clipboard
abstract class WebcomAbstractService

Base class for the Webcom services such as AuthenticationService or DatasyncService.

WebcomApplication
Link copied to clipboard
class WebcomApplication

Represents a Webcom application.

WebcomConfiguration
Link copied to clipboard
data class WebcomConfiguration @JvmOverloads constructor(identifier: String, platform: URL?, offlineCache: String?, startOnline: Boolean, websocketProtocol: WebcomConfiguration.WebsocketProtocol, pingDelayMs: Int?, pongDelayMs: Int?)

Represents the settings of a WebcomApplication instance.

WebcomDoneCallback
Link copied to clipboard
typealias WebcomDoneCallback = (WebcomResult<Unit>) -> Unit

Shortcut type for callbacks that return nothing and that may fail.

WebcomResult
Link copied to clipboard
sealed class WebcomResult<out T>

Wraps the result of a computation of type T.

WebcomResultCallback
Link copied to clipboard
typealias WebcomResultCallback<T> = (WebcomResult<T>) -> Unit

Shortcut type for callbacks that return an object of a given type and that may fail.