Package com.orange.webcom.sdk

This package is the main entry point to the Webcom SDK for Android. This is a "new generation" SDK, as it's a complete rewrite of the legacy SDK (version 1.5.0). The internals have been completely modified to offer more speed and to limit the library dependencies. Please read the more detailed description below to learn aboutmigration from the legacy SDK. Apart from these few changes, you can refer to the legacy API documentation as not all classes and methods are thoroughly documented in the new SDK yet. The complete changelog is available here.

See: Description

Interface Summary

Interface	Description
Callback	Generic callback
JSONValue	This interface provides convenient methods to browse a JSON value (typically returned by the underlying Javascript engine). In particular, these methods support conversion to native Java types (such as String, Number, Boolean) as well as to POJO (Plain Old Java Objects) types.
OnAuth	Authentication callback for com.orange.webcom.sdk.Webcom$authInternally(java.lang.String,com.orange.webcom.sdk.internal.Credentials), com.orange.webcom.sdk.Webcom$addIdentity(java.lang.String,com.orange.webcom.sdk.AuthDetails,com.orange.webcom.sdk.OnAuth), ...
OnAuthExtended
OnAuthWithOAuth	OAuth authentication callback for com.orange.webcom.sdk.Webcom$authWithOAuth(android.content.Context,java.lang.String,com.orange.webcom.sdk.OnAuthWithOAuth) and com.orange.webcom.sdk.Webcom$authWithOAuth(android.content.Context,java.lang.String,com.orange.webcom.sdk.AuthOptions,com.orange.webcom.sdk.OnAuthWithOAuth,kotlin.Boolean).
OnComplete	Completion callback for com.orange.webcom.sdk.Webcom$set(java.lang.Object,com.orange.webcom.sdk.OnComplete), com.orange.webcom.sdk.Webcom$update(java.lang.Object,com.orange.webcom.sdk.OnComplete), com.orange.webcom.sdk.Webcom#push(OnComplete) or com.orange.webcom.sdk.Webcom$remove(com.orange.webcom.sdk.OnComplete).
OnQuery	Query callback for com.orange.webcom.sdk.Query.on, com.orange.webcom.sdk.Query.once, com.orange.webcom.sdk.Query.off
OnValue	Asynchronous callback wrapper for some methods of the class Webcom API. This wrapper provides a callback method that is passed a interface JSONValue instance.
TransactionCallback

Class Summary

Class	Description
AuthDetails	Represents authentication details, needed by the Webcom.addIdentity method to create a new account.
AuthOptions	Represents a set of options for authentication, which can be passed to some methods such as Webcom.authWithOAuth.
Config
DataSnapshot
MessageDetails	Represents the settings of a message to send to the user, needed by the Webcom.sendOtp method.
OnDisconnect
Query
ServerValue
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	A Webcom object is the entry point to the Webcom Datasync and Authentication services.
WebcomApp
WebcomError
WebcomOptions

Enum Summary

Enum	Description
NotificationEvent

Exception Summary

Exception	Description
WebcomException
WebcomRuntimeException

Package com.orange.webcom.sdk Description

This package is the main entry point to the Webcom SDK for Android. This is a "new generation" SDK, as it's a complete rewrite of the legacy SDK (version 1.5.0). The internals have been completely modified to offer more speed and to limit the library dependencies. Please read the more detailed description below to learn aboutmigration from the legacy SDK. Apart from these few changes, you can refer to the legacy API documentation as not all classes and methods are thoroughly documented in the new SDK yet. The complete changelog is available here.

This SDK depends on:

• the Kotlin runtime (org.jetbrains.kotlin)

• Custom Tabs (androidx.browser)

This SDK exposes the same API as the legacy one (until version 1.5.0), and aims at being a "drop-in" replacement, except for the changes below. Not all classes and methods are documented yet, so you should look for their equivalent in the legacy API documentation.

Important changes

Initialization

The SDK initialization differs form the legacy SDK, reflecting the underlying threading model of the internal engine. Extra care must be taken before being able to instantiate a class Webcom object, as explained in this class documentation.

Androidx

This library depends on androidx, this means your application should depend on it too (see how to migrate).

See Also:

more detailed description below, the legacy API documentation, The complete changelog is available here, the legacy API documentation, class Webcom, androidx, see how to migrate