Home > @uniformdev/canvas > CanvasClient

CanvasClient class

Signature:

Extends: ApiClient<CanvasClientOptions>

Constructors

<table><thead><tr><th>

Constructor

</th><th>

Modifiers

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

(constructor)(options)

</td><td>

</td><td>

Constructs a new instance of the CanvasClient class

</td></tr> </tbody></table>

Methods

<table><thead><tr><th>

Method

</th><th>

Modifiers

</th><th>

Description

</th></tr></thead> <tbody><tr><td>

getComponentDefinitions(options)

</td><td>

</td><td>

Fetches all Canvas component definitions

</td></tr> <tr><td>

getCompositionById(options)

</td><td>

</td><td>

Fetches one composition by its ID

</td></tr> <tr><td>

getCompositionById(options)

</td><td>

</td><td>

</td></tr> <tr><td>

getCompositionById(options)

</td><td>

</td><td>

</td></tr> <tr><td>

getCompositionByNodeId(options)

</td><td>

</td><td>

Fetches one composition by its project map node ID

</td></tr> <tr><td>

getCompositionByNodeId(options)

</td><td>

</td><td>

</td></tr> <tr><td>

getCompositionByNodeId(options)

</td><td>

</td><td>

</td></tr> <tr><td>

getCompositionByNodePath(options)

</td><td>

</td><td>

Fetches one composition by its project map node path

</td></tr> <tr><td>

getCompositionByNodePath(options)

</td><td>

</td><td>

</td></tr> <tr><td>

getCompositionByNodePath(options)

</td><td>

</td><td>

</td></tr> <tr><td>

getCompositionBySlug(options)

</td><td>

</td><td>

Fetches one composition by its slug

</td></tr> <tr><td>

getCompositionBySlug(options)

</td><td>

</td><td>

</td></tr> <tr><td>

getCompositionBySlug(options)

</td><td>

</td><td>

</td></tr> <tr><td>

getCompositionDefaults(options)

</td><td>

</td><td>

Fetches a component definition's composition defaults

</td></tr> <tr><td>

getCompositionDefaults(options)

</td><td>

</td><td>

</td></tr> <tr><td>

getCompositionDefaults(options)

</td><td>

</td><td>

</td></tr> <tr><td>

getCompositionHistory(options)

</td><td>

</td><td>

Fetches historical versions of a composition or pattern

</td></tr> <tr><td>

getCompositionList(params)

</td><td>

</td><td>

Fetches lists of Canvas compositions, optionally by type

</td></tr> <tr><td>

removeComponentDefinition(body)

</td><td>

</td><td>

Deletes a Canvas component definition

</td></tr> <tr><td>

removeComposition(body)

</td><td>

</td><td>

Deletes a Canvas component definition

</td></tr> <tr><td>

updateComponentDefinition(body)

</td><td>

</td><td>

Updates or creates a Canvas component definition

</td></tr> <tr><td>

updateComposition(body)

</td><td>

</td><td>

Updates or creates a Canvas component definition

</td></tr> </tbody></table>