DatasyncService

class DatasyncService : WebcomAbstractService

The WebcomAbstractService that makes it possible to interact in real time with the data of a Webcom application.

This service mainly provides ways to get/set/update the data and to subscribe to them in order to be notified in real time when they change. Instances of DatasyncService must be built using the WebcomApplication.datasyncService property.

Functions

cleanOfflineCache

fun cleanOfflineCache()

Stops maintaining updates of data previously watched by canceled subscriptions within the local cache.

createManager

fun createManager(policy: SubscriptionCancelationPolicy = SubscriptionCancelationPolicy.KeepUpdatingWhenImplicit): DatasyncManager

Asks the DatasyncService to create a new DatasyncManager instance.

isPresent

fun isPresent(value: PresenceState?): Boolean

Indicates whether a value previously set by the startPublishingMyPresence method means that a user is present.

offlineCache

fun offlineCache(): String

Retrieves the content of the current local cache content.

startPublishingMyPresence

fun startPublishingMyPresence(path: String)

Starts maintaining a value at a given path that indicates in real time whether the user of the underlying WebcomApplication is connected and authenticated.

stopPublishingMyPresence

fun stopPublishingMyPresence()

Stops maintaining the indicator of the user presence, previously started by the startPublishingMyPresence method.

Properties

isConnectionEnabled

var isConnectionEnabled: Boolean

Indicates whether the DatasyncService tries to establish connection to the Webcom back end.

state

val state: DatasyncState

Synchronously returns the current state of this DatasyncService.