Package com.pdfgate

Class FlattenPdfParams

java.lang.Object
com.pdfgate.FlattenPdfParams
public final class FlattenPdfParams extends Object
Parameters for flattening a PDF by document ID.

Flattening converts interactive fields/annotations into a static PDF. Provide documentId. Responses are JSON-only; use FlattenPdfParams.Builder.build() for a PdfGateDocument.

  • Method Details

    • builder

      public static FlattenPdfParams.Builder builder()
      Creates a new builder for flatten PDF parameters.
      Returns:
      the builder for flatten PDF parameters.

    • getDocumentId

      public String getDocumentId()
      Returns the document ID when flattening by document ID.
      Returns:
      the document ID when flattening by document ID.

    • getJsonResponse

      public Boolean getJsonResponse()
      Returns whether the response is JSON.
      Returns:
      whether the response is JSON.

    • isJsonResponse

      public boolean isJsonResponse()
      Returns whether the response is JSON.
      Returns:
      whether the response is JSON.

    • getPreSignedUrlExpiresIn

      public Long getPreSignedUrlExpiresIn()
      Returns the pre-signed URL expiration time in seconds.
      Returns:
      the pre-signed URL expiration time in seconds.

    • getMetadata

      public Object getMetadata()
      Returns metadata to attach to the document.
      Returns:
      metadata to attach to the document.