public interface BookmarksInterface
Modifier and Type | Method and Description |
---|---|
ContentHandlerResult |
deleteBookmarkContent(ContentHandlerInput input)
Delete the bookmark XML content for the specified document key, if it exists.
|
ContentHandlerResult |
getBookmarkContent(ContentHandlerInput input)
Returns the bookmark XML content for the specified document key in the
form of a byte array.
|
ContentHandlerResult getBookmarkContent(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 . |
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
|
KEY_HTTP_SERVLET_REQUEST | javax.servlet.http.HttpServletRequest | Request that called this method. Can be retrieved with
|
Key | Type | Description |
---|---|---|
KEY_BOOKMARK_CONTENT | byte[] | Contents of the bookmark XML file, or null if no bookmarks are associated with the given document. |
VirtualViewerAPIException
- if content handler throws exceptionContentHandlerResult deleteBookmarkContent(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 . |
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
|
KEY_HTTP_SERVLET_REQUEST | javax.servlet.http.HttpServletRequest | Request that called this method. Can be retrieved with
|
VirtualViewerAPIException
- if content handler throws exceptionCopyright © 2019 Snowbound Software Corporation. All rights reserved.