Constructs a PDFServices instance with the given Credentials and ClientConfig.
The parameters for constructing a PDFServices instance.
Optional clientClient configuration for PDFServices.
Credentials to be used for authentication. Cannot be undefined.
Private Readonly _executionDeletes asset from PDF Services storage.
A promise that resolves when the asset is deleted.
ServiceApiError Thrown if an error is encountered while getting the content.
SDKError Thrown for client-side or network errors.
ServiceUsageError Thrown if service usage limits have been reached or credentials quota has been exhausted.
Returns StreamAsset for the submitted Asset.
A Promise that resolves to a StreamAsset encapsulating the stream content along with the media type.
ServiceApiError Thrown if an error is encountered while getting the content.
SDKError Thrown for client-side or network errors.
ServiceUsageError Thrown if service usage limits have been reached or credentials quota has been exhausted.
Returns PDFServicesResponse for the submitted PDFServicesJob result.
Type of result in PDFServicesResponse. It will be an implementation of PDFServicesJobResult.
The parameters for getting the job result.
The URL to be polled to get the job result. Cannot be undefined.
result class for PDFServicesJob, it will be an implementation of PDFServicesJobResult. Cannot be undefined.
A Promise that resolves to a PDFServicesResponse encapsulating the result of the job.
ServiceApiError Thrown if an error is encountered while submitting the job.
SDKError Thrown for client-side or network errors.
ServiceUsageError Thrown if service usage limits have been reached or credentials quota has been exhausted.
Returns PDFServicesJobStatusResponse for the submitted PDFServicesJob.
The parameters for getting the job status.
URL to be polled to get the job status. Cannot be undefined.
A Promise that resolves to a PDFServicesJobStatusResponse encapsulating the job status and retry interval.
ServiceApiError Thrown if an error is encountered while getting the content.
SDKError Thrown for client-side or network errors.
ServiceUsageError Thrown if service usage limits have been reached or credentials quota has been exhausted.
Returns a new Asset with a new valid download URI.
A Promise that resolves to an Asset with new valid download URI.
ServiceApiError Thrown if an error is encountered while getting the content.
SDKError Thrown for client-side or network errors.
ServiceUsageError Thrown if service usage limits have been reached or credentials quota has been exhausted.
Submits the PDFServicesJob with the given NotifierConfig and returns the polling URL.
The parameters for the submission.
The PDFServicesJob to be submitted. Cannot be undefined.
Optional notifiers?: NotifierConfig[]List of NotifierConfig to be used for notification.
A Promise that resolves to a string representing polling URL that can be used to get the status and result of the job.
ServiceApiError Thrown if an error is encountered while submitting the job.
SDKError Thrown for client-side or network errors.
ServiceUsageError Thrown if service usage limits have been reached or credentials quota has been exhausted.
Upload content from read stream and returns an Asset to be used in PDF Services SDK.
Method will not close the read stream, responsibility of closing the read stream lies with the client.
The parameters for uploading an asset.
The mime type of the read stream. Cannot be undefined.
The read stream to be uploaded. Cannot be undefined.
A Promise that resolves to an Asset representing the uploaded content.
ServiceApiError Thrown if an error is encountered while submitting the job.
SDKError Thrown for client-side or network errors.
ServiceUsageError Thrown if service usage limits have been reached or credentials quota has been exhausted.
Uploads content from read streams and returns a list of Asset to be used in PDF Services SDK.
Method will not close the read stream, responsibility of closing the read stream lies with the client.
The parameters for uploading assets.
The list of object containing read stream and mime type. Cannot be undefined.
Generated using TypeDoc
This class is the entry point for all the PDF Service utilities. These utilities can be used to perform various functions such as submitting PDFServicesJob, getting status of a PDFServicesJob, getting result of a PDFServicesJob, uploading Asset, getting content of an Asset, deleting an Asset and refreshing an Asset.
Methods provided by the utility are: