Webcom Android API/com.orange.webcom.sdk.datasync/DatasyncNode

DatasyncNode

class DatasyncNode(manager: DatasyncManager, val path: String) : Subscriber

Represents a data node within the tree-like data of a Webcom application.

This class provides basic methods to browse, read, write data nodes, as well as subscribe to some events at a data node. Instances of DatasyncNode are built using the DatasyncManager.node method.

Constructors

DatasyncNode

fun DatasyncNode(manager: DatasyncManager, path: String)

Functions

cancelNextDisconnectionAction

fun cancelNextDisconnectionAction(callback: WebcomDoneCallback? = null)

Cancels any previous write operation on this data node with the DatasyncTime.AtNextDisconnection policy.

cancelSubscriptionsThroughPushNotification

@JvmOverloads

fun cancelSubscriptionsThroughPushNotification(cipher: CryptoMethod = CryptoMethod.None, callback: WebcomDoneCallback? = null)

Cancel all subscriptions previously subscribed through the mobile push notification channel of the user mobile device (with the subscribeThroughPushNotification method).

cancelSubscriptionsThroughWebhook

@JvmOverloads

fun cancelSubscriptionsThroughWebhook( identifier: String, context: String, callback: WebcomDoneCallback? = null)

Cancel all subscriptions previously subscribed through the webhook channel (with the subscribeThroughWebhook method).

clear

@JvmOverloads

fun clear(at: DatasyncTime = DatasyncTime.Now, callback: WebcomDoneCallback? = null)

Clears data at this data node asynchronously.

createChild

fun createChild(): DatasyncNode

Returns a child of this data node with a unique key.

div

operator fun div(path: String): DatasyncNode

Shortcut for relativeNode.

get

fun get(constraint: Constraint = Constraint.None, callback: WebcomResultCallback<DatasyncValue>)

Reads asynchronously the data at this data node, with a possible constraint.

getFromCache

fun getFromCache(): DatasyncValue

Reads the data stored in the local cache at this data node. This method returns synchronously and doesn't send any request to the Webcom back end.

increment

@JvmOverloads

fun increment( step: Number, startValue: Number = 0, callback: WebcomResultCallback<Number>? = null)

Atomically increments the value at this data node by a given step.

merge

@JvmOverloads

fun merge(value: Any?, callback: WebcomDoneCallback? = null)

Convenient shortcut for merge(DatasyncTime.Now, value, callback).

@JvmOverloads

fun merge( at: DatasyncTime, value: Any?, callback: WebcomDoneCallback? = null)

Merges some data with the data at this data node asynchronously.

plusAssign

operator fun plusAssign(value: Any?)

Shortcut for push.

push

@JvmOverloads

fun push(value: Any?, callback: WebcomResultCallback<String>? = null): DatasyncNode

Creates a child of this data node with a unique key and writes a given value at it.

relativeNode

fun relativeNode(relativePath: String): DatasyncNode

Returns the data done specified by a path relatively to the data node represented by this DatasyncNode instance.

runTransaction

@JvmOverloads

fun runTransaction(transaction: (DatasyncValue) -> TransactionOperation, callback: WebcomResultCallback<TransactionResult>? = null)

Performs an atomic write operation (or transaction) on this data node.

set

@JvmOverloads

fun set(value: Any?, callback: WebcomDoneCallback? = null)

Convenient shortcut for set(DatasyncTime.Now, value, callback).

@JvmOverloads

fun set( at: DatasyncTime, value: Any?, callback: WebcomDoneCallback? = null)

Writes some data at this data node asynchronously.

fun <T : SubscribableEvent> subscribe( type: KClass<T>, constraint: Constraint = Constraint.None, options: SubscriptionOptions = SubscriptionOptions()): LiveData<Notification<T>>

Same as Subscriber.subscribe, but use a LiveData object rather than callback to notify events to the user

fun <T : SubscribableEvent> subscribe( type: KClass<T>, constraint: Constraint = Constraint.None, options: SubscriptionOptions = SubscriptionOptions(), callback: (Notification<T>) -> Unit): Subscription

Subscribes to a type of event with a given constraint on this data node and sends notifications to a callback function.

subscribeThroughPushNotification

@RequiresApi(value = 26)

fun <T : SubscribableEvent> subscribeThroughPushNotification( type: KClass<T>, duration: Duration, cipher: CryptoMethod = CryptoMethod.None, includesRevocation: Boolean = true, callback: WebcomResultCallback<LongTermSubscription>)

Subscribes to a type of event on this data node for a given duration and send notifications through the mobile push notification channel of the user mobile device.

fun <T : SubscribableEvent> subscribeThroughPushNotification( type: KClass<T>, expirationDate: Date? = null, cipher: CryptoMethod = CryptoMethod.None, includesRevocation: Boolean = true, callback: WebcomResultCallback<LongTermSubscription>)

Subscribes to a type of event on this data node until a given expirationDate and send notifications through the mobile push notification channel of the user mobile device.

subscribeThroughWebhook

@RequiresApi(value = 26)

fun <T : SubscribableEvent> subscribeThroughWebhook( type: KClass<T>, identifier: String, context: String, duration: Duration, includesRevocation: Boolean = true, callback: WebcomResultCallback<LongTermSubscription>)

Subscribes to a type of event on this data node for a given duration and send notifications to a webhook.

fun <T : SubscribableEvent> subscribeThroughWebhook( type: KClass<T>, identifier: String, context: String, expirationDate: Date? = null, includesRevocation: Boolean = true, callback: WebcomResultCallback<LongTermSubscription>)

Subscribes to a type of event on this data node until a given expirationDate and send notifications to a webhook.

Properties

key

val key: String

Gives the key of the data node represented by this DatasyncNode instance, that is, the name of the last segment of its path.

parent

val parent: DatasyncNode?

Gets the parent data node of this DatasyncNode instance.

path

val path: String

The path of this data node within the Webcom application.

timestamp

val timestamp: Date

Gets the timestamp encoded within the key of this DatasyncNode, when it has been generated using the createChild or push methods.