Package io.objectbox.sync

Enum Class SyncBuilder.RequestUpdatesMode

java.lang.Object

java.lang.Enum<SyncBuilder.RequestUpdatesMode>

io.objectbox.sync.SyncBuilder.RequestUpdatesMode

All Implemented Interfaces:

Serializable, Comparable<SyncBuilder.RequestUpdatesMode>, Constable

Enclosing class:

SyncBuilder

public static enum SyncBuilder.RequestUpdatesMode
extends Enum<SyncBuilder.RequestUpdatesMode>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTO	Once logged in, requests sync updates automatically including subsequent pushes for data changes.
AUTO_NO_PUSHES	Once logged in, requests updates automatically once without subsequent pushes for data changes.
MANUAL	Once logged in, does not request any sync updates automatically.

Method Summary

Modifier and Type	Method	Description
static SyncBuilder.RequestUpdatesMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SyncBuilder.RequestUpdatesMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MANUAL

public static final SyncBuilder.RequestUpdatesMode MANUAL

Once logged in, does not request any sync updates automatically.

Sync updates will have to be requested manually.

See Also:

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

AUTO

public static final SyncBuilder.RequestUpdatesMode AUTO

Once logged in, requests sync updates automatically including subsequent pushes for data changes. This is the default.

AUTO_NO_PUSHES

public static final SyncBuilder.RequestUpdatesMode AUTO_NO_PUSHES

Once logged in, requests updates automatically once without subsequent pushes for data changes.

After the initial sync update, further updates will have to be requested manually.

See Also:

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

Method Details

values

public static SyncBuilder.RequestUpdatesMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SyncBuilder.RequestUpdatesMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null