IWithLayoutStore
Defined layout related functions that a module working with IWithLayout objects must implement
Methods
Method | Returns | Notes |
---|---|---|
|
Promise<void> |
Destroy the resource backing a version |
|
Promise<string[]> |
Return a list of all the versions by name |
|
Promise<IHubLayout> |
Fetch the layout from a specific version. Used when editing a specific version. |
|
Promise<void> |
Store a version as a resource, with the given name |
|
Promise<void> |
Given a version name, copy that into the item's /data making it the "active version" |
destroyVersion
Parameters
Parameter | Type | Default | Notes |
---|---|---|---|
id Required | string | ||
name Required | string | ||
ro Required | IUserRequestOptions |
Returns
Promise<void>
loadVersion
Fetch the layout from a specific version. Used when editing a specific version.
Parameters
Returns
saveVersion
Store a version as a resource, with the given name
Parameters
Parameter | Type | Default | Notes |
---|---|---|---|
id Required | string | ||
name Required | string | ||
layout Required | IHubLayout | ||
ro Required | IUserRequestOptions |
Returns
Promise<void>
setActiveVersion
Given a version name, copy that into the item's /data making it the "active version"
Parameters
Returns
Promise<void>
Interface defined in common/src/core/traits/IWithLayout.ts:18
Destroy the resource backing a version