public interface DocumentNotesInterface
Modifier and Type | Method and Description |
---|---|
ContentHandlerResult |
deleteNotesContent(ContentHandlerInput input)
Called when the client has requested to delete all notes for the specified document.
|
ContentHandlerResult |
getNotesContent(ContentHandlerInput input)
Returns the contents of the document notes XML file for the specified document key in the
form of a byte array.
|
ContentHandlerResult getNotesContent(ContentHandlerInput input) throws VirtualViewerAPIException
input
- ContentHandlerInput containing the following values:
Key | Type | Description |
---|---|---|
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(); |
Key | Type | Description |
---|---|---|
KEY_NOTES_CONTENT | byte[] | Contents of the document notes XML file, or null if no document notes have been saved. |
VirtualViewerAPIException
- if content handler throws exceptionContentHandlerResult deleteNotesContent(ContentHandlerInput input) throws VirtualViewerAPIException
input
- ContentHandlerInput containing the following values:
Key | Type | Description |
---|---|---|
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.