Index
All Classes and Interfaces|All Packages|Serialized Form
A
- A0 - Enum constant in enum class com.pdfgate.GeneratePdfParams.PageSizeType
-
A0 page size.
- A1 - Enum constant in enum class com.pdfgate.GeneratePdfParams.PageSizeType
-
A1 page size.
- A2 - Enum constant in enum class com.pdfgate.GeneratePdfParams.PageSizeType
-
A2 page size.
- A3 - Enum constant in enum class com.pdfgate.GeneratePdfParams.PageSizeType
-
A3 page size.
- A4 - Enum constant in enum class com.pdfgate.GeneratePdfParams.PageSizeType
-
A4 page size.
- A5 - Enum constant in enum class com.pdfgate.GeneratePdfParams.PageSizeType
-
A5 page size.
- A6 - Enum constant in enum class com.pdfgate.GeneratePdfParams.PageSizeType
-
A6 page size.
- AES128 - Enum constant in enum class com.pdfgate.ProtectPdfParams.EncryptionAlgorithm
-
AES-128 encryption.
- AES256 - Enum constant in enum class com.pdfgate.ProtectPdfParams.EncryptionAlgorithm
-
AES-256 encryption.
- algorithm(ProtectPdfParams.EncryptionAlgorithm) - Method in class com.pdfgate.ProtectPdfParams.Builder
-
Sets the encryption algorithm.
- authentication(GeneratePdfParams.GeneratePdfAuthentication) - Method in class com.pdfgate.GeneratePdfParams.Builder
-
Sets authentication credentials for protected web content.
B
- build() - Method in class com.pdfgate.CompressPdfParams.Builder
-
Builds compress PDF parameters for JSON responses.
- build() - Method in class com.pdfgate.CreateEnvelopeParams.Builder
-
Builds the create envelope parameters.
- build() - Method in class com.pdfgate.EnvelopeDocument.Builder
-
Builds the envelope document parameters.
- build() - Method in class com.pdfgate.EnvelopeRecipient.Builder
-
Builds the envelope recipient parameters.
- build() - Method in class com.pdfgate.ExtractPdfFormDataParams.Builder
-
Builds the extract PDF form data parameters.
- build() - Method in class com.pdfgate.FlattenPdfParams.Builder
-
Builds flatten PDF parameters for JSON responses.
- build() - Method in class com.pdfgate.GeneratePdfParams.Builder
-
Builds parameters that request a JSON document response.
- build() - Method in class com.pdfgate.GetDocumentParams.Builder
-
Builds the get document parameters.
- build() - Method in class com.pdfgate.GetEnvelopeParams.Builder
-
Builds the get envelope parameters.
- build() - Method in class com.pdfgate.GetFileParams.Builder
-
Builds the get file parameters.
- build() - Method in class com.pdfgate.ProtectPdfParams.Builder
-
Builds protect PDF parameters for JSON responses.
- build() - Method in class com.pdfgate.SendEnvelopeParams.Builder
-
Builds the send envelope parameters.
- build() - Method in class com.pdfgate.UploadFileParams.Builder
-
Builds upload file parameters.
- build() - Method in class com.pdfgate.WatermarkPdfParams.Builder
-
Builds watermark PDF parameters for JSON responses.
- builder() - Static method in class com.pdfgate.CompressPdfParams
-
Creates a new builder for compress PDF parameters.
- builder() - Static method in class com.pdfgate.CreateEnvelopeParams
-
Creates a new builder for create envelope parameters.
- builder() - Static method in class com.pdfgate.EnvelopeDocument
-
Creates a new builder for envelope document parameters.
- builder() - Static method in class com.pdfgate.EnvelopeRecipient
-
Creates a new builder for envelope recipient parameters.
- builder() - Static method in class com.pdfgate.ExtractPdfFormDataParams
-
Creates a new builder for extract PDF form data parameters.
- builder() - Static method in class com.pdfgate.FlattenPdfParams
-
Creates a new builder for flatten PDF parameters.
- builder() - Static method in class com.pdfgate.GeneratePdfParams
-
Creates a new builder for generate PDF parameters.
- builder() - Static method in class com.pdfgate.GetDocumentParams
-
Creates a new builder for get document parameters.
- builder() - Static method in class com.pdfgate.GetEnvelopeParams
-
Creates a new builder for get envelope parameters.
- builder() - Static method in class com.pdfgate.GetFileParams
-
Creates a new builder for get file parameters.
- builder() - Static method in class com.pdfgate.ProtectPdfParams
-
Creates a new builder for protect PDF parameters.
- builder() - Static method in class com.pdfgate.SendEnvelopeParams
-
Creates a new builder for send envelope parameters.
- builder() - Static method in class com.pdfgate.UploadFileParams
-
Creates a new builder for upload file parameters.
- builder() - Static method in class com.pdfgate.WatermarkPdfParams
-
Creates a new builder for watermark PDF parameters.
- Builder() - Constructor for class com.pdfgate.ExtractPdfFormDataParams.Builder
-
Creates a builder for extract PDF form data parameters.
- Builder() - Constructor for class com.pdfgate.GetDocumentParams.Builder
-
Creates a builder for get document parameters.
- Builder() - Constructor for class com.pdfgate.GetEnvelopeParams.Builder
-
Creates a builder for get envelope parameters.
- Builder() - Constructor for class com.pdfgate.GetFileParams.Builder
-
Creates a builder for get file parameters.
- Builder() - Constructor for class com.pdfgate.SendEnvelopeParams.Builder
-
Creates a builder for send envelope parameters.
C
- callback - Variable in class com.pdfgate.PdfGateResponseParserCallback
-
Callback invoked with parsed responses or errors.
- CallEnvelope - Interface in com.pdfgate
-
Marker type for calls that expect a
PDFGateEnveloperesponse. - CallFile - Interface in com.pdfgate
-
Marker interface for calls that return raw bytes.
- CallJson - Interface in com.pdfgate
-
Marker type for calls that expect a PdfGateDocument response.
- CallJsonObject - Interface in com.pdfgate
-
Marker type for calls that expect a JSON response payload as a generic JSON object.
- CHECKBOX - Enum constant in enum class com.pdfgate.DocumentFieldType
-
Checkbox field.
- clickSelector(String) - Method in class com.pdfgate.GeneratePdfParams.Builder
-
Sets a selector to click before rendering.
- ClickSelectorChain(List<String>) - Constructor for class com.pdfgate.GeneratePdfParams.ClickSelectorChain
-
Creates a selector chain.
- clickSelectorChainSetup(GeneratePdfParams.ClickSelectorChainSetup) - Method in class com.pdfgate.GeneratePdfParams.Builder
-
Sets the click selector chain setup.
- ClickSelectorChainSetup(Boolean, List<GeneratePdfParams.ClickSelectorChain>) - Constructor for class com.pdfgate.GeneratePdfParams.ClickSelectorChainSetup
-
Creates a click selector chain setup.
- com.pdfgate - package com.pdfgate
-
Java SDK for the PDFGate HTTP API.
- COMPLETED - Enum constant in enum class com.pdfgate.EnvelopeDocumentStatus
-
The document signing flow is complete.
- COMPLETED - Enum constant in enum class com.pdfgate.EnvelopeStatus
-
The envelope has been completed.
- COMPLETED - Enum constant in enum class com.pdfgate.PdfGateDocument.DocumentStatus
-
The document is finished and available.
- COMPRESSED - Enum constant in enum class com.pdfgate.PdfGateDocument.DocumentType
-
Document created by compression.
- compressPdf(CompressPdfParams) - Method in class com.pdfgate.PdfGate
-
Compresses a PDF and returns a JSON document response.
- compressPdfAsync(CompressPdfParams) - Method in class com.pdfgate.PdfGate
-
Compresses a PDF asynchronously and returns a JSON document response.
- compressPdfCall(CompressPdfParams) - Method in class com.pdfgate.PdfGate
-
Builds a call that expects a JSON document response.
- CompressPdfParams - Class in com.pdfgate
-
Parameters for compressing a PDF by document ID.
- CompressPdfParams.Builder - Class in com.pdfgate
-
Builder for
CompressPdfParams. - CREATED - Enum constant in enum class com.pdfgate.EnvelopeStatus
-
The envelope has been created.
- createEnvelope(CreateEnvelopeParams) - Method in class com.pdfgate.PdfGate
-
Creates an envelope and returns the envelope metadata response.
- createEnvelopeAsync(CreateEnvelopeParams) - Method in class com.pdfgate.PdfGate
-
Creates an envelope asynchronously and returns the envelope metadata response.
- createEnvelopeCall(CreateEnvelopeParams) - Method in class com.pdfgate.PdfGate
-
Builds a call that expects an envelope JSON response.
- CreateEnvelopeParams - Class in com.pdfgate
-
Parameters for creating a signing envelope.
- CreateEnvelopeParams.Builder - Class in com.pdfgate
-
Builder for
CreateEnvelopeParams. - css(String) - Method in class com.pdfgate.GeneratePdfParams.Builder
-
Sets additional CSS to apply during rendering.
D
- DATE - Enum constant in enum class com.pdfgate.DocumentFieldType
-
Date field.
- DATETIME - Enum constant in enum class com.pdfgate.DocumentFieldType
-
Date-time field.
- defaultConfig() - Static method in class com.pdfgate.PdfGateConfig
-
Returns the default configuration for production and sandbox domains.
- delay(Integer) - Method in class com.pdfgate.GeneratePdfParams.Builder
-
Sets the delay in milliseconds before rendering.
- disableCopy(Boolean) - Method in class com.pdfgate.ProtectPdfParams.Builder
-
Disables copying when set to true.
- disableEditing(Boolean) - Method in class com.pdfgate.ProtectPdfParams.Builder
-
Disables editing when set to true.
- disablePrint(Boolean) - Method in class com.pdfgate.ProtectPdfParams.Builder
-
Disables printing when set to true.
- DocumentFieldType - Enum Class in com.pdfgate
-
Envelope field type values returned by the API.
- documentId(String) - Method in class com.pdfgate.CompressPdfParams.Builder
-
Sets the document ID for the source PDF.
- documentId(String) - Method in class com.pdfgate.ExtractPdfFormDataParams.Builder
-
Sets the document ID for extraction.
- documentId(String) - Method in class com.pdfgate.FlattenPdfParams.Builder
-
Sets the document ID for the source PDF.
- documentId(String) - Method in class com.pdfgate.GetDocumentParams.Builder
-
Sets the document id to retrieve.
- documentId(String) - Method in class com.pdfgate.GetFileParams.Builder
-
Sets the document id to retrieve.
- documentId(String) - Method in class com.pdfgate.ProtectPdfParams.Builder
-
Sets the document id for the source PDF.
- documentId(String) - Method in class com.pdfgate.WatermarkPdfParams.Builder
-
Sets the document id for the source PDF.
- DocumentRecipientStatus - Enum Class in com.pdfgate
-
Recipient status values returned by the API.
- documents(List<EnvelopeDocument>) - Method in class com.pdfgate.CreateEnvelopeParams.Builder
-
Sets the envelope documents.
E
- email(String) - Method in class com.pdfgate.EnvelopeRecipient.Builder
-
Sets the recipient email address.
- emulateMediaType(GeneratePdfParams.EmulateMediaType) - Method in class com.pdfgate.GeneratePdfParams.Builder
-
Sets the CSS media type to emulate.
- enableFormFields(Boolean) - Method in class com.pdfgate.GeneratePdfParams.Builder
-
Sets whether to include interactive form fields in the output.
- ENCRYPTED - Enum constant in enum class com.pdfgate.PdfGateDocument.DocumentType
-
Document created by encryption.
- encryptMetadata(Boolean) - Method in class com.pdfgate.ProtectPdfParams.Builder
-
Encrypts metadata when set to true.
- enqueue(CallEnvelope, PdfGateCallback<PDFGateEnvelope>) - Method in class com.pdfgate.PdfGate
-
Enqueues a JSON response call and maps the response to
PDFGateEnvelope. - enqueue(CallFile, PdfGateCallback<byte[]>) - Method in class com.pdfgate.PdfGate
-
Enqueues a bytes response call and returns the raw response bytes.
- enqueue(CallJsonObject, PdfGateCallback<JsonObject>) - Method in class com.pdfgate.PdfGate
-
Enqueues a JSON response call and maps the response to
JsonObject. - enqueue(CallJson, PdfGateCallback<PdfGateDocument>) - Method in class com.pdfgate.PdfGate
-
Enqueues a JSON response call and maps the response to
PdfGateDocument. - EnvelopeDocument - Class in com.pdfgate
-
Document parameters for a create envelope request.
- EnvelopeDocument.Builder - Class in com.pdfgate
-
Builder for
EnvelopeDocument. - EnvelopeDocumentResponse - Class in com.pdfgate
-
Document metadata returned for an envelope.
- EnvelopeDocumentResponse() - Constructor for class com.pdfgate.EnvelopeDocumentResponse
-
Creates an empty envelope document response for JSON deserialization.
- EnvelopeDocumentStatus - Enum Class in com.pdfgate
-
Envelope document status values returned by the API.
- EnvelopeFieldResponse - Class in com.pdfgate
-
Field metadata returned for an envelope recipient.
- EnvelopeFieldResponse() - Constructor for class com.pdfgate.EnvelopeFieldResponse
-
Creates an empty field response for JSON deserialization.
- EnvelopeRecipient - Class in com.pdfgate
-
Recipient parameters for a document inside a create envelope request.
- EnvelopeRecipient.Builder - Class in com.pdfgate
-
Builder for
EnvelopeRecipient. - EnvelopeRecipientResponse - Class in com.pdfgate
-
Recipient metadata returned for a document inside an envelope.
- EnvelopeRecipientResponse() - Constructor for class com.pdfgate.EnvelopeRecipientResponse
-
Creates an empty recipient response for JSON deserialization.
- EnvelopeStatus - Enum Class in com.pdfgate
-
Envelope status values returned by the API.
- equals(Object) - Method in class com.pdfgate.EnvelopeDocumentResponse
- equals(Object) - Method in class com.pdfgate.EnvelopeFieldResponse
- equals(Object) - Method in class com.pdfgate.EnvelopeRecipientResponse
- equals(Object) - Method in class com.pdfgate.FileParam
- equals(Object) - Method in class com.pdfgate.PdfGateDocument
- equals(Object) - Method in class com.pdfgate.PDFGateEnvelope
- EXPIRED - Enum constant in enum class com.pdfgate.EnvelopeStatus
-
The envelope has expired.
- EXPIRED - Enum constant in enum class com.pdfgate.PdfGateDocument.DocumentStatus
-
The document has expired and is no longer available.
- extractPdfFormData(ExtractPdfFormDataParams) - Method in class com.pdfgate.PdfGate
-
Extracts PDF form field data and returns the JSON response.
- extractPdfFormDataAsync(ExtractPdfFormDataParams) - Method in class com.pdfgate.PdfGate
-
Extracts PDF form field data asynchronously and returns the JSON response.
- extractPdfFormDataCall(ExtractPdfFormDataParams) - Method in class com.pdfgate.PdfGate
-
Builds a call that expects a JSON response containing form field data.
- ExtractPdfFormDataParams - Class in com.pdfgate
-
Parameters for extracting PDF form data from an already uploaded document by ID.
- ExtractPdfFormDataParams.Builder - Class in com.pdfgate
-
Builder for
ExtractPdfFormDataParams.
F
- FAILED - Enum constant in enum class com.pdfgate.PdfGateDocument.DocumentStatus
-
The document failed to process.
- file(FileParam) - Method in class com.pdfgate.UploadFileParams.Builder
-
Sets the file to upload.
- FileParam - Class in com.pdfgate
-
Represents a binary file payload for multipart PDF uploads.
- FileParam(String, byte[]) - Constructor for class com.pdfgate.FileParam
-
Creates a file payload with the default content type.
- FileParam(String, byte[], String) - Constructor for class com.pdfgate.FileParam
-
Creates a file payload with an explicit content type.
- FLATTENED - Enum constant in enum class com.pdfgate.PdfGateDocument.DocumentType
-
Document created by flattening a PDF.
- flattenPdf(FlattenPdfParams) - Method in class com.pdfgate.PdfGate
-
Flattens a PDF and returns a JSON document response.
- flattenPdfAsync(FlattenPdfParams) - Method in class com.pdfgate.PdfGate
-
Flattens a PDF asynchronously and returns a JSON document response.
- flattenPdfCall(FlattenPdfParams) - Method in class com.pdfgate.PdfGate
-
Builds a call that expects a JSON document response.
- FlattenPdfParams - Class in com.pdfgate
-
Parameters for flattening a PDF by document ID.
- FlattenPdfParams.Builder - Class in com.pdfgate
-
Builder for
FlattenPdfParams. - font(String) - Method in class com.pdfgate.WatermarkPdfParams.Builder
-
Sets the text watermark font.
- fontColor(String) - Method in class com.pdfgate.WatermarkPdfParams.Builder
-
Sets the text watermark font color.
- fontSize(Integer) - Method in class com.pdfgate.WatermarkPdfParams.Builder
-
Sets the text watermark font size.
- footer(String) - Method in class com.pdfgate.GeneratePdfParams.Builder
-
Sets the footer HTML to apply on each page.
- FROM_HTML - Enum constant in enum class com.pdfgate.PdfGateDocument.DocumentType
-
Document generated from HTML or URL.
- fromException(IOException) - Static method in exception class com.pdfgate.PdfGateException
-
Creates a
PdfGateExceptionfrom an IO failure. - fromParseFailure(Response, String, Throwable) - Static method in exception class com.pdfgate.PdfGateException
-
Creates a
PdfGateExceptionfrom a successful response that could not be parsed. - fromResponse(Response) - Static method in exception class com.pdfgate.PdfGateException
-
Creates a
PdfGateExceptionfrom an HTTP response.
G
- generatePdf(GeneratePdfParams) - Method in class com.pdfgate.PdfGate
-
Generates a PDF from HTML or a URL and returns a JSON document response.
- generatePdfAsync(GeneratePdfParams) - Method in class com.pdfgate.PdfGate
-
Generates a PDF from HTML or a URL asynchronously and returns a JSON document response.
- GeneratePdfAuthentication(String, String) - Constructor for class com.pdfgate.GeneratePdfParams.GeneratePdfAuthentication
-
Creates authentication credentials for the render request.
- generatePdfCall(GeneratePdfParams) - Method in class com.pdfgate.PdfGate
-
Builds a call that expects a JSON document response.
- GeneratePdfParams - Class in com.pdfgate
-
Parameters for generating a PDF from raw HTML or a public URL.
- GeneratePdfParams.Builder - Class in com.pdfgate
-
Builder for
GeneratePdfParams. - GeneratePdfParams.ClickSelectorChain - Class in com.pdfgate
-
Sequence of selectors to click in order.
- GeneratePdfParams.ClickSelectorChainSetup - Class in com.pdfgate
-
Configuration for click selector chains.
- GeneratePdfParams.EmulateMediaType - Enum Class in com.pdfgate
-
Media types for CSS emulation during rendering.
- GeneratePdfParams.FileOrientation - Enum Class in com.pdfgate
-
Orientation options for generated PDFs.
- GeneratePdfParams.GeneratePdfAuthentication - Class in com.pdfgate
-
Authentication credentials for accessing protected web content.
- GeneratePdfParams.PageSizeType - Enum Class in com.pdfgate
-
Supported page sizes for generated PDFs.
- GeneratePdfParams.PdfPageMargin - Class in com.pdfgate
-
Margins to apply to a PDF page.
- GeneratePdfParams.Viewport - Class in com.pdfgate
-
Viewport dimensions for rendering.
- getAlgorithm() - Method in class com.pdfgate.ProtectPdfParams
-
Returns the encryption algorithm.
- getAuthentication() - Method in class com.pdfgate.GeneratePdfParams
-
Returns authentication credentials for protected content, if provided.
- getBottom() - Method in class com.pdfgate.GeneratePdfParams.PdfPageMargin
-
Returns the bottom margin value.
- getChains() - Method in class com.pdfgate.GeneratePdfParams.ClickSelectorChainSetup
-
Returns the chains to execute, if provided.
- getChecked() - Method in class com.pdfgate.EnvelopeFieldResponse
-
Returns whether the field is checked, if present.
- getClickSelector() - Method in class com.pdfgate.GeneratePdfParams
-
Returns the selector to click before rendering, if provided.
- getClickSelectorChainSetup() - Method in class com.pdfgate.GeneratePdfParams
-
Returns click chain setup used before rendering, if provided.
- getCompletedAt() - Method in class com.pdfgate.EnvelopeDocumentResponse
-
Returns when the document was completed, if present.
- getCompletedAt() - Method in class com.pdfgate.PDFGateEnvelope
-
Returns when the envelope was completed, if present.
- getCompressPdfTimeout() - Method in class com.pdfgate.PdfGateConfig
-
Returns the timeout used for compress PDF requests.
- getCreatedAt() - Method in class com.pdfgate.PdfGateDocument
-
Returns when the document was created.
- getCreatedAt() - Method in class com.pdfgate.PDFGateEnvelope
-
Returns when the envelope was created.
- getCss() - Method in class com.pdfgate.GeneratePdfParams
-
Returns additional CSS to apply during rendering, if provided.
- getData() - Method in class com.pdfgate.FileParam
-
Returns the file bytes.
- getDefaultTimeout() - Method in class com.pdfgate.PdfGateConfig
-
Returns the default timeout applied when no endpoint-specific timeout exists.
- getDelay() - Method in class com.pdfgate.GeneratePdfParams
-
Returns the delay in milliseconds before rendering, if provided.
- getDerivedFrom() - Method in class com.pdfgate.PdfGateDocument
-
Returns the source document ID when derived from another document.
- getDisableCopy() - Method in class com.pdfgate.ProtectPdfParams
-
Returns whether copying is disabled.
- getDisableEditing() - Method in class com.pdfgate.ProtectPdfParams
-
Returns whether editing is disabled.
- getDisablePrint() - Method in class com.pdfgate.ProtectPdfParams
-
Returns whether printing is disabled.
- getDocument(GetDocumentParams) - Method in class com.pdfgate.PdfGate
-
Retrieves document metadata (and optionally a fresh pre-signed URL).
- getDocumentAsync(GetDocumentParams) - Method in class com.pdfgate.PdfGate
-
Retrieves document metadata asynchronously.
- getDocumentCall(GetDocumentParams) - Method in class com.pdfgate.PdfGate
-
Builds a call that expects a JSON document response.
- getDocumentId() - Method in class com.pdfgate.CompressPdfParams
-
Returns the document ID when compressing by document ID.
- getDocumentId() - Method in class com.pdfgate.ExtractPdfFormDataParams
-
Returns the document ID if extracting by document ID.
- getDocumentId() - Method in class com.pdfgate.FlattenPdfParams
-
Returns the document ID when flattening by document ID.
- getDocumentId() - Method in class com.pdfgate.GetDocumentParams
-
Returns the document id to retrieve.
- getDocumentId() - Method in class com.pdfgate.GetFileParams
-
Returns the document id to retrieve.
- getDocumentId() - Method in class com.pdfgate.ProtectPdfParams
-
Returns the document id when protecting by document id.
- getDocumentId() - Method in class com.pdfgate.WatermarkPdfParams
-
Returns the document id when watermarking by document id.
- GetDocumentParams - Class in com.pdfgate
-
Parameters for retrieving a document's metadata.
- GetDocumentParams.Builder - Class in com.pdfgate
-
Builder for
GetDocumentParams. - getDocuments() - Method in class com.pdfgate.CreateEnvelopeParams
-
Returns the envelope documents.
- getDocuments() - Method in class com.pdfgate.PDFGateEnvelope
-
Returns the document entries included in the envelope.
- getEmail() - Method in class com.pdfgate.EnvelopeRecipient
-
Returns the recipient email address.
- getEmail() - Method in class com.pdfgate.EnvelopeRecipientResponse
-
Returns the recipient email address.
- getEmulateMediaType() - Method in class com.pdfgate.GeneratePdfParams
-
Returns the CSS media type to emulate during rendering, if provided.
- getEnableFormFields() - Method in class com.pdfgate.GeneratePdfParams
-
Returns whether interactive form fields should be enabled, if provided.
- getEncryptMetadata() - Method in class com.pdfgate.ProtectPdfParams
-
Returns whether metadata is encrypted.
- getEnvelope(GetEnvelopeParams) - Method in class com.pdfgate.PdfGate
-
Retrieves an envelope and returns the envelope metadata response.
- getEnvelopeAsync(GetEnvelopeParams) - Method in class com.pdfgate.PdfGate
-
Retrieves an envelope asynchronously and returns the envelope metadata response.
- getEnvelopeCall(GetEnvelopeParams) - Method in class com.pdfgate.PdfGate
-
Builds a call that expects an envelope JSON response.
- GetEnvelopeParams - Class in com.pdfgate
-
Parameters for retrieving an envelope by id.
- GetEnvelopeParams.Builder - Class in com.pdfgate
-
Builder for
GetEnvelopeParams. - getExpiredAt() - Method in class com.pdfgate.PDFGateEnvelope
-
Returns when the envelope expired, if present.
- getExpiresAt() - Method in class com.pdfgate.PdfGateDocument
-
Returns when the document expires, if present.
- getFields() - Method in class com.pdfgate.EnvelopeRecipientResponse
-
Returns the fields assigned to the recipient.
- getFile() - Method in class com.pdfgate.UploadFileParams
-
Returns the file payload to upload, if provided.
- getFile(GetFileParams) - Method in class com.pdfgate.PdfGate
-
Retrieves a stored document file.
- getFileAsync(GetFileParams) - Method in class com.pdfgate.PdfGate
-
Retrieves a stored document file asynchronously.
- getFileCall(GetFileParams) - Method in class com.pdfgate.PdfGate
-
Builds a call that expects a raw bytes response.
- GetFileParams - Class in com.pdfgate
-
Parameters for retrieving a document file.
- GetFileParams.Builder - Class in com.pdfgate
-
Builder for
GetFileParams. - getFileUrl() - Method in class com.pdfgate.PdfGateDocument
-
Returns a temporary file URL if provided by the API.
- getFlattenPdfTimeout() - Method in class com.pdfgate.PdfGateConfig
-
Returns the timeout used for flatten PDF requests.
- getFont() - Method in class com.pdfgate.WatermarkPdfParams
-
Returns the text font name.
- getFontColor() - Method in class com.pdfgate.WatermarkPdfParams
-
Returns the text font color.
- getFontSize() - Method in class com.pdfgate.WatermarkPdfParams
-
Returns the text font size.
- getFooter() - Method in class com.pdfgate.GeneratePdfParams
-
Returns the HTML footer applied to each page, if provided.
- getGeneratePdfTimeout() - Method in class com.pdfgate.PdfGateConfig
-
Returns the timeout used for generate PDF requests.
- getHeader() - Method in class com.pdfgate.GeneratePdfParams
-
Returns the HTML header applied to each page, if provided.
- getHeaders() - Method in exception class com.pdfgate.PdfGateException
-
Returns the HTTP response headers.
- getHeight() - Method in class com.pdfgate.GeneratePdfParams
-
Returns the custom page height in pixels, if provided.
- getHeight() - Method in class com.pdfgate.GeneratePdfParams.Viewport
-
Returns the viewport height in pixels.
- getHtml() - Method in class com.pdfgate.GeneratePdfParams
-
Returns the raw HTML content to render.
- getHttpHeaders() - Method in class com.pdfgate.GeneratePdfParams
-
Returns custom HTTP headers applied when loading the target URL, if provided.
- getId() - Method in class com.pdfgate.GetEnvelopeParams
-
Returns the envelope id to retrieve.
- getId() - Method in class com.pdfgate.PdfGateDocument
-
Returns the document identifier.
- getId() - Method in class com.pdfgate.PDFGateEnvelope
-
Returns the envelope identifier.
- getId() - Method in class com.pdfgate.SendEnvelopeParams
-
Returns the envelope id to send.
- getIgnoreFailingChains() - Method in class com.pdfgate.GeneratePdfParams.ClickSelectorChainSetup
-
Returns whether failing chains are ignored.
- getImageHeight() - Method in class com.pdfgate.WatermarkPdfParams
-
Returns the watermark image height.
- getImageWidth() - Method in class com.pdfgate.WatermarkPdfParams
-
Returns the watermark image width.
- getJavascript() - Method in class com.pdfgate.GeneratePdfParams
-
Returns JavaScript to run before rendering, if provided.
- getJsonResponse() - Method in class com.pdfgate.CompressPdfParams
-
Returns whether the response is JSON.
- getJsonResponse() - Method in class com.pdfgate.FlattenPdfParams
-
Returns whether the response is JSON.
- getJsonResponse() - Method in class com.pdfgate.GeneratePdfParams
-
Returns whether the API should return JSON instead of raw bytes.
- getJsonResponse() - Method in class com.pdfgate.ProtectPdfParams
-
Returns whether the response is JSON.
- getJsonResponse() - Method in class com.pdfgate.WatermarkPdfParams
-
Returns whether the response is JSON.
- getLeft() - Method in class com.pdfgate.GeneratePdfParams.PdfPageMargin
-
Returns the left margin value.
- getLinearize() - Method in class com.pdfgate.CompressPdfParams
-
Returns whether the PDF should be linearized.
- getLoadImages() - Method in class com.pdfgate.GeneratePdfParams
-
Returns whether images must load before rendering, if provided.
- getMargin() - Method in class com.pdfgate.GeneratePdfParams
-
Returns the page margins, if provided.
- getMetadata() - Method in class com.pdfgate.CompressPdfParams
-
Returns metadata to attach to the document.
- getMetadata() - Method in class com.pdfgate.CreateEnvelopeParams
-
Returns metadata attached to the envelope, if present.
- getMetadata() - Method in class com.pdfgate.FlattenPdfParams
-
Returns metadata to attach to the document.
- getMetadata() - Method in class com.pdfgate.GeneratePdfParams
-
Returns metadata to attach to the generated document, if provided.
- getMetadata() - Method in class com.pdfgate.PdfGateDocument
-
Returns metadata attached to the document, if present.
- getMetadata() - Method in class com.pdfgate.PDFGateEnvelope
-
Returns metadata attached to the envelope, if present.
- getMetadata() - Method in class com.pdfgate.ProtectPdfParams
-
Returns metadata to attach to the document.
- getMetadata() - Method in class com.pdfgate.UploadFileParams
-
Returns metadata to attach to the document.
- getMetadata() - Method in class com.pdfgate.WatermarkPdfParams
-
Returns metadata to attach to the document.
- getName() - Method in class com.pdfgate.EnvelopeDocument
-
Returns the document name inside the envelope.
- getName() - Method in class com.pdfgate.EnvelopeFieldResponse
-
Returns the field name.
- getName() - Method in class com.pdfgate.EnvelopeRecipient
-
Returns the recipient display name.
- getName() - Method in class com.pdfgate.FileParam
-
Returns the filename.
- getOpacity() - Method in class com.pdfgate.WatermarkPdfParams
-
Returns the watermark opacity.
- getOrientation() - Method in class com.pdfgate.GeneratePdfParams
-
Returns the page orientation, if provided.
- getOwnerPassword() - Method in class com.pdfgate.ProtectPdfParams
-
Returns the owner password, if provided.
- getPageRanges() - Method in class com.pdfgate.GeneratePdfParams
-
Returns the page ranges to include, if provided.
- getPageSizeType() - Method in class com.pdfgate.GeneratePdfParams
-
Returns the requested page size preset.
- getPassword() - Method in class com.pdfgate.GeneratePdfParams.GeneratePdfAuthentication
-
Returns the password.
- getPreSignedUrlExpiresIn() - Method in class com.pdfgate.CompressPdfParams
-
Returns the pre-signed URL expiration time in seconds.
- getPreSignedUrlExpiresIn() - Method in class com.pdfgate.FlattenPdfParams
-
Returns the pre-signed URL expiration time in seconds.
- getPreSignedUrlExpiresIn() - Method in class com.pdfgate.GeneratePdfParams
-
Returns the pre-signed URL expiration time in seconds, if provided.
- getPreSignedUrlExpiresIn() - Method in class com.pdfgate.GetDocumentParams
-
Returns the pre-signed URL expiry in seconds, if provided.
- getPreSignedUrlExpiresIn() - Method in class com.pdfgate.ProtectPdfParams
-
Returns the pre-signed URL expiration time in seconds.
- getPreSignedUrlExpiresIn() - Method in class com.pdfgate.UploadFileParams
-
Returns the pre-signed URL expiration time in seconds, if provided.
- getPreSignedUrlExpiresIn() - Method in class com.pdfgate.WatermarkPdfParams
-
Returns the pre-signed URL expiration time in seconds.
- getPrintBackground() - Method in class com.pdfgate.GeneratePdfParams
-
Returns whether to print background graphics, if provided.
- getProductionApiDomain() - Method in class com.pdfgate.PdfGateConfig
-
Returns the production API base URL.
- getProtectPdfTimeout() - Method in class com.pdfgate.PdfGateConfig
-
Returns the timeout used for protect PDF requests.
- getRecipients() - Method in class com.pdfgate.EnvelopeDocument
-
Returns the recipients for the document.
- getRecipients() - Method in class com.pdfgate.EnvelopeDocumentResponse
-
Returns the recipient responses for the document.
- getRequesterName() - Method in class com.pdfgate.CreateEnvelopeParams
-
Returns the requester name.
- getResponseBody() - Method in exception class com.pdfgate.PdfGateException
-
Returns the raw response body.
- getRight() - Method in class com.pdfgate.GeneratePdfParams.PdfPageMargin
-
Returns the right margin value.
- getRole() - Method in class com.pdfgate.EnvelopeRecipient
-
Returns the recipient role, if present.
- getRotate() - Method in class com.pdfgate.WatermarkPdfParams
-
Returns the watermark rotation in degrees.
- getSandboxApiDomain() - Method in class com.pdfgate.PdfGateConfig
-
Returns the sandbox API base URL.
- getScale() - Method in class com.pdfgate.GeneratePdfParams
-
Returns the scale factor applied during rendering, if provided.
- getSelectors() - Method in class com.pdfgate.GeneratePdfParams.ClickSelectorChain
-
Returns the selectors to click in order.
- getSignedAt() - Method in class com.pdfgate.EnvelopeRecipientResponse
-
Returns when the recipient signed, if present.
- getSignedDocumentId() - Method in class com.pdfgate.EnvelopeDocumentResponse
-
Returns the signed document ID, if present.
- getSize() - Method in class com.pdfgate.PdfGateDocument
-
Returns the file size in bytes, if provided.
- getSourceDocumentId() - Method in class com.pdfgate.EnvelopeDocument
-
Returns the source document ID.
- getSourceDocumentId() - Method in class com.pdfgate.EnvelopeDocumentResponse
-
Returns the source document ID.
- getStatus() - Method in class com.pdfgate.EnvelopeDocumentResponse
-
Returns the document status.
- getStatus() - Method in class com.pdfgate.EnvelopeRecipientResponse
-
Returns the recipient status.
- getStatus() - Method in class com.pdfgate.PdfGateDocument
-
Returns the document processing status.
- getStatus() - Method in class com.pdfgate.PDFGateEnvelope
-
Returns the envelope status.
- getStatusCode() - Method in exception class com.pdfgate.PdfGateException
-
Returns the HTTP status code or
-1when unavailable. - getText() - Method in class com.pdfgate.WatermarkPdfParams
-
Returns the watermark text.
- getTimeout() - Method in class com.pdfgate.GeneratePdfParams
-
Returns the timeout in milliseconds for the render, if provided.
- getTop() - Method in class com.pdfgate.GeneratePdfParams.PdfPageMargin
-
Returns the top margin value.
- getType() - Method in class com.pdfgate.EnvelopeFieldResponse
-
Returns the field type.
- getType() - Method in class com.pdfgate.FileParam
-
Returns the content type override, if provided.
- getType() - Method in class com.pdfgate.PdfGateDocument
-
Returns the document type.
- getType() - Method in class com.pdfgate.WatermarkPdfParams
-
Returns the watermark type.
- getUrl() - Method in class com.pdfgate.GeneratePdfParams
-
Returns the public URL to render.
- getUrl() - Method in class com.pdfgate.UploadFileParams
-
Returns the URL to upload, if provided.
- getUserAgent() - Method in class com.pdfgate.GeneratePdfParams
-
Returns the custom user agent string, if provided.
- getUsername() - Method in class com.pdfgate.GeneratePdfParams.GeneratePdfAuthentication
-
Returns the username.
- getUserPassword() - Method in class com.pdfgate.ProtectPdfParams
-
Returns the user password, if provided.
- getValue() - Method in class com.pdfgate.EnvelopeFieldResponse
-
Returns the field value, if present.
- getViewedAt() - Method in class com.pdfgate.EnvelopeRecipientResponse
-
Returns when the recipient viewed the document, if present.
- getViewport() - Method in class com.pdfgate.GeneratePdfParams
-
Returns the viewport size for rendering, if provided.
- getWaitForNetworkIdle() - Method in class com.pdfgate.GeneratePdfParams
-
Returns whether to wait for network idle before rendering, if provided.
- getWaitForSelector() - Method in class com.pdfgate.GeneratePdfParams
-
Returns the selector to wait for before rendering, if provided.
- getWatermark() - Method in class com.pdfgate.WatermarkPdfParams
-
Returns the watermark image payload when watermarking with an image.
- getWidth() - Method in class com.pdfgate.GeneratePdfParams
-
Returns the custom page width in pixels, if provided.
- getWidth() - Method in class com.pdfgate.GeneratePdfParams.Viewport
-
Returns the viewport width in pixels.
- getXPosition() - Method in class com.pdfgate.WatermarkPdfParams
-
Returns the watermark horizontal position.
- getYPosition() - Method in class com.pdfgate.WatermarkPdfParams
-
Returns the watermark vertical position.
H
- hashCode() - Method in class com.pdfgate.EnvelopeDocumentResponse
- hashCode() - Method in class com.pdfgate.EnvelopeFieldResponse
- hashCode() - Method in class com.pdfgate.EnvelopeRecipientResponse
- hashCode() - Method in class com.pdfgate.FileParam
- hashCode() - Method in class com.pdfgate.PdfGateDocument
- hashCode() - Method in class com.pdfgate.PDFGateEnvelope
- header(String) - Method in class com.pdfgate.GeneratePdfParams.Builder
-
Sets the header HTML to apply on each page.
- height(Integer) - Method in class com.pdfgate.GeneratePdfParams.Builder
-
Sets the custom page height in pixels.
- html(String) - Method in class com.pdfgate.GeneratePdfParams.Builder
-
Sets raw HTML content to render.
- httpHeaders(Map<String, String>) - Method in class com.pdfgate.GeneratePdfParams.Builder
-
Sets custom HTTP headers used when loading the target URL.
I
- id(String) - Method in class com.pdfgate.GetEnvelopeParams.Builder
-
Sets the envelope id to retrieve.
- id(String) - Method in class com.pdfgate.SendEnvelopeParams.Builder
-
Sets the envelope id to send.
- IMAGE - Enum constant in enum class com.pdfgate.WatermarkPdfParams.WatermarkType
-
Image watermark.
- imageHeight(Integer) - Method in class com.pdfgate.WatermarkPdfParams.Builder
-
Sets the watermark image height.
- imageWidth(Integer) - Method in class com.pdfgate.WatermarkPdfParams.Builder
-
Sets the watermark image width.
- IN_PROGRESS - Enum constant in enum class com.pdfgate.EnvelopeStatus
-
The envelope is currently being processed.
- isJsonResponse() - Method in class com.pdfgate.CompressPdfParams
-
Returns whether the response is JSON.
- isJsonResponse() - Method in class com.pdfgate.FlattenPdfParams
-
Returns whether the response is JSON.
- isJsonResponse() - Method in class com.pdfgate.GeneratePdfParams
-
Returns whether the API should return JSON instead of raw bytes.
- isJsonResponse() - Method in class com.pdfgate.ProtectPdfParams
-
Returns whether the response is JSON.
- isJsonResponse() - Method in class com.pdfgate.WatermarkPdfParams
-
Returns whether the response is JSON.
J
- javascript(String) - Method in class com.pdfgate.GeneratePdfParams.Builder
-
Sets JavaScript to run before rendering.
L
- LANDSCAPE - Enum constant in enum class com.pdfgate.GeneratePdfParams.FileOrientation
-
Landscape orientation.
- LEDGER - Enum constant in enum class com.pdfgate.GeneratePdfParams.PageSizeType
-
Ledger page size.
- LEGAL - Enum constant in enum class com.pdfgate.GeneratePdfParams.PageSizeType
-
Legal page size.
- LETTER - Enum constant in enum class com.pdfgate.GeneratePdfParams.PageSizeType
-
Letter page size.
- linearize(Boolean) - Method in class com.pdfgate.CompressPdfParams.Builder
-
Enables linearized PDF output when set to true.
- loadImages(Boolean) - Method in class com.pdfgate.GeneratePdfParams.Builder
-
Sets whether to wait for all images to load before rendering.
M
- margin(GeneratePdfParams.PdfPageMargin) - Method in class com.pdfgate.GeneratePdfParams.Builder
-
Sets the page margins.
- metadata(Object) - Method in class com.pdfgate.CompressPdfParams.Builder
-
Sets metadata to attach to the document.
- metadata(Object) - Method in class com.pdfgate.CreateEnvelopeParams.Builder
-
Sets metadata attached to the envelope.
- metadata(Object) - Method in class com.pdfgate.FlattenPdfParams.Builder
-
Sets metadata to attach to the document.
- metadata(Object) - Method in class com.pdfgate.GeneratePdfParams.Builder
-
Sets metadata to attach to the generated document.
- metadata(Object) - Method in class com.pdfgate.ProtectPdfParams.Builder
-
Sets metadata to attach to the document.
- metadata(Object) - Method in class com.pdfgate.UploadFileParams.Builder
-
Sets metadata to attach to the document.
- metadata(Object) - Method in class com.pdfgate.WatermarkPdfParams.Builder
-
Sets metadata to attach to the document.
N
- name(String) - Method in class com.pdfgate.EnvelopeDocument.Builder
-
Sets the display name inside the envelope.
- name(String) - Method in class com.pdfgate.EnvelopeRecipient.Builder
-
Sets the recipient display name.
- NUMBER - Enum constant in enum class com.pdfgate.DocumentFieldType
-
Numeric field.
O
- of(String, String, Duration, Duration) - Static method in class com.pdfgate.PdfGateConfig
-
Creates a configuration with custom domains and default timeout.
- of(String, String, Duration, Duration, Duration) - Static method in class com.pdfgate.PdfGateConfig
-
Creates a configuration with custom domains and flatten timeout.
- of(String, String, Duration, Duration, Duration, Duration) - Static method in class com.pdfgate.PdfGateConfig
-
Creates a configuration with custom domains and protect timeout.
- of(String, String, Duration, Duration, Duration, Duration, Duration) - Static method in class com.pdfgate.PdfGateConfig
-
Creates a configuration with custom domains and per-endpoint timeouts.
- onFailure(Call, IOException) - Method in class com.pdfgate.PdfGateResponseParserCallback
- onFailure(Call, Throwable) - Method in interface com.pdfgate.PdfGateCallback
-
Called when the request fails or parsing throws an exception.
- onResponse(Call, Response) - Method in class com.pdfgate.PdfGateResponseParserCallback
- onSuccess(Call, T) - Method in interface com.pdfgate.PdfGateCallback
-
Called when the request completes successfully.
- opacity(Double) - Method in class com.pdfgate.WatermarkPdfParams.Builder
-
Sets the watermark opacity.
- orientation(GeneratePdfParams.FileOrientation) - Method in class com.pdfgate.GeneratePdfParams.Builder
-
Sets the page orientation.
- ownerPassword(String) - Method in class com.pdfgate.ProtectPdfParams.Builder
-
Sets the owner password with full control.
P
- pageRanges(String) - Method in class com.pdfgate.GeneratePdfParams.Builder
-
Sets the page ranges to include (for example, "1-5" or "1,3,5").
- pageSizeType(GeneratePdfParams.PageSizeType) - Method in class com.pdfgate.GeneratePdfParams.Builder
-
Sets the page size preset.
- parseResponse(Response) - Method in class com.pdfgate.PdfGateEnvelopeResponseParserCallback
- parseResponse(Response) - Method in class com.pdfgate.PdfGateFileResponseParserCallback
- parseResponse(Response) - Method in class com.pdfgate.PdfGateJsonObjectResponseParserCallback
- parseResponse(Response) - Method in class com.pdfgate.PdfGateJsonResponseParserCallback
- parseResponse(Response) - Method in class com.pdfgate.PdfGateResponseParserCallback
-
Parses the HTTP response into the expected payload type.
- PdfGate - Class in com.pdfgate
-
Client for the PDFGate HTTP API.
- PdfGate(String) - Constructor for class com.pdfgate.PdfGate
-
Creates a client with the default configuration.
- PdfGate(String, PdfGateConfig) - Constructor for class com.pdfgate.PdfGate
-
Creates a client with a custom configuration.
- PdfGateCallback<T> - Interface in com.pdfgate
-
Callback for asynchronous PDFGate requests.
- PdfGateConfig - Class in com.pdfgate
-
Configuration for the PDFGate client.
- PdfGateDocument - Class in com.pdfgate
-
Document metadata returned by JSON responses from the PDFGate API.
- PdfGateDocument() - Constructor for class com.pdfgate.PdfGateDocument
-
Creates an empty document instance for JSON deserialization.
- PdfGateDocument.DocumentStatus - Enum Class in com.pdfgate
-
Status values returned by the API for document processing.
- PdfGateDocument.DocumentType - Enum Class in com.pdfgate
-
Document type values returned by the API.
- PDFGateEnvelope - Class in com.pdfgate
-
Envelope metadata returned by JSON responses from the PDFGate API.
- PDFGateEnvelope() - Constructor for class com.pdfgate.PDFGateEnvelope
-
Creates an empty envelope instance for JSON deserialization.
- PdfGateEnvelopeResponseParserCallback - Class in com.pdfgate
-
Parses JSON responses into
PDFGateEnvelopeinstances. - PdfGateEnvelopeResponseParserCallback(PdfGateCallback<PDFGateEnvelope>) - Constructor for class com.pdfgate.PdfGateEnvelopeResponseParserCallback
-
Creates a response parser callback for envelope payloads.
- PdfGateException - Exception Class in com.pdfgate
-
Exception raised for PDFGate API errors and transport failures.
- PdfGateException(String, int, String, Headers) - Constructor for exception class com.pdfgate.PdfGateException
-
Creates a new exception with the provided response details.
- PdfGateFileResponseParserCallback - Class in com.pdfgate
-
Parses file responses into raw bytes.
- PdfGateFileResponseParserCallback(PdfGateCallback<byte[]>) - Constructor for class com.pdfgate.PdfGateFileResponseParserCallback
-
Creates a callback for file responses.
- PdfGateJsonObjectResponseParserCallback - Class in com.pdfgate
-
Parses JSON responses into
JsonObjectinstances. - PdfGateJsonObjectResponseParserCallback(PdfGateCallback<JsonObject>) - Constructor for class com.pdfgate.PdfGateJsonObjectResponseParserCallback
-
Creates a response parser callback for JSON object payloads.
- PdfGateJsonResponseParserCallback - Class in com.pdfgate
-
Parses JSON responses into
PdfGateDocumentinstances. - PdfGateJsonResponseParserCallback(PdfGateCallback<PdfGateDocument>) - Constructor for class com.pdfgate.PdfGateJsonResponseParserCallback
-
Creates a response parser callback for JSON document payloads.
- PdfGateResponseParserCallback<T> - Class in com.pdfgate
-
Base callback that parses HTTP responses and dispatches results to a
PdfGateCallback. - PdfGateResponseParserCallback() - Constructor for class com.pdfgate.PdfGateResponseParserCallback
-
Creates a response parser callback.
- PdfGateWebhooks - Class in com.pdfgate
-
Helpers for verifying PDFGate webhook requests.
- PdfGateWebhookVerificationException - Exception Class in com.pdfgate
-
Exception thrown when a webhook signature cannot be verified.
- PdfGateWebhookVerificationException(String) - Constructor for exception class com.pdfgate.PdfGateWebhookVerificationException
-
Creates a verification exception with the provided message.
- PdfGateWebhookVerificationException(String, Throwable) - Constructor for exception class com.pdfgate.PdfGateWebhookVerificationException
-
Creates a verification exception with the provided message and cause.
- PdfPageMargin(String, String, String, String) - Constructor for class com.pdfgate.GeneratePdfParams.PdfPageMargin
-
Creates a margin set for a rendered PDF.
- PENDING - Enum constant in enum class com.pdfgate.DocumentRecipientStatus
-
The recipient has not yet signed.
- PENDING - Enum constant in enum class com.pdfgate.EnvelopeDocumentStatus
-
The document is pending.
- PORTRAIT - Enum constant in enum class com.pdfgate.GeneratePdfParams.FileOrientation
-
Portrait orientation.
- preSignedUrlExpiresIn(Long) - Method in class com.pdfgate.CompressPdfParams.Builder
-
Sets the pre-signed URL expiration time in seconds.
- preSignedUrlExpiresIn(Long) - Method in class com.pdfgate.FlattenPdfParams.Builder
-
Sets the pre-signed URL expiration time in seconds.
- preSignedUrlExpiresIn(Long) - Method in class com.pdfgate.GeneratePdfParams.Builder
-
Sets the pre-signed URL expiration time in seconds.
- preSignedUrlExpiresIn(Long) - Method in class com.pdfgate.GetDocumentParams.Builder
-
Sets the pre-signed URL expiry in seconds.
- preSignedUrlExpiresIn(Long) - Method in class com.pdfgate.ProtectPdfParams.Builder
-
Sets the pre-signed URL expiration time in seconds.
- preSignedUrlExpiresIn(Long) - Method in class com.pdfgate.UploadFileParams.Builder
-
Sets the pre-signed URL expiration time in seconds.
- preSignedUrlExpiresIn(Long) - Method in class com.pdfgate.WatermarkPdfParams.Builder
-
Sets the pre-signed URL expiration time in seconds.
- PRINT - Enum constant in enum class com.pdfgate.GeneratePdfParams.EmulateMediaType
-
Print media type.
- printBackground(Boolean) - Method in class com.pdfgate.GeneratePdfParams.Builder
-
Sets whether to print background graphics.
- PROCESSING - Enum constant in enum class com.pdfgate.PdfGateDocument.DocumentStatus
-
The document is still processing.
- protectPdf(ProtectPdfParams) - Method in class com.pdfgate.PdfGate
-
Protects a PDF and returns a JSON document response.
- protectPdfAsync(ProtectPdfParams) - Method in class com.pdfgate.PdfGate
-
Protects a PDF asynchronously and returns a JSON document response.
- protectPdfCall(ProtectPdfParams) - Method in class com.pdfgate.PdfGate
-
Builds a call that expects a JSON document response.
- ProtectPdfParams - Class in com.pdfgate
-
Parameters for protecting a PDF by document ID.
- ProtectPdfParams.Builder - Class in com.pdfgate
-
Builder for
ProtectPdfParams. - ProtectPdfParams.EncryptionAlgorithm - Enum Class in com.pdfgate
-
Supported encryption algorithms.
R
- RADIO_BUTTON - Enum constant in enum class com.pdfgate.DocumentFieldType
-
Radio button field.
- recipients(List<EnvelopeRecipient>) - Method in class com.pdfgate.EnvelopeDocument.Builder
-
Sets the recipients for the document.
- requesterName(String) - Method in class com.pdfgate.CreateEnvelopeParams.Builder
-
Sets the requester name.
- role(String) - Method in class com.pdfgate.EnvelopeRecipient.Builder
-
Sets the recipient role.
- rotate(Double) - Method in class com.pdfgate.WatermarkPdfParams.Builder
-
Sets the watermark rotation in degrees.
S
- scale(Double) - Method in class com.pdfgate.GeneratePdfParams.Builder
-
Sets the scale factor applied during rendering.
- SCREEN - Enum constant in enum class com.pdfgate.GeneratePdfParams.EmulateMediaType
-
Screen media type.
- SELECT - Enum constant in enum class com.pdfgate.DocumentFieldType
-
Select field.
- sendEnvelope(SendEnvelopeParams) - Method in class com.pdfgate.PdfGate
-
Sends an envelope and returns the updated envelope metadata response.
- sendEnvelopeAsync(SendEnvelopeParams) - Method in class com.pdfgate.PdfGate
-
Sends an envelope asynchronously and returns the updated envelope metadata response.
- sendEnvelopeCall(SendEnvelopeParams) - Method in class com.pdfgate.PdfGate
-
Builds a call that expects an envelope JSON response.
- SendEnvelopeParams - Class in com.pdfgate
-
Parameters for sending an envelope to its recipients.
- SendEnvelopeParams.Builder - Class in com.pdfgate
-
Builder for
SendEnvelopeParams. - SENT_FOR_SIGNING - Enum constant in enum class com.pdfgate.EnvelopeDocumentStatus
-
The document has been sent for signing.
- SIGNATURE - Enum constant in enum class com.pdfgate.DocumentFieldType
-
Signature field.
- SIGNED - Enum constant in enum class com.pdfgate.DocumentRecipientStatus
-
The recipient has signed.
- SIGNED - Enum constant in enum class com.pdfgate.PdfGateDocument.DocumentType
-
Document created by signing.
- SIGNING_FAILED - Enum constant in enum class com.pdfgate.EnvelopeDocumentStatus
-
Signing failed for the document.
- SIGNING_IN_PROGRESS - Enum constant in enum class com.pdfgate.EnvelopeDocumentStatus
-
The document is currently being signed.
- sourceDocumentId(String) - Method in class com.pdfgate.EnvelopeDocument.Builder
-
Sets the source document ID.
T
- TABLOID - Enum constant in enum class com.pdfgate.GeneratePdfParams.PageSizeType
-
Tabloid page size.
- text(String) - Method in class com.pdfgate.WatermarkPdfParams.Builder
-
Sets the watermark text.
- TEXT - Enum constant in enum class com.pdfgate.DocumentFieldType
-
Single-line text field.
- TEXT - Enum constant in enum class com.pdfgate.WatermarkPdfParams.WatermarkType
-
Text watermark.
- TEXT_AREA - Enum constant in enum class com.pdfgate.DocumentFieldType
-
Multi-line text field.
- TIME - Enum constant in enum class com.pdfgate.DocumentFieldType
-
Time field.
- timeout(Integer) - Method in class com.pdfgate.GeneratePdfParams.Builder
-
Sets the render timeout in milliseconds.
- toString() - Method in enum class com.pdfgate.ProtectPdfParams.EncryptionAlgorithm
- toString() - Method in enum class com.pdfgate.WatermarkPdfParams.WatermarkType
- type(WatermarkPdfParams.WatermarkType) - Method in class com.pdfgate.WatermarkPdfParams.Builder
-
Sets the watermark type.
U
- uploadFile(UploadFileParams) - Method in class com.pdfgate.PdfGate
-
Uploads a PDF file passing the file or through a URL pointing to the file and returns a JSON document response.
- uploadFileAsync(UploadFileParams) - Method in class com.pdfgate.PdfGate
-
Uploads a PDF file passing the file or through a URL pointing to the file and returns a JSON document response.
- uploadFileCall(UploadFileParams) - Method in class com.pdfgate.PdfGate
-
Builds a call that expects a JSON document response.
- UploadFileParams - Class in com.pdfgate
-
Parameters for uploading a raw PDF file or URL to PDFGate.
- UploadFileParams.Builder - Class in com.pdfgate
-
Builder for
UploadFileParams. - url(String) - Method in class com.pdfgate.GeneratePdfParams.Builder
-
Sets the public URL to render.
- url(String) - Method in class com.pdfgate.UploadFileParams.Builder
-
Sets the URL of the file to upload.
- userAgent(String) - Method in class com.pdfgate.GeneratePdfParams.Builder
-
Sets a custom user agent string.
- userPassword(String) - Method in class com.pdfgate.ProtectPdfParams.Builder
-
Sets the user password required to open the PDF.
V
- valueOf(String) - Static method in enum class com.pdfgate.DocumentFieldType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pdfgate.DocumentRecipientStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pdfgate.EnvelopeDocumentStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pdfgate.EnvelopeStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pdfgate.GeneratePdfParams.EmulateMediaType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pdfgate.GeneratePdfParams.FileOrientation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pdfgate.GeneratePdfParams.PageSizeType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pdfgate.PdfGateDocument.DocumentStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pdfgate.PdfGateDocument.DocumentType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pdfgate.ProtectPdfParams.EncryptionAlgorithm
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.pdfgate.WatermarkPdfParams.WatermarkType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.pdfgate.DocumentFieldType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pdfgate.DocumentRecipientStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pdfgate.EnvelopeDocumentStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pdfgate.EnvelopeStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pdfgate.GeneratePdfParams.EmulateMediaType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pdfgate.GeneratePdfParams.FileOrientation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pdfgate.GeneratePdfParams.PageSizeType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pdfgate.PdfGateDocument.DocumentStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pdfgate.PdfGateDocument.DocumentType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pdfgate.ProtectPdfParams.EncryptionAlgorithm
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.pdfgate.WatermarkPdfParams.WatermarkType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- verifySignature(String, String, byte[]) - Static method in class com.pdfgate.PdfGateWebhooks
-
Verifies a webhook signature header against the raw request body.
- verifySignature(String, String, String) - Static method in class com.pdfgate.PdfGateWebhooks
-
Verifies a webhook signature header against the raw request body.
- viewport(GeneratePdfParams.Viewport) - Method in class com.pdfgate.GeneratePdfParams.Builder
-
Sets the viewport dimensions for rendering.
- Viewport(Integer, Integer) - Constructor for class com.pdfgate.GeneratePdfParams.Viewport
-
Creates a viewport definition for rendering.
W
- waitForNetworkIdle(Boolean) - Method in class com.pdfgate.GeneratePdfParams.Builder
-
Sets whether to wait for network idle before rendering.
- waitForSelector(String) - Method in class com.pdfgate.GeneratePdfParams.Builder
-
Sets a selector to wait for before rendering.
- watermark(FileParam) - Method in class com.pdfgate.WatermarkPdfParams.Builder
-
Sets the watermark image file.
- WATERMARKED - Enum constant in enum class com.pdfgate.PdfGateDocument.DocumentType
-
Document created by applying a watermark.
- watermarkPdf(WatermarkPdfParams) - Method in class com.pdfgate.PdfGate
-
Applies a watermark to a PDF and returns a JSON document response.
- watermarkPdfAsync(WatermarkPdfParams) - Method in class com.pdfgate.PdfGate
-
Applies a watermark to a PDF asynchronously and returns a JSON document response.
- watermarkPdfCall(WatermarkPdfParams) - Method in class com.pdfgate.PdfGate
-
Builds a call that expects a JSON document response.
- WatermarkPdfParams - Class in com.pdfgate
-
Parameters for watermarking a PDF by document ID.
- WatermarkPdfParams.Builder - Class in com.pdfgate
-
Builder for
WatermarkPdfParams. - WatermarkPdfParams.WatermarkType - Enum Class in com.pdfgate
-
Watermark type supported by the API.
- width(Integer) - Method in class com.pdfgate.GeneratePdfParams.Builder
-
Sets the custom page width in pixels.
X
- xPosition(Integer) - Method in class com.pdfgate.WatermarkPdfParams.Builder
-
Sets the watermark horizontal position.
Y
- yPosition(Integer) - Method in class com.pdfgate.WatermarkPdfParams.Builder
-
Sets the watermark vertical position.
All Classes and Interfaces|All Packages|Serialized Form