abstract boolean FileTransfer.downloadFile() throws ULjException

True if download is successful; otherwise a ULjException will be thrown and the method does not return normally.

The file specified by the setServerFileName() method is downloaded from the MobiLink server to the path specified by setLocalPath() using the specified stream, userName, password, and script version.

Further options can be specified using the setLocalFileName(), setAuthenticationParms() and setResumePartialTransfer() methods.

To avoid file corruption, for desktop and BlackBerry file system downloads, UltraLiteJ will download to a temporary file and only replace the local file once the download has completed.

For BlackBerry object store downloads, UltraLiteJ will start to write to the local store directly. This is because, in this case, it is not possible to create atomic temporary objects. If there is an existing local database store with the same name, it will be corrupted upon invoking transferFile().

A detailed result status can be fetched using the getAuthStatus(), getAuthValue(), getFileAuthCode(), isTransferredFile(), getStreamErrorCode(), and getStreamErrorMessage() methods.