SyncClient

Undocumented

Sets a listener to observe login events. Replaces a previously set listener. Set to nil to remove the listener.

Sets a listener to observe sync completed events. Replaces a previously set listener. Set to nil to remove the listener.

Sets a listener to observe sync changes. Replaces a previously set listener. Set to nil to remove the listener.

Sets a listener to observe sync connection events. Replaces a previously set listener. Set to nil to remove the listener.

Sets a listener to observe all sync events. Replaces a previously set listener. Set to nil to remove the listener.

Configures how sync updates are received from the server. If automatic sync updates are turned off, they will need to be requested manually.

Gets the current sync client state.

Gets the current sync client state as a String.

Returns if this sync client is closed and can no longer be used.

Closes and cleans up all resources used by this sync client. It can no longer be used afterwards, make a new sync client instead. Does nothing if this sync client has already been closed.

Adds or replaces a Sync filter variable value for the given name.

Eventually, existing values for the same name are replaced.

Sync client filter variables can be used in server-side Sync filters to filter out objects that do not match the filters. Filter variables must be added before login, so before calling start().

Removes a previously added Sync filter variable value.

Removes all previously added Sync filter variable values.

Sets credentials to authenticate the client with the server. Build credentials using e.g. SyncCredentials.makeSharedSecret(secret).

Sets multiple credentials to authenticate the client with the server. Build credentials using e.g. SyncCredentials.makeSharedSecret(secret).

Once the sync client is configured, you can “start” it to initiate synchronization. This method triggers communication in the background and will return immediately. If the synchronization destination is reachable, this background thread will connect to the server, log in (authenticate) and, depending on “update request mode”, start syncing data. If the device, network or server is currently offline, connection attempts will be retried later using increasing backoff intervals.

Stops this sync client. Does nothing if it is already stopped or closed.

If automatic updates have been turned off via updateRequestMode, this allows manual interaction: requests the latest updates from the server once (without subscribing for future updates).

If automatic updates have been turned off via updateRequestMode, this allows manual interaction: requests the latest updates from the server and subscribes for future updates, which the server will “push”. Note: use cancelUpdates() to stop receiving further updates (pushes).

Requests the server to stop sending updates. Use requestUpdates() or requestUpdatesAndSubscribe() to request updates again.

Count the number of messages in the outgoing queue, i.e. those waiting to be sent to the server.

Counts all messages without any limitation. To apply a limit, use outgoingMessagesCount(limit:).

Note: This call uses a (read) transaction internally: 1) It’s not just a “cheap” return of a single number. While this will still be fast, avoid calling this function excessively. 2) The result follows transaction view semantics, thus it may not always match the actual value.

Like outgoingMessagesCount(), but counts messages up to a limit that’s enough for your app logic.

Experimental/Advanced API: requests a sync of all previous changes from the server.

Waits for the sync client to get into SyncState.loggedIn or until the given timeout is reached. For an asynchronous alternative, please check the listeners.

Sends a heartbeat immediately, e.g. to detect that the network connection is still operational.

Sets the interval in which the client sends “heartbeat” messages to the server, keeping the connection alive. To detect disconnects early on the client side, you can also use heartbeats with a smaller interval. Use with caution, setting a low value (i.e. sending heartbeat very often) may cause an excessive network usage as well as high server load (with many clients).