FileTransfer interface

Provides a mechanism to transfer files between the client and a MobiLink server.

Syntax

public interface FileTransfer

Members

All members of FileTransfer interface, including all inherited members.

Name	Description
downloadFile method	Downloads the file with the specified properties of this object.
getAuthenticationParms method	Returns parameters provided to a custom user authentication script.
getAuthStatus method	Returns the authorization status code of the last file transfer attempt.
getAuthValue method	Returns the value specified in custom user authentication synchronization scripts.
getFileAuthCode method	Returns the return value from the authenticate_file_transfer script for the last file transfer attempt.
getLivenessTimeout method	Returns the liveness timeout length, in seconds.
getLocalFileName method	Determines the local file name.
getLocalPath method	Specifies where to find or store the file in the local file system.
getPassword method	Returns the MobiLink password for the user specified with setUserName.
getRemoteKey method	Determines the current remote key value.
getServerFileName method	Returns the name of the file on the server.
getStreamErrorCode method	Returns the error code reported by the stream.
getStreamErrorMessage method	Returns the error message reported by the stream itself.
getStreamParms method	Returns the parameters used to configure the synchronization stream.
getUserName method	Returns the MobiLink user name that uniquely identifies the client to the MobiLink server.
getVersion method	Returns the synchronization script to use.
isResumePartialTransfer method	Determines whether to resume or discard a previous partial transfer.
isTransferredFile method	Checks whether the file was actually downloaded during the last file transfer attempt.
setAuthenticationParms method	Specifies parameters for a custom user authentication script (MobiLink authenticate_parameters connection event).
setLivenessTimeout method	Sets the liveness timeout length, in seconds.
setLocalFileName method	Specifies the local file name.
setLocalPath method	Specifies where to find or store the file in the local file system.
setPassword method	Sets the MobiLink password for the user specified with setUserName.
setRemoteKey method	Specifies the remote key.
setResumePartialTransfer method	Specifies whether to resume or discard a previous partial transfer.
setServerFileName method	Specifies the name of the file on the server.
setUserName method	Sets the MobiLink user name that uniquely identifies the client to the MobiLink server.
setVersion method	Sets the synchronization script to use.
uploadFile method	Uploads the file with the specified properties of this object.

Remarks

A FileTransfer object is obtained by calling the createFileTransfer() or createObjectStoreTransfer() (BlackBerry only) methods of the DatabaseManager class.

The instance returned by createFileTransfer() can be used to transfer any files between MobiLink and the local file system. For the BlackBerry 4.2 and later devices and simulators, the local file system is either a media card or internal flash file system (if available on the device). For file name restrictions, see the description of the createConfigurationFileME method on the DatabaseManager class.

The instance returned by createObjectStoreTransfer() can be used to download UltraLiteJ database files to the local BlackBerry object store, or vice versa. Only valid, unencrypted UltraLiteJ database files could be transferred. Attempting to download any files other than UltraLiteJ databases will result in exceptions being thrown.

Note that the application should not simutaneously start two downloads to the same local file.