Class PDFServicesResponse<T>

Response object for PDFServicesJob.

Type Parameters

T
Type of result in PDFServicesResponse. It will be an implementation of PDFServicesJobResult.

Hierarchy (view full)

PDFServicesJobStatusResponse
- PDFServicesResponse

Index

Constructors

Properties

Accessors

result retryInterval status

Constructors

constructor

new PDFServicesResponse<T>(status, headers, result): PDFServicesResponse<T>
Constructs PDFServicesJob response with its status, headers and result.
Type Parameters
- T
  Type of result in PDFServicesResponse. It will be an implementation of PDFServicesJobResult.
Parameters
- status: string
  Status of the PDFServicesJob.
- headers: {
  [key: string]: string;
  }
  Headers of the PDFServicesResponse.
  - [key: string]: string
- result: null | T
  result for the PDFServicesJob, it will be an extension of PDFServicesJobResult.
Returns PDFServicesResponse<T>
Overrides PDFServicesJobStatusResponse.constructor
- Defined in src/PDFServicesResponse.ts:32

Properties

`Private` `Readonly` _result

_result: null | T

Accessors

result

get result(): null | T
Returns instance of result of PDFServicesJob.

Returns null | T
result of PDFServicesJob
- Defined in src/PDFServicesResponse.ts:42

retryInterval

get retryInterval(): number
Returns retry interval for status polling of the PDFServicesJob in seconds.

Returns number
retry interval for status polling of the PDFServicesJob in seconds
Inherited from PDFServicesJobStatusResponse.retryInterval
- Defined in src/PDFServicesJobStatusResponse.ts:46

status

get status(): string
Returns string representation of PDFServicesJobStatus for the PDFServicesJob.

Returns string
string representation of PDFServicesJobStatus for the PDFServicesJob
Inherited from PDFServicesJobStatusResponse.status
- Defined in src/PDFServicesJobStatusResponse.ts:37

Generated using TypeDoc