DocumentViewer

Purpose

Consists of the document viewer object.

The object can be accessed using the launchbox.DocumentViewer reference.

While checking the mimetype of the file to be downloaded, the Document Viewer mechanism sends all necessary cookies for the domain.

This object belongs to the Document Viewer product module.

Name	Description
AUTHENTICATION_ERROR	Denotes that a connection to the remote document requires HTTP basic authentication.
DOCUMENT_VIEWER_IN_USE_ERROR	Denotes that the `open` method was called before the previous call finisheds or was cancelled.
DOWNLOAD_FAILED_ERROR	Denotes that download operation failed for a reason given in the description.
INTERNAL_ERROR	Thrown whenever a fatal error or improperly recognized error occurs.
INVALID_URL_ERROR	Denotes that either the URL is missing, it contains unsupported sceme or the URL value does not comply with the requirements of RFCs 1808, 1738 and 2732.
UNSUPPORTED_FILE_ERROR	Denotes that the file cannot be opened by any external application.

Name	Description
AUTHENTICATION_ANONYMOUS	Denotes that no credentials will be provided, even when HTTP basic authentication is requested.
AUTHENTICATION_CONTAINER_CREDENTIALS	Denotes that credentials retrieved from the currently open account will be provided once the HTTP basic authentication is requested.
AUTHENTICATION_CUSTOM_CREDENTIALS	Denotes that custom credentials will be provided once the HTTP basic authentication is requested.

Name	Return type	Description
canOpen	`undefined`	Checks if a document (specified by the URL address) is supported by the client device, i.e. if the specified document can be displayed.
open	`undefined`	Opens the document.
cancel	`undefined`	Cancels the document download operation initiated by the open method. Neither `onSuccess` nor `onFailure` will be called on the callback object passed to the `open` method.