Skip navigation links
A C D E F G H I J L M N O P Q R S T U V W 

A

Action.Abort - Class in com.orange.webcom.sdk
 
Action.Companion - Class in com.orange.webcom.sdk
 
Action.Set - Class in com.orange.webcom.sdk
 
addAccount(provider, details, messageDetails, callback) - Method in class com.orange.webcom.sdk.Webcom
Adds a new account to the app referred to by this class Webcom instance. The new account is associated to a new identity with the provider authentication mehtod, whose details (typically msisdn, email or password) are provided by the details parameter. Currently, only 2 authentication methods are available to add an account: "password" (authentication with email and password) or "phone" (authentication with msisdn and one-time-password).
addAccount(provider, details, callback) - Method in class com.orange.webcom.sdk.Webcom
Adds a new account to the app referred to by this class Webcom instance. See Webcom.addAccount.
authAnonymously(callback) - Method in class com.orange.webcom.sdk.Webcom
 
authAnonymously() - Method in class com.orange.webcom.sdk.Webcom
 
AuthDetails - Class in com.orange.webcom.sdk
Represents authentication details, needed by the Webcom.addAccount method to create a new account.
AuthDetails(id, password, displayName, profile) - Constructor for class com.orange.webcom.sdk.AuthDetails
Represents authentication details, needed by the Webcom.addAccount method to create a new account.
AuthDetails(id, password, displayName) - Constructor for class com.orange.webcom.sdk.AuthDetails
Represents authentication details, needed by the Webcom.addAccount method to create a new account.
AuthDetails(id, password) - Constructor for class com.orange.webcom.sdk.AuthDetails
Represents authentication details, needed by the Webcom.addAccount method to create a new account.
AuthDetails(id) - Constructor for class com.orange.webcom.sdk.AuthDetails
Represents authentication details, needed by the Webcom.addAccount method to create a new account.
AuthOptions - Class in com.orange.webcom.sdk
Represents a set of options for authentication, which can be passed to some methods such as Webcom.authWithOAuth.
AuthOptions.Companion - Class in com.orange.webcom.sdk
 
AuthResponse(data) - Constructor for class com.orange.webcom.sdk.OnAuth.AuthResponse
Deprecated. 
AuthResponse(jsonData) - Constructor for class com.orange.webcom.sdk.OnAuth.AuthResponse
 
authWithCustomProvider(provider, token, callback) - Method in class com.orange.webcom.sdk.Webcom
 
authWithCustomProvider(provider, token) - Method in class com.orange.webcom.sdk.Webcom
 
authWithOAuth(context, provider, options, listener, forcesWebView) - Method in class com.orange.webcom.sdk.Webcom
 
authWithOAuth(context, provider, options, listener) - Method in class com.orange.webcom.sdk.Webcom
 
authWithOAuth(context, provider, options) - Method in class com.orange.webcom.sdk.Webcom
 
authWithOAuth(context, provider, listener, options) - Method in class com.orange.webcom.sdk.Webcom
 
authWithOAuth(context, provider, listener) - Method in class com.orange.webcom.sdk.Webcom
 
authWithOAuth(context, provider) - Method in class com.orange.webcom.sdk.Webcom
 
authWithPassword(email, password, callback) - Method in class com.orange.webcom.sdk.Webcom
 
authWithPassword(email, password) - Method in class com.orange.webcom.sdk.Webcom
 
authWithPhone(id, challenge, password) - Method in class com.orange.webcom.sdk.Webcom
Authenticates a user using her/his phone number. This method requires sending beforehand a one-time-password (OTP) to the user using the Webcom.sendOtp method. This operation is performed asynchronously. Upon authentication completion or failure, the registered authentication callbacks are called (see Webcom.registerAuthCallback).
authWithPhone(id, challenge, password, callback) - Method in class com.orange.webcom.sdk.Webcom
Authenticates a user using her/his phone number. This method requires sending beforehand a one-time-password (OTP) to the user using the Webcom.sendOtp method. This operation is performed asynchronously. Upon authentication completion or failure, the registered authentication callbacks are called (see Webcom.registerAuthCallback).
authWithToken(token, callback) - Method in class com.orange.webcom.sdk.Webcom
 
authWithWassup(options, listener) - Method in class com.orange.webcom.sdk.Webcom
 
authWithWassup(options) - Method in class com.orange.webcom.sdk.Webcom
 
authWithWassup(listener) - Method in class com.orange.webcom.sdk.Webcom
 

C

Callback - Interface in com.orange.webcom.sdk
Generic callback
cancel(callback) - Method in class com.orange.webcom.sdk.OnDisconnect
 
changePassword(email, oldPassword, newPassword, callback) - Method in class com.orange.webcom.sdk.Webcom
 
child(childPath) - Method in class com.orange.webcom.sdk.DataSnapshot
 
child(path) - Method in class com.orange.webcom.sdk.Webcom
Returns a reference on the data node specified by a path relatively to the data node referred to by this instance.
children() - Method in class com.orange.webcom.sdk.DataSnapshot
 
com.orange.webcom.sdk - 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.
Companion - Static variable in class com.orange.webcom.sdk.AuthOptions
 
Companion - Static variable in class com.orange.webcom.sdk.Query
 
Companion - Static variable in class com.orange.webcom.sdk.TransactionCallback.Action
 
Companion - Static variable in class com.orange.webcom.sdk.Webcom
 
Companion - Static variable in class com.orange.webcom.sdk.WebcomError
 
component1() - Method in class com.orange.webcom.sdk.WebcomApp
 
component2() - Method in class com.orange.webcom.sdk.WebcomApp
 
Config - Class in com.orange.webcom.sdk
 
Config.LogLevel - Enum in com.orange.webcom.sdk
 
copy(appId, platform) - Method in class com.orange.webcom.sdk.WebcomApp
 
Create() - Method in class com.orange.webcom.sdk.AuthOptions.Companion
Deprecated. 
create() - Method in class com.orange.webcom.sdk.AuthOptions.Companion
Creates an empty class AuthOptions instance.
Create() - Static method in class com.orange.webcom.sdk.AuthOptions
Deprecated. 
create() - Static method in class com.orange.webcom.sdk.AuthOptions
Creates an empty class AuthOptions instance.
createUser(email, password, callback) - Method in class com.orange.webcom.sdk.Webcom
 

D

DataSnapshot - Class in com.orange.webcom.sdk
 

E

endAt(name) - Method in class com.orange.webcom.sdk.Query
 
endAt() - Method in class com.orange.webcom.sdk.Query
 
equals(p) - Method in class com.orange.webcom.sdk.WebcomApp
 
equalTo(name) - Method in class com.orange.webcom.sdk.Query
 
exportVal() - Method in class com.orange.webcom.sdk.DataSnapshot
 

F

finalize() - Method in class com.orange.webcom.sdk.Query
 

G

getABORT() - Method in class com.orange.webcom.sdk.Action.Companion
 
getABORT() - Static method in class com.orange.webcom.sdk.TransactionCallback.Action
 
getAccessToken() - Method in interface com.orange.webcom.sdk.OnAuth.Identity
Gets the OAuth access token attached to this interface OnAuth.Identity instance when available. This piece of information is available only when authenticating using OAuth2 login.
getAppId() - Method in class com.orange.webcom.sdk.WebcomApp
 
getAuth() - Method in class com.orange.webcom.sdk.VerificationData
 
getContext() - Static method in class com.orange.webcom.sdk.Config
 
getContext() - Method in interface com.orange.webcom.sdk.OnAuth.Identity
 
getCreatedAt() - Method in interface com.orange.webcom.sdk.OnAuth.Identity
Gets the creation date of the webcom user account attached to this interface OnAuth.Identity instance.
getDisplayName() - Method in class com.orange.webcom.sdk.AuthDetails
 
getDisplayName() - Method in interface com.orange.webcom.sdk.OnAuth.Identity
Gets the display name attached to this interface OnAuth.Identity instance when available. Its availability depends on the identity provider that forged this interface OnAuth.Identity instance.
getEmail() - Method in class com.orange.webcom.sdk.OnAuth.AuthResponse
 
getEmail() - Method in interface com.orange.webcom.sdk.OnAuth.Identity
Gets the email address attached to this interface OnAuth.Identity instance when available. Its availability depends on the identity provider that forged this interface OnAuth.Identity instance. The email is always available when authenticating with email/password. The email may be available when authenticating with an OAuth2 provider.
getError() - Method in exception com.orange.webcom.sdk.WebcomException
 
getErrorCode() - Method in class com.orange.webcom.sdk.WebcomError
 
getEventType() - Method in class com.orange.webcom.sdk.DataSnapshot
 
getExpires() - Method in class com.orange.webcom.sdk.OnAuth.AuthResponse
 
getExpires() - Method in interface com.orange.webcom.sdk.OnAuth.Identity
Gets the expiration date of the authentication token attached to this interface OnAuth.Identity instance when available. Note that it may be missing, typically in return of the com.orange.webcom.sdk.Webcom$createUser(java.lang.String,java.lang.String,com.orange.webcom.sdk.OnAuth) method, which doesn't authenticate the user.
getForcesWebView() - Method in class com.orange.webcom.sdk.AuthOptions
 
getGoOnline() - Method in class com.orange.webcom.sdk.WebcomOptions
 
getId() - Method in class com.orange.webcom.sdk.AuthDetails
 
getIdentity() - Method in class com.orange.webcom.sdk.OnAuth.AuthResponse
Get the user's identity related to an authentication.
getInternalHostUrl() - Method in class com.orange.webcom.sdk.Webcom
 
getIntValue() - Method in enum com.orange.webcom.sdk.Config.LogLevel
 
getJSON() - Method in class com.orange.webcom.sdk.DataSnapshot
 
getJSONProviderProfile() - Method in interface com.orange.webcom.sdk.OnAuth.Identity
Gets the provider profile data of this interface OnAuth.Identity instance as a interface JSONValue. It is null if no provider profile is attached to this instance.
getLocale() - Method in class com.orange.webcom.sdk.MessageDetails
 
getLogLevel() - Static method in class com.orange.webcom.sdk.Config
 
getMessage() - Method in class com.orange.webcom.sdk.WebcomError
 
getMessage() - Method in exception com.orange.webcom.sdk.WebcomException
 
getMobileCountryCode() - Method in class com.orange.webcom.sdk.AuthOptions.Companion
Retrieves the Mobile Country Code (MCC) associated to the SIM card activated on the phone.
getMobileCountryCode() - Static method in class com.orange.webcom.sdk.AuthOptions
Retrieves the Mobile Country Code (MCC) associated to the SIM card activated on the phone.
getMobileCountryCode() - Static method in class com.orange.webcom.sdk.Config
 
getMobileNetworkCode() - Method in class com.orange.webcom.sdk.AuthOptions.Companion
Retrieves the Mobile Network Code (MNC) associated to the SIM card activated on the phone.
getMobileNetworkCode() - Static method in class com.orange.webcom.sdk.AuthOptions
Retrieves the Mobile Network Code (MNC) associated to the SIM card activated on the phone.
getMobileNetworkCode() - Static method in class com.orange.webcom.sdk.Config
 
getPassword() - Method in class com.orange.webcom.sdk.AuthDetails
 
getPassword() - Method in class com.orange.webcom.sdk.VerificationData
 
getPersist() - Method in class com.orange.webcom.sdk.WebcomOptions
 
getPlatform() - Method in class com.orange.webcom.sdk.WebcomApp
 
getProfile() - Method in class com.orange.webcom.sdk.AuthDetails
 
getProperty(property) - Method in interface com.orange.webcom.sdk.JSONValue
If this JSON value is a JSON object, gets the raw Javascript object representing the value of a given property of this JSON object. If this JSON value is not a JSON object or if this JSON object has no property with the given name, then this method returns null.
getPropertyAs(property, type) - Method in interface com.orange.webcom.sdk.JSONValue
If this JSON value is a JSON object, gets the value of a given property as an object of a given type. If this JSON value is not a JSON object or if this JSON object has no property with the given name, then this method returns null. If the conversion is not possible, this method returns null.
getPropertyAsListOf(property, type) - Method in interface com.orange.webcom.sdk.JSONValue
If this JSON value is a JSON object, gets the value of a given property as a list of elements of a given type. If this JSON value is not a JSON object or if this JSON object has no property with the given name, then this method returns null. If the conversion of the given property is not possible (see com.orange.webcom.sdk.JSONValue$getValueAsListOf(java.lang.Class)), this method returns null.
getPropertyAsMapOf(property, type) - Method in interface com.orange.webcom.sdk.JSONValue
If this JSON value is a JSON object, gets the value of a given property as an associative map from String to a given type. If this JSON value is not a JSON object or if this JSON object has no property with the given name, then this method returns null. If the conversion of the given property is not possible (see com.orange.webcom.sdk.JSONValue$getValueAsMapOf(java.lang.Class)), this method returns null.
getProvider() - Method in class com.orange.webcom.sdk.OnAuth.AuthResponse
 
getProvider() - Method in interface com.orange.webcom.sdk.Identity.Context
 
getProvider() - Method in interface com.orange.webcom.sdk.OnAuth.Identity
Gets the identifier of the identity provider that forged this interface OnAuth.Identity instance. The returned value closely depends on the used authentication method: Anonymous login: anonymous Email/password login: password OAuth2 login: google, facebook, orange... Mobile Connect login: mobileconnect OIDC login: oidc. Implicit login: wassup Custom login: custom.
getProviderProfile() - Method in interface com.orange.webcom.sdk.OnAuth.Identity
Deprecated. 
getProviderUid() - Method in interface com.orange.webcom.sdk.Identity.Context
 
getProviderUid() - Method in interface com.orange.webcom.sdk.OnAuth.Identity
Gets the unique identifier attributed by the identity provider that forged this interface OnAuth.Identity instance. The returned value is specific to each identity provider and is not guaranteed to be unique across them. If you need a unique user identifier, used com.orange.webcom.sdk.OnAuth.Identity$getUid().
getSender() - Method in class com.orange.webcom.sdk.MessageDetails
 
getSignedInAt() - Method in interface com.orange.webcom.sdk.Identity.Context
 
getTemplate() - Method in class com.orange.webcom.sdk.MessageDetails
 
getToken() - Method in class com.orange.webcom.sdk.OnAuth.AuthResponse
 
getToken() - Method in class com.orange.webcom.sdk.VerificationData
 
getUid() - Method in class com.orange.webcom.sdk.OnAuth.AuthResponse
 
getUid() - Method in interface com.orange.webcom.sdk.OnAuth.Identity
Gets the unique identifier of the webcom user account attached to this interface OnAuth.Identity instance.
getUid() - Method in class com.orange.webcom.sdk.Query
 
getValue() - Method in interface com.orange.webcom.sdk.JSONValue
Gets the raw Javascript object representing this JSON value.
getValue() - Method in class com.orange.webcom.sdk.Action.Set
 
getValueAs(type) - Method in interface com.orange.webcom.sdk.JSONValue
Gets this JSON value as an object of a given type. If the conversion is not possible, this method returns null.
getValueAsListOf(type) - Method in interface com.orange.webcom.sdk.JSONValue
Gets this JSON value as a list of elements of a given type. If the conversion is not possible (either the JSON value is not a list or one of its elements can't be converted to the given type), this method returns null.
getValueAsMapOf(type) - Method in interface com.orange.webcom.sdk.JSONValue
Gets this JSON value as an associative map from String to a given type. If the conversion is not possible (either the JSON value is not a map or one of its values can't be converted to the given type), this method returns null.
getWebcomAuthToken() - Method in interface com.orange.webcom.sdk.OnAuth.Identity
Gets the Webcom authentication token attached to this interface OnAuth.Identity instance when available. Note that it may be missing, typically in return of the com.orange.webcom.sdk.Webcom$createUser(java.lang.String,java.lang.String,com.orange.webcom.sdk.OnAuth) method, which doesn't authenticate the user.
getWsProtocol() - Method in class com.orange.webcom.sdk.WebcomOptions
 
goOffline() - Method in class com.orange.webcom.sdk.Webcom
Forces disconnection of the Datasync service associated with this instance from the Webcom back end.
goOnline() - Method in class com.orange.webcom.sdk.Webcom
Forces reconnection of the Datasync service associated with this instance to the Webcom back end.

H

hasChild(key) - Method in class com.orange.webcom.sdk.DataSnapshot
 
hasChildren() - Method in class com.orange.webcom.sdk.DataSnapshot
 
hashCode() - Method in class com.orange.webcom.sdk.WebcomApp
 

I

Identity.Context - Interface in com.orange.webcom.sdk
 
init() - Static method in class com.orange.webcom.sdk.Config
 
INSTANCE - Static variable in class com.orange.webcom.sdk.Config
 
INSTANCE - Static variable in class com.orange.webcom.sdk.ServerValue
 
INSTANCE - Static variable in class com.orange.webcom.sdk.Action.Abort
 
internalRepresentation() - Method in class com.orange.webcom.sdk.Webcom
 

J

JSONValue - Interface in com.orange.webcom.sdk
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.

L

limit(lim) - Method in class com.orange.webcom.sdk.Query
 
logout(onComplete) - Method in class com.orange.webcom.sdk.Webcom
 
logout() - Method in class com.orange.webcom.sdk.Webcom
 

M

MessageDetails - Class in com.orange.webcom.sdk
Represents the settings of a message to send to the user, needed by the Webcom.sendOtp method.
MessageDetails(template, sender, locale) - Constructor for class com.orange.webcom.sdk.MessageDetails
Represents the settings of a message to send to the user, needed by the Webcom.sendOtp method.
MessageDetails() - Constructor for class com.orange.webcom.sdk.MessageDetails
Represents the settings of a message to send to the user, needed by the Webcom.sendOtp method.

N

name() - Method in class com.orange.webcom.sdk.DataSnapshot
 
name() - Method in class com.orange.webcom.sdk.Webcom
 
NULL - Static variable in interface com.orange.webcom.sdk.JSONValue
 
numChildren() - Method in class com.orange.webcom.sdk.DataSnapshot
 

O

off() - Method in class com.orange.webcom.sdk.Query
 
off(eventType) - Method in class com.orange.webcom.sdk.Query
 
off(eventType, callback) - Method in class com.orange.webcom.sdk.Query
 
off(eventTypes, callback) - Method in class com.orange.webcom.sdk.Query
 
on(eventType, callback) - Method in class com.orange.webcom.sdk.Query
 
on(eventTypes, callback) - Method in class com.orange.webcom.sdk.Query
 
OnAuth - Interface in com.orange.webcom.sdk
OnAuth.AuthProvider - Enum in com.orange.webcom.sdk
 
OnAuth.AuthResponse - Class in com.orange.webcom.sdk
Authentication response data passed to the com.orange.webcom.sdk.OnAuth$onComplete(com.orange.webcom.sdk.OnAuth.AuthResponse) method of the authentication callback.
OnAuth.Identity - Interface in com.orange.webcom.sdk
Identity data associated to an authenticated user.
OnAuthWithOAuth - Interface in com.orange.webcom.sdk
onCancel(error) - Method in interface com.orange.webcom.sdk.OnAuthWithOAuth
This callback is called when the final user cancels the authentication operation, typically by closing the authentication WebView (using the 'back' button). This may also be called when the WebView encounters network failures to display the authentication page served by the provider.
onCancel(error) - Method in interface com.orange.webcom.sdk.OnQuery
Called when event subscription is canceled because of permission reason
once(eventType, callback) - Method in class com.orange.webcom.sdk.Query
 
onComplete(response) - Method in interface com.orange.webcom.sdk.OnAuth
Called when the authentication is successful
OnComplete - Interface in com.orange.webcom.sdk
onComplete() - Method in interface com.orange.webcom.sdk.OnComplete
Called after synchronization with the server
onComplete(snapData, prevName) - Method in interface com.orange.webcom.sdk.OnQuery
Called when the Query event occurs
OnDisconnect - Class in com.orange.webcom.sdk
 
onDisconnect() - Method in class com.orange.webcom.sdk.Webcom
 
onError(error) - Method in interface com.orange.webcom.sdk.Callback
Called when an error happens
onError(error) - Method in interface com.orange.webcom.sdk.OnAuth
Called when the authentication fails and/or the token is invalid
onError(error) - Method in interface com.orange.webcom.sdk.OnComplete
Called when synchronization with the server fails
OnQuery - Interface in com.orange.webcom.sdk
onReady(runnable) - Method in class com.orange.webcom.sdk.Webcom.Companion
Registers the runnable callback to be called as soon as the Webcom SDK has completed its initialization.
onReady(runnable) - Static method in class com.orange.webcom.sdk.Webcom
Registers the runnable callback to be called as soon as the Webcom SDK has completed its initialization.
onTerminate() - Static method in class com.orange.webcom.sdk.Config
 
onTransactionComplete(isSuccessful, snapshot) - Method in interface com.orange.webcom.sdk.TransactionCallback
 
OnValue - Interface in com.orange.webcom.sdk
Asynchronous callback wrapper for some methods of the class Webcom API. This wrapper provides a callback method that is passed a interface JSONValue instance.
onValue(value) - Method in interface com.orange.webcom.sdk.OnValue
Called in case of succes, with a resulting interface JSONValue instance

P

parent() - Method in class com.orange.webcom.sdk.Webcom
Returns a reference on the parent data node wrt. to the data node referred to by this instance.
parseJsonError(json) - Method in class com.orange.webcom.sdk.WebcomError.Companion
 
path() - Method in class com.orange.webcom.sdk.Query
 
persist() - Method in class com.orange.webcom.sdk.Webcom
 
push() - Method in class com.orange.webcom.sdk.Webcom
Returns a reference on a child data node with a unique key.
push(data, onComplete) - Method in class com.orange.webcom.sdk.Webcom
Write some given data under a new child data node with a unique key.
push(data) - Method in class com.orange.webcom.sdk.Webcom
Write some given data under a new child data node with a unique key.

Q

Query - Class in com.orange.webcom.sdk
 
Query.Companion - Class in com.orange.webcom.sdk
 
Query.Event - Enum in com.orange.webcom.sdk
 
queryIdentifier() - Method in class com.orange.webcom.sdk.Query
 
queryObject() - Method in class com.orange.webcom.sdk.Query
 

R

ref() - Method in class com.orange.webcom.sdk.DataSnapshot
 
ref() - Method in class com.orange.webcom.sdk.Query
 
registerAuthCallback(onAuth) - Method in class com.orange.webcom.sdk.Webcom
 
remove(callback) - Method in class com.orange.webcom.sdk.OnDisconnect
 
remove(onComplete) - Method in class com.orange.webcom.sdk.Webcom
 
remove() - Method in class com.orange.webcom.sdk.Webcom
 
removeAccount(callback) - Method in class com.orange.webcom.sdk.Webcom
Removes the Webcom account of the currently authenticated user. Note that all identities attached to this account will also be deleted.
removeIdentity(callback) - Method in class com.orange.webcom.sdk.Webcom
Removes the identity of the currently authenticated user from her/his Webcom account. This identity will then be no longer available for authenticating the user. All other identities attached to this account will remain and will still be available for authentication. However, note that if the removed identity is the last attached one to the user account, then the whole account is deleted (otherwise it would result in a "ghost" account with no means of authentication).
removeUser(email, password, callback) - Method in class com.orange.webcom.sdk.Webcom
 
resume() - Method in class com.orange.webcom.sdk.Webcom
 
returnLocaleAsString() - Method in class com.orange.webcom.sdk.MessageDetails
 
root() - Method in class com.orange.webcom.sdk.Webcom
Returns a reference on the root data node of the Datasync service associated with this instance.
runTransaction(currentValue) - Method in interface com.orange.webcom.sdk.TransactionCallback
 

S

sendConfirmationEmail(email, callback) - Method in class com.orange.webcom.sdk.Webcom
 
sendOtp(provider, id, messageDetails, callback) - Method in class com.orange.webcom.sdk.Webcom
Sends a one time password to a user. Such a temporary password may then be used to authenticate the user using the Webcom.authWithPhone method.
sendOtp(provider, id, callback) - Method in class com.orange.webcom.sdk.Webcom
Sends a one time password to a user using the default "login" message template.
sendPasswordResetCode(provider, id, messageDetails, callback) - Method in class com.orange.webcom.sdk.Webcom
 
sendPasswordResetCode(provider, id, messageDetails) - Method in class com.orange.webcom.sdk.Webcom
 
sendPasswordResetCode(provider, id) - Method in class com.orange.webcom.sdk.Webcom
 
sendPasswordResetCode(provider, id, callback) - Method in class com.orange.webcom.sdk.Webcom
 
sendPasswordResetEmail(email, callback) - Method in class com.orange.webcom.sdk.Webcom
 
sendVerificationCode(provider, id, messageDetails, callback) - Method in class com.orange.webcom.sdk.Webcom
 
sendVerificationCode(provider, id, callback) - Method in class com.orange.webcom.sdk.Webcom
 
ServerValue - Class in com.orange.webcom.sdk
 
set(value, callback) - Method in class com.orange.webcom.sdk.OnDisconnect
 
SET(value) - Method in class com.orange.webcom.sdk.Action.Companion
 
Set(value) - Constructor for class com.orange.webcom.sdk.Action.Set
 
set(data, onComplete) - Method in class com.orange.webcom.sdk.Webcom
 
set(data) - Method in class com.orange.webcom.sdk.Webcom
 
setCustomParameter(key, value) - Method in class com.orange.webcom.sdk.AuthOptions
 
setDisplayName(p) - Method in class com.orange.webcom.sdk.AuthDetails
 
setForcesWebView(p) - Method in class com.orange.webcom.sdk.AuthOptions
 
setGoOnline(p) - Method in class com.orange.webcom.sdk.WebcomOptions
 
setLocale(p) - Method in class com.orange.webcom.sdk.MessageDetails
 
setLogLevel(p) - Static method in class com.orange.webcom.sdk.Config
 
setLogLevel(name) - Static method in class com.orange.webcom.sdk.Config
 
setMCC() - Method in class com.orange.webcom.sdk.AuthOptions
 
setMCC(mcc) - Method in class com.orange.webcom.sdk.AuthOptions
 
setPassword(p) - Method in class com.orange.webcom.sdk.AuthDetails
 
setPersist(p) - Method in class com.orange.webcom.sdk.WebcomOptions
 
setProfile(p) - Method in class com.orange.webcom.sdk.AuthDetails
 
setScope(scope) - Method in class com.orange.webcom.sdk.AuthOptions
Adds an OAuth2 "scope" option to this class AuthOptions instance.
setSender(p) - Method in class com.orange.webcom.sdk.MessageDetails
 
setTemplate(p) - Method in class com.orange.webcom.sdk.MessageDetails
 
setWsProtocol(p) - Method in class com.orange.webcom.sdk.WebcomOptions
 
shouldBeOnline() - Method in class com.orange.webcom.sdk.Webcom
Returns the working status of the Datasync service associated with this instance wrt. to the network connection.
startAt(name) - Method in class com.orange.webcom.sdk.Query
 
startAt() - Method in class com.orange.webcom.sdk.Query
 
stringify() - Method in interface com.orange.webcom.sdk.JSONValue
Gets a string representation of this JSON value.

T

TIMESTAMP - Static variable in class com.orange.webcom.sdk.ServerValue
 
toException() - Method in class com.orange.webcom.sdk.WebcomError
 
toString() - Method in class com.orange.webcom.sdk.AuthOptions
 
toString() - Method in enum com.orange.webcom.sdk.OnAuth.AuthProvider
 
toString() - Method in enum com.orange.webcom.sdk.Query.Event
 
toString() - Method in class com.orange.webcom.sdk.Webcom
 
toString() - Method in class com.orange.webcom.sdk.WebcomApp
 
transaction(callbacks, applyLocally) - Method in class com.orange.webcom.sdk.Webcom
 
transaction(callbacks) - Method in class com.orange.webcom.sdk.Webcom
 
TransactionCallback - Interface in com.orange.webcom.sdk
 
TransactionCallback.Action - Class in com.orange.webcom.sdk
 

U

unregisterAuthCallback(onAuth) - Method in class com.orange.webcom.sdk.Webcom
 
update(value, callback) - Method in class com.orange.webcom.sdk.OnDisconnect
 
update(data, onComplete) - Method in class com.orange.webcom.sdk.Webcom
 
update(data) - Method in class com.orange.webcom.sdk.Webcom
 
updateEmailPasswordProfile(path, data, callback) - Method in class com.orange.webcom.sdk.Webcom
 
updateEmailPasswordProfile(data, callback) - Method in class com.orange.webcom.sdk.Webcom
 
updateIdentityProfile(path, data, callback) - Method in class com.orange.webcom.sdk.Webcom
 
updateIdentityProfile(data, callback) - Method in class com.orange.webcom.sdk.Webcom
 
useCurrentContextForNextAuthOperation() - Method in class com.orange.webcom.sdk.Webcom
 
useNewContextForNextAuthOperation() - Method in class com.orange.webcom.sdk.Webcom
 

V

value(extractArrays) - Method in class com.orange.webcom.sdk.DataSnapshot
 
value() - Method in class com.orange.webcom.sdk.DataSnapshot
 
value(type) - Method in class com.orange.webcom.sdk.DataSnapshot
 
valueList(type) - Method in class com.orange.webcom.sdk.DataSnapshot
 
valueMap(type) - Method in class com.orange.webcom.sdk.DataSnapshot
 
VerificationData - Class in com.orange.webcom.sdk
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.
VerificationData(auth, password) - Constructor for class com.orange.webcom.sdk.VerificationData
Builds a class VerificationData instance based on a one time verification code.
VerificationData(token) - Constructor for class com.orange.webcom.sdk.VerificationData
Builds a token-based class VerificationData instance, to verify an identity with a permanent password (email- or phone- based identity).
verifyIdentity(provider, id, data, callback) - Method in class com.orange.webcom.sdk.Webcom
Verifies the authentication details (typically msisdn or email address) of a newly created identity using the Webcom.addAccount method. If the verification is successful, then the user is automatically authenticated with the verified identity.

W

waitForReady() - Method in class com.orange.webcom.sdk.Webcom.Companion
Blocks the calling thread until the Webcom SDK has completed its initialization.
waitForReady() - Static method in class com.orange.webcom.sdk.Webcom
Blocks the calling thread until the Webcom SDK has completed its initialization.
wakeupSubscribe(id, mode, callback) - Method in class com.orange.webcom.sdk.Webcom
 
wakeupSubscribe(id, callback) - Method in class com.orange.webcom.sdk.Webcom
 
wakeupUnsubscribe(id, callback) - Method in class com.orange.webcom.sdk.Webcom
 
Webcom - Class in com.orange.webcom.sdk
A Webcom object is the entry point to the Webcom Datasync and Authentication services.
Webcom(url, options) - Constructor for class com.orange.webcom.sdk.Webcom
Deprecated. 
Webcom(url) - Constructor for class com.orange.webcom.sdk.Webcom
Deprecated. 
Webcom(url, options) - Constructor for class com.orange.webcom.sdk.Webcom
Deprecated. 
Webcom(url) - Constructor for class com.orange.webcom.sdk.Webcom
Deprecated. 
Webcom(application, options) - Constructor for class com.orange.webcom.sdk.Webcom
Creates a reference that represents the Webcom application.
Webcom(application) - Constructor for class com.orange.webcom.sdk.Webcom
Creates a reference that represents the Webcom application.
Webcom.Companion - Class in com.orange.webcom.sdk
 
WebcomApp - Class in com.orange.webcom.sdk
 
WebcomApp(appId, platform) - Constructor for class com.orange.webcom.sdk.WebcomApp
 
WebcomApp(appId) - Constructor for class com.orange.webcom.sdk.WebcomApp
 
WebcomError - Class in com.orange.webcom.sdk
 
WebcomError(errorCode, message) - Constructor for class com.orange.webcom.sdk.WebcomError
 
WebcomError.Companion - Class in com.orange.webcom.sdk
 
WebcomException - Exception in com.orange.webcom.sdk
 
WebcomException(fromError) - Constructor for exception com.orange.webcom.sdk.WebcomException
 
WebcomOptions - Class in com.orange.webcom.sdk
 
WebcomOptions(persist, goOnline, wsProtocol) - Constructor for class com.orange.webcom.sdk.WebcomOptions
 
WebcomOptions() - Constructor for class com.orange.webcom.sdk.WebcomOptions
 
WebcomRuntimeException - Exception in com.orange.webcom.sdk
 
WebcomRuntimeException(message) - Constructor for exception com.orange.webcom.sdk.WebcomRuntimeException
 
WithCustomParameter(key, value) - Method in class com.orange.webcom.sdk.AuthOptions
Adds (or removes) a custom parameter to this class AuthOptions instance with a custom value.
WithMCC() - Method in class com.orange.webcom.sdk.AuthOptions
Deprecated. 
WithMCC(mcc) - Method in class com.orange.webcom.sdk.AuthOptions
Deprecated. 
WithScope(scope) - Method in class com.orange.webcom.sdk.AuthOptions
Deprecated. 
A C D E F G H I J L M N O P Q R S T U V W 
Skip navigation links