Package com.veeva.vault.sdk.api.document

Interface RenditionService

All Superinterfaces:

Service

public interface RenditionService
extends Service

Provides service methods to work with document renditions, including the ability to read structural metadata of PDF document renditions, such as page counts, page sizes, rotations, links, named destinations, and bookmarks.

Method Summary

Modifier and Type	Method	Description
RenditionReadBookmarkExecutionRequest.Builder	newReadBookmarkExecutionRequestBuilder()	Creates a new RenditionReadBookmarkExecutionRequest.Builder.
RenditionReadBookmarkPageRequest.Builder	newReadBookmarkPageRequestBuilder()	Creates a new RenditionReadBookmarkPageRequest.Builder.
RenditionReadNamedDestinationExecutionRequest.Builder	newReadNamedDestinationExecutionRequestBuilder()	Creates a new RenditionReadNamedDestinationExecutionRequest.Builder.
RenditionReadNamedDestinationPageRequest.Builder	newReadNamedDestinationPageRequestBuilder()	Creates a new RenditionReadNamedDestinationPageRequest.Builder.
RenditionReadPageLinkExecutionRequest.Builder	newReadPageLinkExecutionRequestBuilder()	Creates a new RenditionReadPageLinkExecutionRequest.Builder.
RenditionReadPageLinkPageRequest.Builder	newReadPageLinkPageRequestBuilder()	Creates a new RenditionReadPageLinkPageRequest.Builder.
RenditionReadPageSizeExecutionRequest.Builder	newReadPageSizeExecutionRequestBuilder()	Creates a new RenditionReadPageSizeExecutionRequest.Builder.
RenditionReadPageSizePageRequest.Builder	newReadPageSizePageRequestBuilder()	Creates a new RenditionReadPageSizePageRequest.Builder.
RenditionReadBookmarkOperation	readBookmarks(RenditionReadBookmarkRequest request)	Provides an operation to read bookmarks from PDF document renditions.
RenditionReadNamedDestinationOperation	readNamedDestinations(RenditionReadNamedDestinationRequest request)	Provides an operation to read named destinations from PDF document renditions in a paginated manner.
RenditionReadPageLinkOperation	readPageLinks(RenditionReadPageLinkRequest request)	Provides an operation to read embedded links from pages of PDF document renditions.
RenditionReadPageSizeOperation	readPageSizes(RenditionReadPageSizeRequest request)	Provides an operation to read page size, crop, and rotation information about pages of PDF document renditions.

Method Details

readBookmarks

RenditionReadBookmarkOperation readBookmarks(RenditionReadBookmarkRequest request)

Provides an operation to read bookmarks from PDF document renditions. The metadata is provided as-is. Extracted values that are considered invalid according to PDF specifications will not be sanitized when returned. Only supported actions specified by HyperlinkAction.getType() will be included with the bookmarks. Read as a flat structure in a paginated manner. Default and maximum page size is 10,000.

Parameters:

request - a RenditionReadBookmarkRequest object containing the query parameters to read bookmarks for

Returns:

a RenditionReadBookmarkOperation, which will read bookmarks from the document rendition if successful, or give an error if not successful

readNamedDestinations

RenditionReadNamedDestinationOperation readNamedDestinations(RenditionReadNamedDestinationRequest request)

Provides an operation to read named destinations from PDF document renditions in a paginated manner. Default and maximum page size is 10,000.

Parameters:

request - a RenditionReadNamedDestinationRequest object containing the query parameters to read named destinations for

Returns:

a RenditionReadNamedDestinationOperation, which will read named destinations from the document rendition if successful, or give an error if not successful

readPageLinks

RenditionReadPageLinkOperation readPageLinks(RenditionReadPageLinkRequest request)

Provides an operation to read embedded links from pages of PDF document renditions. Embedded links are also known as link annotations in PDF specifications. The pages are read using a pagination pattern, where the limit (maximum 100) and offset may be specified. The metadata is provided as-is. Extracted values that are considered invalid according to PDF specifications will not be sanitized when returned. Only supported actions specified by HyperlinkAction.getType() will be included with the links.

Parameters:

request - a RenditionReadPageLinkRequest object containing the query parameters to read embedded links for

Returns:

a RenditionReadPageLinkOperation, which will read embedded links from chunks of pages in the document renditions if successful, or give an error if not successful

readPageSizes

RenditionReadPageSizeOperation readPageSizes(RenditionReadPageSizeRequest request)

Provides an operation to read page size, crop, and rotation information about pages of PDF document renditions. The pages are read using a pagination pattern, where the limit (maximum 100) and offset may be specified.

Parameters:

request - a RenditionReadPageSizeRequest object containing the query parameters to read page size, crop, and rotation information for

Returns:

a RenditionReadPageSizeOperation, which will read page size, crop, and rotation information from chunks of pages in the document renditions if successful, or give an error if not successful

newReadBookmarkExecutionRequestBuilder

RenditionReadBookmarkExecutionRequest.Builder newReadBookmarkExecutionRequestBuilder()

Creates a new RenditionReadBookmarkExecutionRequest.Builder.

Returns:

the builder for a RenditionReadBookmarkExecutionRequest

newReadBookmarkPageRequestBuilder

RenditionReadBookmarkPageRequest.Builder newReadBookmarkPageRequestBuilder()

Creates a new RenditionReadBookmarkPageRequest.Builder.

Returns:

the builder for a RenditionReadBookmarkPageRequest

newReadNamedDestinationExecutionRequestBuilder

RenditionReadNamedDestinationExecutionRequest.Builder newReadNamedDestinationExecutionRequestBuilder()

Creates a new RenditionReadNamedDestinationExecutionRequest.Builder.

Returns:

the builder for a RenditionReadNamedDestinationExecutionRequest

newReadNamedDestinationPageRequestBuilder

RenditionReadNamedDestinationPageRequest.Builder newReadNamedDestinationPageRequestBuilder()

Creates a new RenditionReadNamedDestinationPageRequest.Builder.

Returns:

the builder for a RenditionReadNamedDestinationPageRequest

newReadPageLinkExecutionRequestBuilder

RenditionReadPageLinkExecutionRequest.Builder newReadPageLinkExecutionRequestBuilder()

Creates a new RenditionReadPageLinkExecutionRequest.Builder.

Returns:

the builder for a RenditionReadPageLinkExecutionRequest

newReadPageLinkPageRequestBuilder

RenditionReadPageLinkPageRequest.Builder newReadPageLinkPageRequestBuilder()

Creates a new RenditionReadPageLinkPageRequest.Builder.

Returns:

the builder for a RenditionReadPageLinkPageRequest

newReadPageSizeExecutionRequestBuilder

RenditionReadPageSizeExecutionRequest.Builder newReadPageSizeExecutionRequestBuilder()

Creates a new RenditionReadPageSizeExecutionRequest.Builder.

Returns:

the builder for a RenditionReadPageSizeExecutionRequest

newReadPageSizePageRequestBuilder

RenditionReadPageSizePageRequest.Builder newReadPageSizePageRequestBuilder()

Creates a new RenditionReadPageSizePageRequest.Builder.

Returns:

the builder for a RenditionReadPageSizePageRequest