Home > @uniformdev/canvas > PreviewClient

PreviewClient class

API client to work with Uniform Project Preview entities

Signature:

Extends: ApiClient

Constructors

Constructor

Modifiers

Description

(constructor)(options)

Constructs a new instance of the PreviewClient class

Methods

Method

Modifiers

Description

deletePreviewUrl(body)

Deletes a preview URL

deletePreviewViewport(body)

Deletes a preview viewport

getPreviewUrl({ id }, input)

Fetches a preview URL by ID

getPreviewUrls(options)

Fetches all preview URLs for a project

getPreviewViewport({ id }, input)

Fetches a preview viewport by ID

getPreviewViewports(options)

Fetches all preview viewports for a project

upsertPreviewUrl(body)

Creates or updates a preview URL

upsertPreviewViewport(body)

Creates or updates a preview viewport