public class ZumeroClient
extends java.lang.Object
| Modifier and Type | Class and Description |
|---|---|
static class |
ZumeroClient.SyncDetails |
| Constructor and Description |
|---|
ZumeroClient() |
| Modifier and Type | Method and Description |
|---|---|
static void |
cancel(int cancel_token)
Cancel a sync that is currently ongoing.
|
static void |
deleteQuarantine(android.content.Context context,
java.lang.String databasePath,
java.lang.String encryptionKey,
long quarantineID)
Permanently delete quarantined changes.
|
static void |
deleteQuarantine(android.content.Context context,
java.lang.String databasePath,
java.lang.String encryptionKey,
long quarantineID,
java.lang.String jsOptions)
Permanently delete quarantined changes.
|
static long |
quarantineSinceLastSync(android.content.Context context,
java.lang.String databasePath,
java.lang.String encryptionKey)
Move un-synced local changes into an isolated holding area.
|
static long |
quarantineSinceLastSync(android.content.Context context,
java.lang.String databasePath,
java.lang.String encryptionKey,
java.lang.String jsOptions)
Move un-synced local changes into an isolated holding area.
|
static void |
sync(android.content.Context context,
java.lang.String databasePath,
java.lang.String encryptionKey,
java.lang.String serverURL,
java.lang.String dbFile,
java.lang.String authScheme,
java.lang.String username,
java.lang.String password)
Sync the local database with the server database.
|
static void |
sync(android.content.Context context,
java.lang.String databasePath,
java.lang.String encryptionKey,
java.lang.String serverURL,
java.lang.String dbFile,
java.lang.String authScheme,
java.lang.String username,
java.lang.String password,
java.lang.String jsOptions,
ZumeroClient.SyncDetails details,
SyncProgressListener progListener)
Sync the local database with the server database.
|
static void |
sync(android.content.Context context,
java.lang.String databasePath,
java.lang.String encryptionKey,
java.lang.String serverURL,
java.lang.String dbFile,
java.lang.String authScheme,
java.lang.String username,
java.lang.String password,
SyncProgressListener progListener)
Sync the local database with the server database.
|
static void |
syncQuarantine(android.content.Context context,
java.lang.String databasePath,
java.lang.String encryptionKey,
long quarantineID,
java.lang.String serverURL,
java.lang.String dbFile,
java.lang.String authScheme,
java.lang.String username,
java.lang.String password)
Sync the local database with the server database, including the changes
stored in the specified quarantine.
|
static void |
syncQuarantine(android.content.Context context,
java.lang.String databasePath,
java.lang.String encryptionKey,
long quarantineID,
java.lang.String serverURL,
java.lang.String dbFile,
java.lang.String authScheme,
java.lang.String username,
java.lang.String password,
java.lang.String jsOptions,
ZumeroClient.SyncDetails details,
SyncProgressListener progListener)
Sync the local database with the server database, including the changes
stored in the specified quarantine.
|
public static void sync(android.content.Context context,
java.lang.String databasePath,
java.lang.String encryptionKey,
java.lang.String serverURL,
java.lang.String dbFile,
java.lang.String authScheme,
java.lang.String username,
java.lang.String password)
context - An Context object. This must not be null.databasePath - The full path to the database file on the device that Zumero should update This must not be null.encryptionKey - The encryption key that should be used when opening the database. This may be null.serverURL - The URL to the Zumero server. This must not be null.dbFile - The name of the DBFile on the Zumero server. This must not be null.authScheme - The Auth Scheme used by the Zumero server to validate the provided credentials. For help constructing an auth scheme, see ZumeroClient. If this is null, the request will be anonymous.username - The username to be validated by the Zumero server. If this is null, the request will be anonymous.password - The password to be validated by the Zumero server. If this is null, the request will be anonymous.public static void sync(android.content.Context context,
java.lang.String databasePath,
java.lang.String encryptionKey,
java.lang.String serverURL,
java.lang.String dbFile,
java.lang.String authScheme,
java.lang.String username,
java.lang.String password,
SyncProgressListener progListener)
context - An Context object. This must not be null.databasePath - The full path to the database file on the device that Zumero should update This must not be null.encryptionKey - The encryption key that should be used when opening the database. This may be null.serverURL - The URL to the Zumero server. This must not be null.dbFile - The name of the DBFile on the Zumero server. This must not be null.authScheme - The Auth Scheme used by the Zumero server to validate the provided credentials. For help constructing an auth scheme, see ZumeroClient. If this is null, the request will be anonymous.username - The username to be validated by the Zumero server. If this is null, the request will be anonymous.password - The password to be validated by the Zumero server. If this is null, the request will be anonymous.progListener - A progress listener which will be called at various points in the sync process.public static void sync(android.content.Context context,
java.lang.String databasePath,
java.lang.String encryptionKey,
java.lang.String serverURL,
java.lang.String dbFile,
java.lang.String authScheme,
java.lang.String username,
java.lang.String password,
java.lang.String jsOptions,
ZumeroClient.SyncDetails details,
SyncProgressListener progListener)
context - An Context object. This must not be null.databasePath - The full path to the database file on the device that Zumero should update This must not be null.encryptionKey - The encryption key that should be used when opening the database. This may be null.serverURL - The URL to the Zumero server. This must not be null.dbFile - The name of the DBFile on the Zumero server. This must not be null.authScheme - The Auth Scheme used by the Zumero server to validate the provided credentials. For help constructing an auth scheme, see ZumeroClient. If this is null, the request will be anonymous.username - The username to be validated by the Zumero server. If this is null, the request will be anonymous.password - The password to be validated by the Zumero server. If this is null, the request will be anonymous.jsOptions - JSON string requesting special sync operations. If this is null, sync will proceed as normal.details - If non-null, the object's syncId member will receive a sync details token (if requested in jsOptions).progListener - A progress listener which will be called at various points in the sync process.public static long quarantineSinceLastSync(android.content.Context context,
java.lang.String databasePath,
java.lang.String encryptionKey,
java.lang.String jsOptions)
context - An Context object. This must not be null.databasePath - The full path to the database file on the device that Zumero should update This must not be null.encryptionKey - The encryption key that should be used when opening the database. This may be null.jsOptions - JSON string requesting special sync operations. If this is null, the operation will proceed as normal.public static long quarantineSinceLastSync(android.content.Context context,
java.lang.String databasePath,
java.lang.String encryptionKey)
context - An Context object. This must not be null.databasePath - The full path to the database file on the device that Zumero should update This must not be null.encryptionKey - The encryption key that should be used when opening the database. This may be null.public static void syncQuarantine(android.content.Context context,
java.lang.String databasePath,
java.lang.String encryptionKey,
long quarantineID,
java.lang.String serverURL,
java.lang.String dbFile,
java.lang.String authScheme,
java.lang.String username,
java.lang.String password)
context - An Context object. This must not be null.databasePath - The full path to the database file on the device that Zumero should update This must not be null.encryptionKey - The encryption key that should be used when opening the database. This may be null.quarantineID - The quarantineID returned from quarantineSinceLastSync(Context, String, String)serverURL - The URL to the Zumero server. This must not be null.dbFile - The name of the DBFile on the Zumero server. This must not be null.authScheme - The Auth Scheme used by the Zumero server to validate the provided credentials. For help constructing an auth scheme, see ZumeroClient. If this is null, the request will be anonymous.username - The username to be validated by the Zumero server. If this is null, the request will be anonymous.password - The password to be validated by the Zumero server. If this is null, the request will be anonymous.public static void syncQuarantine(android.content.Context context,
java.lang.String databasePath,
java.lang.String encryptionKey,
long quarantineID,
java.lang.String serverURL,
java.lang.String dbFile,
java.lang.String authScheme,
java.lang.String username,
java.lang.String password,
java.lang.String jsOptions,
ZumeroClient.SyncDetails details,
SyncProgressListener progListener)
context - An Context object. This must not be null.databasePath - The full path to the database file on the device that Zumero should update This must not be null.encryptionKey - The encryption key that should be used when opening the database. This may be null.quarantineID - The quarantineID returned from quarantineSinceLastSync(Context, String, String)serverURL - The URL to the Zumero server. This must not be null.dbFile - The name of the DBFile on the Zumero server. This must not be null.authScheme - The Auth Scheme used by the Zumero server to validate the provided credentials. For help constructing an auth scheme, see ZumeroClient. If this is null, the request will be anonymous.username - The username to be validated by the Zumero server. If this is null, the request will be anonymous.password - The password to be validated by the Zumero server. If this is null, the request will be anonymous.jsOptions - JSON string requesting special sync operations. If this is null, sync will proceed as normal.details - If non-null, the object's syncId member will receive a sync details token (if requested in jsOptions).progListener - A progress listener which will be called at various points in the sync process.public static void deleteQuarantine(android.content.Context context,
java.lang.String databasePath,
java.lang.String encryptionKey,
long quarantineID)
context - An Context object. This must not be null.databasePath - The full path to the database file on the device that Zumero should update This must not be null.encryptionKey - The encryption key that should be used when opening the database. This may be null. * @param quarantineID The quarantineID returned from quarantineSinceLastSync(Context, String, String)public static void deleteQuarantine(android.content.Context context,
java.lang.String databasePath,
java.lang.String encryptionKey,
long quarantineID,
java.lang.String jsOptions)
context - An Context object. This must not be null.databasePath - The full path to the database file on the device that Zumero should update This must not be null.encryptionKey - The encryption key that should be used when opening the database. This may be null. * @param quarantineID The quarantineID returned from quarantineSinceLastSync(Context, String, String)jsOptions - JSON string requesting special sync operations. If this is null, the operation will proceed as normal.public static void cancel(int cancel_token)
cancel_token - The token that was provided to the SyncProgressListener's onSyncProgress method.