Class PreviewAPI

Hierarchy

BaseResourceAPI<unknown>
- PreviewAPI

Index

Methods

Methods

documentAsImage

documentAsImage(id: CogniteInternalId, page: number): Promise<ArrayBuffer>

- Defined in packages/stable/src/api/documents/previewApi.ts:16
Parameters
- id: CogniteInternalId
- page: number
Returns Promise<ArrayBuffer>

documentAsPdf

documentAsPdf(id: CogniteInternalId): Promise<ArrayBuffer>

- Defined in packages/stable/src/api/documents/previewApi.ts:12
Parameters
- id: CogniteInternalId
Returns Promise<ArrayBuffer>

imageBuildPreviewURI

imageBuildPreviewURI(id: CogniteInternalId, page?: number): string

- Defined in packages/stable/src/api/documents/previewApi.ts:49
Parameters
- id: CogniteInternalId
- Default value page: number = 1
Returns string

pdfBuildPreviewURI

pdfBuildPreviewURI(id: CogniteInternalId): string

- Defined in packages/stable/src/api/documents/previewApi.ts:31
Parameters
- id: CogniteInternalId
Returns string

pdfBuildTemporaryLinkURI

pdfBuildTemporaryLinkURI(id: CogniteInternalId): string

- Defined in packages/stable/src/api/documents/previewApi.ts:68
Parameters
- id: CogniteInternalId
Returns string

pdfTemporaryLink

pdfTemporaryLink(id: CogniteInternalId): Promise<DocumentsPreviewTemporaryLinkResponse>

- Defined in packages/stable/src/api/documents/previewApi.ts:23
Parameters
- id: CogniteInternalId
Returns Promise<DocumentsPreviewTemporaryLinkResponse>