Interface DocumentUrlRequest.Builder
- Enclosing interface:
DocumentUrlRequest
DocumentUrlRequest.
Calling withDocumentId(long) is required before calling build().-
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds and returns the completeDocumentUrlRequestwithDocumentId(long)must have been already called.withAnnotationId(String annotationId) Optional: Specifies the initial annotation to navigate to in the document viewer, if applicable.withDocumentId(long documentId) Required: Sets the document ID.withPageNumber(int pageNumber) Conditional: Specifies the initial page shown in the document viewer, if applicable.withVersion(int majorVersion, int minorVersion) Sets the document version.withXCoordinate(BigDecimal xCoordinate) Optional: Specifies the initial X location on the page shown in the document viewer, if applicable.withYCoordinate(BigDecimal yCoordinate) Optional: Specifies the initial Y location on the page shown in the document viewer, if applicable.
-
Method Details
-
withDocumentId
Required: Sets the document ID.- Parameters:
documentId- The document ID.- Returns:
DocumentUrlRequest.Builderobject
-
withVersion
Sets the document version.- Parameters:
majorVersion- major version of the document. For example, if the document version is 3.2, the major version is3.minorVersion- minor version of the document. For example, if the document version is 3.1, the minor version is1.- Returns:
DocumentUrlRequest.Builderobject
-
withPageNumber
Conditional: Specifies the initial page shown in the document viewer, if applicable. Page numbers start at 1.This is a required field if
withXCoordinate(BigDecimal)orwithYCoordinate(BigDecimal)are set. Do not specify ifwithAnnotationId(String)is set to avoid conflicting locations. The document viewer's initial location will be the top of the document if this andwithAnnotationId(String)aren't specified.- Parameters:
pageNumber- initial page in the document viewer- Returns:
DocumentUrlRequest.Builderobject
-
withXCoordinate
Optional: Specifies the initial X location on the page shown in the document viewer, if applicable. This is measured in pixels from the bottom-left of the page at 72DPI.Do not specify if
withAnnotationId(String)is set to avoid conflicting locations. Defaults to the left-most edge of the page if not specified.- Parameters:
xCoordinate- initial X location in the document viewer- Returns:
DocumentUrlRequest.Builderobject
-
withYCoordinate
Optional: Specifies the initial Y location on the page shown in the document viewer, if applicable. This is measured in pixels from the bottom-left of the page at 72DPI.Do not specify if
withAnnotationId(String)is set to avoid conflicting locations. Defaults to the top-most edge of the page if not specified.- Parameters:
yCoordinate- initial Y location in the document viewer- Returns:
DocumentUrlRequest.Builderobject
-
withAnnotationId
Optional: Specifies the initial annotation to navigate to in the document viewer, if applicable. This annotation will be scrolled into view and appear as selected.Do not specify if
withPageNumber(int),withXCoordinate(BigDecimal), orwithYCoordinate(BigDecimal)are set in order to avoid conflicting locations. The document viewer's initial location will be the top of the document if this andwithPageNumber(int)aren't specified.- Parameters:
annotationId- The annotation ID.- Returns:
DocumentUrlRequest.Builderobject
-
build
DocumentUrlRequest build()Builds and returns the completeDocumentUrlRequestwithDocumentId(long)must have been already called.- Returns:
- The completed
DocumentUrlRequest
-