io.realm

Class SyncManager

java.lang.Object

io.realm.SyncManager

public class SyncManager
extends Object

This software is considered in beta phase. It indicates that any public interface can change without prior announcements. Moreover, classes, constructors, and methods annotated as beta are not considered at production quality, and should be used with care.

The SyncManager is the central controller for interacting with the Realm Object Server. It handles the creation of SyncSessions and it is possible to configure session defaults and the underlying network client using this class.

Through the SyncManager, it is possible to add authentication listeners. An authentication listener will response to events like user logging in or out.

Default error handling for any SyncConfiguration can be added using the SyncManager.

Field Summary

Fields

Modifier and Type	Field and Description
static String	APP_ID APP ID sent to the Realm Object Server.
static ThreadPoolExecutor	NETWORK_POOL_EXECUTOR

Constructor Summary

Constructors

Constructor and Description
SyncManager()

Method Summary

Modifier and Type	Method and Description
static void	addAuthenticationListener(AuthenticationListener listener) Sets a global authentication listener that will be notified about User events like login and logout.
static AuthenticationServer	getAuthServer()
static SyncSession	getSession(SyncConfiguration syncConfiguration) Gets any cached SyncSession for the given SyncConfiguration or create a new one if no one exists.
static void	removeAuthenticationListener(AuthenticationListener listener) Removes the provided global authentication listener.
static void	setDefaultSessionErrorHandler(SyncSession.ErrorHandler errorHandler) Sets the default error handler used by all SyncConfiguration objects when they are created.
static void	setUserStore(UserStore userStore) Set the UserStore used by the Realm Object Server to save user information.

Methods inherited from class java.lang.Object

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

Field Detail

APP_ID

public static String APP_ID

APP ID sent to the Realm Object Server. Is automatically initialized to the package name for the app.

NETWORK_POOL_EXECUTOR

public static final ThreadPoolExecutor NETWORK_POOL_EXECUTOR

Constructor Detail

SyncManager

public SyncManager()

Method Detail

setUserStore

public static void setUserStore(UserStore userStore)

Set the UserStore used by the Realm Object Server to save user information. If no Userstore is specified SyncUser.currentUser() will always return null.

Parameters:

userStore - UserStore to use.

Throws:

IllegalArgumentException - if userStore is null.

addAuthenticationListener

public static void addAuthenticationListener(AuthenticationListener listener)

Sets a global authentication listener that will be notified about User events like login and logout.

Parameters:

listener - listener to register.

Throws:

IllegalArgumentException - if listener is null.

removeAuthenticationListener

public static void removeAuthenticationListener(AuthenticationListener listener)

Removes the provided global authentication listener.

Parameters:

listener - listener to remove.

setDefaultSessionErrorHandler

public static void setDefaultSessionErrorHandler(SyncSession.ErrorHandler errorHandler)

Sets the default error handler used by all SyncConfiguration objects when they are created.

Parameters:

errorHandler - the default error handler used when interacting with a Realm managed by a Realm Object Server.

getSession

public static SyncSession getSession(SyncConfiguration syncConfiguration)

Gets any cached SyncSession for the given SyncConfiguration or create a new one if no one exists.

Parameters:

syncConfiguration - configuration object for the synchronized Realm.

Returns:

the SyncSession for the specified Realm.

Throws:

IllegalArgumentException - if syncConfiguration is null.

getAuthServer

public static AuthenticationServer getAuthServer()