Package io.objectbox.sync

Class SyncBuilder

java.lang.Object

io.objectbox.sync.SyncBuilder

public final class SyncBuilder
extends Object

A builder to create a SyncClient; the builder itself should be created via Sync.client(BoxStore, String, SyncCredentials).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SyncBuilder.RequestUpdatesMode

Constructor Summary

Constructors

Constructor	Description
SyncBuilder(BoxStore boxStore, SyncCredentials credentials)	When using this constructor, make sure to set the server URL before starting.
SyncBuilder(BoxStore boxStore, String url, SyncCredentials credentials)
SyncBuilder(BoxStore boxStore, String url, SyncCredentials[] multipleCredentials)

Method Summary

Modifier and Type	Method	Description
SyncClient	build()	Builds and returns a Sync client ready to SyncClient.start().
SyncClient	buildAndStart()	Builds, starts and returns a Sync client.
SyncBuilder	changeListener(SyncChangeListener changeListener)	Sets a listener to observe fine granular changes happening during sync.
SyncBuilder	completedListener(SyncCompletedListener completedListener)	Sets a listener to only observe Sync completed events.
SyncBuilder	connectionListener(SyncConnectionListener connectionListener)	Sets a listener to only observe Sync connection events.
SyncBuilder	listener(SyncListener listener)	Sets a listener to observe all Sync events like login or sync completion.
SyncBuilder	loginListener(SyncLoginListener loginListener)	Sets a listener to only observe Sync login events.
SyncBuilder	requestUpdatesMode(SyncBuilder.RequestUpdatesMode requestUpdatesMode)	Configure automatic sync updates from the server.
SyncBuilder	timeListener(SyncTimeListener timeListener)	Sets a listener to only observe Sync time events.
SyncBuilder	trustedCertificates(String[] paths)	Configures a custom set of directory or file paths to search for trusted certificates in.
SyncBuilder	uncommittedAcks()	Turns on sending of uncommitted acks.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SyncBuilder

@Internal
public SyncBuilder(BoxStore boxStore,
 String url,
 @Nullable
 SyncCredentials credentials)

SyncBuilder

@Internal
public SyncBuilder(BoxStore boxStore,
 String url,
 @Nullable
 SyncCredentials[] multipleCredentials)

SyncBuilder

@Internal
public SyncBuilder(BoxStore boxStore,
 @Nullable
 SyncCredentials credentials)

When using this constructor, make sure to set the server URL before starting.

Method Details

trustedCertificates

public SyncBuilder trustedCertificates(String[] paths)

Configures a custom set of directory or file paths to search for trusted certificates in. The first path that exists will be used.

Using this option is not recommended in most cases, as by default the sync client uses the certificate authorities trusted by the host platform.

requestUpdatesMode

public SyncBuilder requestUpdatesMode(SyncBuilder.RequestUpdatesMode requestUpdatesMode)

Configure automatic sync updates from the server. If automatic sync updates are turned off, they will need to be requested using the sync client.

See Also:

• SyncClient.requestUpdates()
• SyncClient.requestUpdatesOnce()

uncommittedAcks

public SyncBuilder uncommittedAcks()

Turns on sending of uncommitted acks.

loginListener

public SyncBuilder loginListener(SyncLoginListener loginListener)

Sets a listener to only observe Sync login events.

This listener can also be set or removed on the Sync client directly.

completedListener

public SyncBuilder completedListener(SyncCompletedListener completedListener)

Sets a listener to only observe Sync completed events.

This listener can also be set or removed on the Sync client directly.

changeListener

public SyncBuilder changeListener(SyncChangeListener changeListener)

Sets a listener to observe fine granular changes happening during sync.

This listener can also be set or removed on the Sync client directly.

timeListener

public SyncBuilder timeListener(SyncTimeListener timeListener)

Sets a listener to only observe Sync time events.

This listener can also be set or removed on the Sync client directly.

connectionListener

public SyncBuilder connectionListener(SyncConnectionListener connectionListener)

Sets a listener to only observe Sync connection events.

This listener can also be set or removed on the Sync client directly.

listener

public SyncBuilder listener(SyncListener listener)

Sets a listener to observe all Sync events like login or sync completion.

Note: this will replace any login, completed or connection listener.

This listener can also be set or removed on the Sync client directly.

build

public SyncClient build()

Builds and returns a Sync client ready to SyncClient.start().

buildAndStart

public SyncClient buildAndStart()

Builds, starts and returns a Sync client.