io.realm

Enum ClientResyncMode

java.lang.Object

java.lang.Enum<ClientResyncMode>

io.realm.ClientResyncMode

All Implemented Interfaces:

Serializable, Comparable<ClientResyncMode>

public enum ClientResyncMode
extends Enum<ClientResyncMode>

Enum describing what should happen in case of a Client Resync.

A Client Resync is triggered if the device and server cannot agree on a common shared history for the Realm file, thus making it impossible for the device to upload or receive any changes. This can happen if the server is rolled back or restored from backup.

IMPORTANT: Just having the device offline will not trigger a Client Resync.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISCARD_LOCAL_REALM The local Realm will be discarded and replaced with the server side Realm.
MANUAL A manual Client Resync is also known as a Client Reset.
RECOVER_LOCAL_REALM Realm will compare the local Realm with the Realm on the server and automatically transfer any changes from the local Realm that makes sense to the Realm provided by the server.

Method Summary

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

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RECOVER_LOCAL_REALM

public static final ClientResyncMode RECOVER_LOCAL_REALM

Realm will compare the local Realm with the Realm on the server and automatically transfer any changes from the local Realm that makes sense to the Realm provided by the server.

This is the default mode for fully synchronized Realms. It is not yet supported by Query-based Realms.

DISCARD_LOCAL_REALM

public static final ClientResyncMode DISCARD_LOCAL_REALM

The local Realm will be discarded and replaced with the server side Realm. All local changes will be lost.

This mode is not yet supported by Query-based Realms.

MANUAL

public static final ClientResyncMode MANUAL

A manual Client Resync is also known as a Client Reset.

A ClientResetRequiredError will be sent to SyncSession.ErrorHandler.onError(SyncSession, ObjectServerError), triggering a Client Reset. Doing this provides a handle to both the old and new Realm file, enabling full control of which changes to move, if any.

This is the only supported mode for Query-based Realms.

See Also:

for more information about when and why Client Reset occurs and how to deal with it.

Method Detail

values

public static ClientResyncMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ClientResyncMode c : ClientResyncMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static ClientResyncMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getNativeValue

public byte getNativeValue()