public interface SendDocumentInterface
Modifier and Type | Method and Description |
---|---|
ContentHandlerResult |
sendDocumentContent(ContentHandlerInput input)
This method gets called to send a document via a mechanism defined by the content handler.
|
ContentHandlerResult sendDocumentContent(ContentHandlerInput input) throws VirtualViewerAPIException
input
- ContentHandlerInput containing the following values:
Key | Type | Description |
---|---|---|
KEY_DOCUMENT_CONTENT | byte[] | The document file content. Can be retrieved with byte[] documentContent= input.getDocumentContent(); . |
KEY_DOCUMENT_FORMAT | int |
An integer code representing the document format. Can be retrieved along with a format information object with the following code:
|
KEY_MERGE_ANNOTATIONS | boolean | Whether annotations have been merged into the document to be sent. Can be retrieved with boolean annotationsMerged = input.getMergeAnnotations(); . |
KEY_DOCUMENT_ID | java.lang.String | The key representing the document. Can be retrieved with String documentId = input.getDocumentId(); . |
KEY_CLIENT_INSTANCE_ID | java.lang.String | Custom configurable value used to pass data from client to content handler. If not set then will be
the session ID. Can be retrieved with String clientInstanceId = input.getClientInstanceId(); |
KEY_HTTP_SERVLET_REQUEST | javax.servlet.http.HttpServletRequest | Request that called this method. Can be retrieved with HttpServletRequest request = input.getHttpServletRequest(); |
VirtualViewerAPIException
- if content handler throws exceptionCopyright © 2020 Snowbound Software Corporation. All rights reserved.