Package com.orange.webcom.sdk

Exposes the main public API of the Webcom SDK.

Types

AuthDetails

class AuthDetails @JvmOverloads constructor(id: String, password: String?, displayName: String?, profile: Any?)

Represents authentication details, needed by the Webcom.addIdentity method to create a new account.

AuthenticationOptions

data class AuthenticationOptions @JvmOverloads constructor(baseUrl: String?, storage: String?, initialState: String?)

AuthOptions

class AuthOptions

Represents a set of options for authentication, which can be passed to some methods such as Webcom.authWithOAuth.

Callback

interface Callback

Generic callback

Canceled

data class Canceled : Notification.ControlNotification, Notifiable

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

Config

object Config

JSONValue

interface JSONValue

This interface provides convenient methods to browse a JSON value (typically returned by the underlying Javascript engine).

MessageDetails

class MessageDetails(template: String?, sender: String?, locale: Locale?)

Represents the settings of a message to send to the user, needed by the Webcom.sendOtp method.

Notifiable

interface Notifiable

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

Notification

interface Notification<out T : Notifiable>

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

OnAuth

interface OnAuth : Callback

Authentication callback for authInternally, addIdentity, ...

OnAuthExtended

interface OnAuthExtended : OnAuth

OnAuthWithOAuth

interface OnAuthWithOAuth : OnAuth

OAuth authentication callback for authWithOAuth and authWithOAuth.

OnCompletableQuery

interface OnCompletableQuery : OnQueryBase

OnComplete

interface OnComplete : Callback

Completion callback for set(), update(), push() or remove().

OnDisconnect

class OnDisconnect

OnQuery

interface OnQuery : OnQueryBase

Query callback for on(), com.orange.webcom.sdk.Query.once, off()

OnQueryBase

interface OnQueryBase : Callback

OnValue

interface OnValue : Callback

Asynchronous callback wrapper for some methods of the Webcom API. This wrapper provides a callback method that is passed a JSONValue instance.

Query

open class Query

ServerlessDbOptions

data class ServerlessDbOptions @JvmOverloads constructor(baseUrl: String?, offlineData: String?, persist: Boolean?, connect: Boolean?, completeSubscriptionOnCancelation: Boolean?, websocket: ServerlessDbOptions.Companion.WebSocketOptions?, statPeriodMs: Long?)

Subscription

interface Subscription

Represents a subscription to some event type.

TransactionCallback

interface TransactionCallback : Callback

VerificationData

class VerificationData

Encapsulates all information pieces to verify a newly created identity. The pieces of information depends on the authentication method associated to the identity to verify.

Webcom

class Webcom : Query

A Webcom object is the entry point to the Webcom Datasync and Authentication services.

WebcomAbstractService

abstract class WebcomAbstractService

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

WebcomApp

data class WebcomApp @JvmOverloads constructor(appId: String, platform: URL?)

WebcomApplication

class WebcomApplication

Represents a Webcom application.

WebcomConfiguration

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

typealias WebcomDoneCallback = (WebcomResult<Unit>) -> Unit

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

WebcomError

class WebcomError @JvmOverloads constructor(errorCode: String, message: String?, cause: Throwable?)

WebcomException

class WebcomException(fromError: WebcomError?) : Exception

WebcomOptions

data class WebcomOptions @JvmOverloads constructor(Authentication: AuthenticationOptions?, ServerlessDb: ServerlessDbOptions?)

WebcomResult

sealed class WebcomResult<out T>

Wraps the result of a computation of type T.

WebcomResultCallback

typealias WebcomResultCallback<T> = (WebcomResult<T>) -> Unit

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

WebcomRuntimeException

class WebcomRuntimeException(message: String?) : RuntimeException

Functions

toOnCompletableQuery

fun OnQueryBase.toOnCompletableQuery(): OnCompletableQuery

Properties

description

val Callback.description: String