Package com.orange.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.

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

Config

object Config

DataSnapshot

class DataSnapshot

DatasyncServiceOptions

data class DatasyncServiceOptions @JvmOverloads constructor(persist: Boolean?, connect: Boolean?, websocket: DatasyncServiceOptions.Companion.WebSocketOptions?)

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.

NotificationEvent

enum NotificationEvent

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(), 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

ServerValue

object ServerValue

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.

WebcomApp

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

WebcomError

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

WebcomException

class WebcomException(fromError: WebcomError?) : Exception

WebcomOptions

data class WebcomOptions @JvmOverloads constructor(persist: Boolean?, goOnline: Boolean?, offlineData: String?, wsProtocol: Int?, DatasyncService: DatasyncServiceOptions?)

WebcomRuntimeException

class WebcomRuntimeException(message: String?) : RuntimeException

Functions

toOnCompletableQuery

fun OnQueryBase.toOnCompletableQuery(): OnCompletableQuery

Properties

description

val Callback.description: String