Maintains the parameters used during the database synchronization process.
public class SyncParms
All members of SyncParms class, including all inherited members.
Name | Description |
---|---|
Determines if the client sends download acknowledgments. | |
Returns parameters provided to a custom user authentication script. | |
Returns the liveness timeout length, in seconds. | |
Returns the new MobiLink password for the user specified with the setUserName method. | |
Returns the MobiLink password for the user specified with the setUserName method. | |
Returns the publications to be synchronized. | |
Returns true if column names are sent to the MobiLink server. | |
Returns the parameters used to configure the synchronization stream. | |
Returns the currently specified SyncObserver object. | |
Returns the SyncResult object that contains the status of the synchronization. | |
Returns the order in which tables should be uploaded to the consolidated database. | |
Returns the MobiLink user name that uniquely identifies the client to the MobiLink server. | |
Returns the script version to use. | |
Determines if the synchronization is download-only. | |
Determines whether the client pings the MobiLink server or performs a synchronization. | |
Determines if the synchronization is upload-only. | |
Specifies whether the client should send download acknowledgements. | |
Specifies parameters for a custom user authentication script (MobiLink authenticate_parameters connection event). | |
Sets the synchronization as download-only. | |
Sets the liveness timeout length, in seconds. | |
Sets a new MobiLink password for the user specified with setUserName method. | |
Sets the MobiLink password for the user specified with the setUserName method. | |
Sets the client to ping the MobiLink server rather than perform a synchronization. | |
Sets the publications to be synchronized. | |
Specifies whether column names are sent to the MobiLink server during a synchronization. | |
Sets a SyncObserver object to monitor the progress of the synchronization. | |
Sets the order in which tables should be uploaded to the consolidated database. | |
Sets the synchronization as upload-only. | |
Sets the MobiLink user name that uniquely identifies the client to the MobiLink server. | |
Sets the synchronization script to use. | |
Creates a SyncParms object for HTTP synchronizations. | |
Creates a SyncParms object for secure HTTPS synchronizations. |
This interface is invoked with the Connection.createSyncParms method.
You can only set one synchronization command at a time. These commands are specified using the setDownloadOnly, setPingOnly, and setUploadOnly methods. By setting one of these methods to true, you set the other methods to false.
The UserName and Version parameters must be set. The UserName must be unique for each client database.
The communication stream is configured using the getStreamParms method based on the type of SyncParms object. For example, the following code prepares and performs an HTTP synchronization:
SyncParms syncParms = myConnection.createSyncParms( SyncParms.HTTP_STREAM, "MyUniqueMLUserID", "MyMLScriptVersion" ); syncParms.setPassword("ThePWDforMyUniqueMLUserID"); syncParms.getStreamParms().setHost("MyMLHost"); myConnection.synchronize(syncParms); |
Comma Separated Lists
AuthenticationParms, Publications, and TableOrder parameters are all specified using a string value that contains a comma separated list of values. Values within the list may be quoted using either single quotes or double quotes, but there are no escape characters. Leading and trailing spaces in values are ignored unless quoted. For example, the following code specifies Table A, then Table B,D, then Table C":
syncParms.setTableOrder("'Table A',\"Table B,D",Table C" ); |
specifies
getAcknowledgeDownload method
getAuthenticationParms method
getLivenessTimeout method
getNewPassword method
getPassword method
getPublications method
getSendColumnNames method
getStreamParms method
getSyncObserver method
getSyncResult method
getTableOrder method
getUserName method
getVersion method
isDownloadOnly method
isPingOnly method
isUploadOnly method
setAcknowledgeDownload method
setAuthenticationParms method
setDownloadOnly method
setLivenessTimeout method
setNewPassword method
setPassword method
setPingOnly method
setPublications method
setSendColumnNames method
setSyncObserver method
setTableOrder method
setUploadOnly method
setUserName method
setVersion method
HTTP_STREAM variable
HTTPS_STREAM variable
Discuss this page in DocCommentXchange.
|
Copyright © 2012, iAnywhere Solutions, Inc. - SQL Anywhere 12.0.1 |