Uniform Platform API

CanvasClient class

Signature:

Extends: ApiClient<CanvasClientOptions>

Constructor	Modifiers	Description
(constructor)(options)		Constructs a new instance of the <code>CanvasClient</code> class

Method	Modifiers	Description
getComponentDefinitions(options)		Fetches all Canvas component definitions
getCompositionById(options)		Fetches one composition by its ID
getCompositionById(options)
getCompositionById(options)
getCompositionByNodeId(options)		Fetches one composition by its project map node ID
getCompositionByNodeId(options)
getCompositionByNodeId(options)
getCompositionByNodePath(options)		Fetches one composition by its project map node path
getCompositionByNodePath(options)
getCompositionByNodePath(options)
getCompositionBySlug(options)		Fetches one composition by its slug
getCompositionBySlug(options)
getCompositionBySlug(options)
getCompositionDefaults(options)		Fetches a component definition's composition defaults
getCompositionDefaults(options)
getCompositionDefaults(options)
getCompositionHistory(options)		Fetches historical versions of a composition or pattern
getCompositionList(params)		Fetches lists of Canvas compositions, optionally by type
removeComponentDefinition(body)		Deletes a Canvas component definition
removeComposition(body)		Deletes a Canvas component definition
updateComponentDefinition(body)		Updates or creates a Canvas component definition
updateComposition(body)		Updates or creates a Canvas component definition