com.kony.sdk.services.sync

Interface Sync

public interface Sync

Containing the methods of the sync life cycle.

Method Summary

Modifier and Type	Method and Description
void	addListener(SyncListener listener) Add the listener implementation to the sync process.
void	initSync() Initializes the sync.
void	initSync(String passPhrase) Initializes the sync with passPhrase This method needs to be called before calling any other sync API.
void	initSyncInBackground(String passPhrase, SyncCallback syncCallback) Initializes the sync in the background thread with passPhrase.
void	initSyncInBackground(SyncCallback syncCallback) Initializes the sync in the background thread with passPhrase.
void	isUpgradeRequiredInBackground() check whether sync upgrade is required from sync server
void	performUpgradeInBackground() perform sync upgrade
void	resetSync() Reset the local device database.
void	resetSyncInBackground(SyncCallback syncCallback) Reset the local device database in the background thread.
void	resetSyncOptions() Resets all sync options to default values
void	setAuthToken(String authTokem) Sets the auth token for the synchronization
void	setDownloadBatchSize(int batchSize) Sets download batch size, default value is 500
void	setPassword(String pwd) Sets the password for authenticating during synchronization.
void	setSchema(String[] schema) Used to set the schema dynamically
void	setServerURL(String url) Sets the sync server URL without the port
void	setServerURL(String url, int portNo) Sets the sync server URL and port
void	setServerURL(String url, int portNo, boolean isSecure) Sets the sync server URL and port
void	setSyncOptions(SyncOptions syncOptions) Sets various sync options
void	setUploadBatchSize(int batchSize) Sets upload batch size, default value is 50
void	setUserId(String userId) Sets the userid for authenticating during synchronization.
void	startSessionInBackground() Start the sync in background thread

Method Detail

setServerURL

void setServerURL(String url)
           throws KonyException

Sets the sync server URL without the port

Parameters:

url -

Throws:

KonyException

setServerURL

void setServerURL(String url,
                  int portNo)
           throws KonyException

Sets the sync server URL and port

Parameters:

url -

portNo -

Throws:

KonyException

setServerURL

void setServerURL(String url,
                  int portNo,
                  boolean isSecure)
           throws KonyException

Sets the sync server URL and port

Parameters:

url -

portNo -

isSecure - - if true secure way of sending request to Sync server

Throws:

KonyException

initSync

void initSync()
       throws KonyException

Initializes the sync. This method needs to be called before calling any other sync API.

Throws:

KonyException

initSync

void initSync(String passPhrase)
       throws KonyException

Initializes the sync with passPhrase This method needs to be called before calling any other sync API.

Parameters:

passPhrase -

Throws:

KonyException

initSyncInBackground

void initSyncInBackground(SyncCallback syncCallback)

Initializes the sync in the background thread with passPhrase. This method needs to be called before calling any other sync API.

Parameters:

syncCallback -

initSyncInBackground

void initSyncInBackground(String passPhrase,
                          SyncCallback syncCallback)

Initializes the sync in the background thread with passPhrase. This method needs to be called before calling any other sync API.

Parameters:

passPhrase -

syncCallback -

startSessionInBackground

void startSessionInBackground()

Start the sync in background thread

addListener

void addListener(SyncListener listener)

Add the listener implementation to the sync process.

Parameters:

listener -

setAuthToken

void setAuthToken(String authTokem)
           throws KonyException

Sets the auth token for the synchronization

Parameters:

authTokem -

Throws:

KonyException

setUserId

void setUserId(String userId)
        throws KonyException

Sets the userid for authenticating during synchronization. Setting userid is not needed when auth token is set

Parameters:

userId -

Throws:

KonyException

setPassword

void setPassword(String pwd)
          throws KonyException

Sets the password for authenticating during synchronization. Setting password is not needed when auth token is set

Parameters:

pwd -

Throws:

KonyException

resetSync

void resetSync()
        throws KonyException

Reset the local device database. All the data will be removed from the local database.

Throws:

KonyException

resetSyncInBackground

void resetSyncInBackground(SyncCallback syncCallback)

Reset the local device database in the background thread. All the data will be removed from the local database.

Parameters:

syncCallback -

setDownloadBatchSize

void setDownloadBatchSize(int batchSize)
                   throws KonyException

Sets download batch size, default value is 500

Parameters:

batchSize -

Throws:

KonyException

setUploadBatchSize

void setUploadBatchSize(int batchSize)
                 throws KonyException

Sets upload batch size, default value is 50

Parameters:

batchSize -

Throws:

KonyException

setSyncOptions

void setSyncOptions(SyncOptions syncOptions)
             throws KonyException

Sets various sync options

Parameters:

syncOptions -

Throws:

KonyException

See Also:

SyncOptions

resetSyncOptions

void resetSyncOptions()
               throws KonyException

Resets all sync options to default values

Throws:

KonyException

isUpgradeRequiredInBackground

void isUpgradeRequiredInBackground()

check whether sync upgrade is required from sync server

Throws:

KonyException

performUpgradeInBackground

void performUpgradeInBackground()

perform sync upgrade

Throws:

KonyException

setSchema

void setSchema(String[] schema)

Used to set the schema dynamically

Parameters:

schema -