WoodWing Help Center

Elvis 6 action plug-ins - elvisContext functions

 

Elvis 6 action plug-ins - elvisContext functions

The elvisContext functions allow you to execute built in functionality of the Pro client. For example you can open a search tab, browse to a folder or activate a collection, etc.

These functions can be executed from inside a plug-in page by using elvisContext. All functions can be easily tested using the debug plug-in.

openSearch(q, sort)

Opens a search tab and searches on a specified query.

Parameters

q

The query to search for, see the query syntax guide for details.

 

Optional. Default is empty (search all).

sort

The sort order of results, detailed information is available in the REST - search article.

Optional. Default is the last used sort setting in the client.

openBrowse(folderPath, includeSubFolders, q, sort)

Opens a search tab, browsed to a specified folder.

Parameters

folderPath

The path to browse to.

Optional. Defaults to the root folder.

includeSubFolders

Whether to include results from subfolders (true | false).

Optional. Default is false.

q

The query to search for, see the query syntax guide for details.

Optional. Default is empty.

sort

The sort order of results, detailed information is available in the REST - search article.

Optional. Default is the last used sort setting in the client.

openAssets(assetIds)

Opens one or more assets in detail view.

Parameters

assetIds

A comma separated list of Elvis id's.

Required.

openContainers(containerIds, sort)

Opens one or more containers in detail view.

Parameters

containerIds

A comma separated list of Elvis id's.

Required.

sort

The sort order of the container children, detailed information is available in the REST - search article.

Optional. Default is the last used sort setting in the client.

activateContainers(containerIds)

Activate one or more containers (collections) in the client's collection panel.

Parameters

containerIds

A comma separated list of Elvis id's.

Required.

Was this article helpful?
0 out of 0 found this helpful / Created: / Updated:
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.