SyncClient (objectbox-java 2.9.2-RC API)

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

SyncClientImpl
```
@Experimental
public interface SyncClient
extends java.io.Closeable
```
ObjectBox sync client. Build a client with Sync.client(io.objectbox.BoxStore, java.lang.String, io.objectbox.sync.SyncCredentials). Keep the instance around (avoid garbage collection) while you want to have sync ongoing. For a clean shutdown, call close().
SyncClient is thread-safe.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`awaitFirstLogin(long millisToWait)` Waits until the sync client receives a response to its first (connection and) login attempt or until the given time has expired.
`boolean`	`cancelUpdates()` Asks the server to pause sync updates.
`void`	`close()` Closes and cleans up all resources used by this sync client.
`long`	`getLastLoginCode()` Response code of last login attempt.
`java.lang.String`	`getServerUrl()` Gets the sync server URL this client is connected to.
`boolean`	`isLoggedIn()` Flag indicating if the sync client was started.
`boolean`	`isStarted()` Flag indicating if the sync client was started.
`void`	`notifyConnectionAvailable()` Lets the sync client know that a working network connection is available.
`boolean`	`requestFullSync()` Experimental.
`boolean`	`requestUpdates()` Asks the sync server to resume sync updates.
`boolean`	`requestUpdatesOnce()` Asks the server to send sync updates until this sync client is up-to-date, then pauses sync updates again.
`void`	`setLoginCredentials(SyncCredentials credentials)` Updates the login credentials.
`void`	`setSyncChangeListener(SyncChangeListener listener)` Sets a `SyncChangeListener`.
`void`	`setSyncCompletedListener(SyncCompletedListener listener)` Sets a listener to observe Sync completed events.
`void`	`setSyncConnectionListener(SyncConnectionListener listener)` Sets a listener to observe Sync connection events.
`void`	`setSyncListener(SyncListener listener)` Sets a listener to observe all Sync events.
`void`	`setSyncLoginListener(SyncLoginListener listener)` Sets a listener to observe login events.
`void`	`start()` Starts the client.
`void`	`stop()` Stops the client.

- Method Detail
  - getServerUrl
```
java.lang.String getServerUrl()
```
    Gets the sync server URL this client is connected to.
  - isStarted
```
boolean isStarted()
```
    Flag indicating if the sync client was started. Started clients try to connect, login, and sync with the sync destination.
  - isLoggedIn
```
boolean isLoggedIn()
```
    Flag indicating if the sync client was started. Logged in clients can sync with the sync destination to exchange data.
  - getLastLoginCode
```
long getLastLoginCode()
```
    Response code of last login attempt. One of SyncLoginCodes.
  - setSyncLoginListener
```
void setSyncLoginListener(@Nullable
                          SyncLoginListener listener)
```
    Sets a listener to observe login events. Replaces a previously set listener. Set to null to remove the listener.
  - setSyncCompletedListener
```
void setSyncCompletedListener(@Nullable
                              SyncCompletedListener listener)
```
    Sets a listener to observe Sync completed events. Replaces a previously set listener. Set to null to remove the listener.
  - setSyncConnectionListener
```
void setSyncConnectionListener(@Nullable
                               SyncConnectionListener listener)
```
    Sets a listener to observe Sync connection events. Replaces a previously set listener. Set to null to remove the listener.
  - setSyncListener
```
void setSyncListener(@Nullable
                     SyncListener listener)
```
    Sets a listener to observe all Sync events. Replaces all other previously set listeners, except a SyncChangeListener. Set to null to remove the listener.
  - setSyncChangeListener
```
void setSyncChangeListener(@Nullable
                           SyncChangeListener listener)
```
    Sets a SyncChangeListener. Replaces a previously set listener. Set to null to remove the listener.
  - setLoginCredentials
```
void setLoginCredentials(SyncCredentials credentials)
```
    Updates the login credentials. This should not be required during regular use. The original credentials were passed when building sync client.
  - awaitFirstLogin
```
boolean awaitFirstLogin(long millisToWait)
```
    Waits until the sync client receives a response to its first (connection and) login attempt or until the given time has expired. Use isLoggedIn() or getLastLoginCode() afterwards to determine if login was successful. Starts the sync if it is not already.
    
    Returns:
    
    true if a response was received in the given time window.
  - start
```
void start()
```
    Starts the client. It will connect to the server, log in (authenticate) and start syncing.
  - stop
```
void stop()
```
    Stops the client. Does nothing if the sync client is already stopped or closed.
  - close
```
void close()
```
    Closes and cleans up all resources used by this sync client. It can no longer be used afterwards, build a new sync client instead. Does nothing if this sync client has already been closed.
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in interface java.io.Closeable
  - requestUpdates
```
boolean requestUpdates()
```
    Asks the sync server to resume sync updates. This is useful if sync updates were turned off with requestUpdatesMode(MANUAL).
    
    Returns:
    
    'true' if the request was likely sent (e.g. the sync client is in "logged in" state) or 'false' if the request was not sent (and will not be sent in the future)
    
    See Also:
    
    cancelUpdates()
  - requestUpdatesOnce
```
boolean requestUpdatesOnce()
```
    Asks the server to send sync updates until this sync client is up-to-date, then pauses sync updates again. This is useful if sync updates were turned off with requestUpdatesMode(MANUAL).
    
    Returns:
    
    'true' if the request was likely sent (e.g. the sync client is in "logged in" state) or 'false' if the request was not sent (and will not be sent in the future)
  - cancelUpdates
```
boolean cancelUpdates()
```
    Asks the server to pause sync updates.
    
    Returns:
    
    'true' if the request was likely sent (e.g. the sync client is in "logged in" state) or 'false' if the request was not sent (and will not be sent in the future)
    
    See Also:
    
    requestUpdates()
  - requestFullSync
```
@Experimental
boolean requestFullSync()
```
    Experimental. This API might change or be removed in the future.
    Temporary only, try not to use it.
    Request a sync of all previous changes from the server.
    
    Returns:
    
    'true' if the request was likely sent (e.g. the sync client is in "logged in" state) or 'false' if the request was not sent (and will not be sent in the future).
  - notifyConnectionAvailable
```
void notifyConnectionAvailable()
```
    Lets the sync client know that a working network connection is available.
    This can help speed up reconnecting to the sync server.

Interface SyncClient

Method Summary

Method Detail

getServerUrl

isStarted

isLoggedIn

getLastLoginCode

setSyncLoginListener

setSyncCompletedListener

setSyncConnectionListener

setSyncListener

setSyncChangeListener

setLoginCredentials

awaitFirstLogin

start

stop

close

requestUpdates

requestUpdatesOnce

cancelUpdates

requestFullSync

notifyConnectionAvailable