The ApiPinboard is part of the ApiService.
add
Executes the command with type com.censhare.api.dam.pinboard.Add
. This command adds assets to the pinboard.
Usage: add(assetRefs: string | string[])
Parameters:
assetRefs {string | string[]}
- the asset references to add
Returns: A promise with the method execution result.
downloadAll
Executes the command with type com.censhare.api.dam.pinboard.DownloadAll
. This command allows downloading all assets added to the pinboard.
Usage: downloadAll()
Parameters: none
Returns: The promise resolved with the url pointing to packaged assets.
groupAll
Executes the command with type com.censhare.api.dam.pinboard.GroupAll
. It groups all assets in the pinboard into a single asset group.
Usage: groupAll(data: literal type)
Parameters:
data {literal type}
- an object of the shape{ groupName: string, assignToUser?: boolean, clearPinBoard?: boolean}
Returns: The promise is resolved with the command result containing groupAssetRef
.
liveQuery
Executes a command with type com.censhare.api.dam.pinboard.Query
.
Usage: liveQuery(query: IQueryObject)
Parameters:
query {IQueryObject}
- the query to use
Returns: The command instance.
remove
Executes a command with type com.censhare.api.dam.pinboard.Remove
and it removes assets from the pinboard.
Usage: remove(ids: number[])
Parameters:
ids {number[]}
- asset IDs to be removed
Returns: A promise with the method execution result.
removeAll
Executes a command with type com.censhare.api.dam.pinboard.RemoveAll
and clears the pinboards.
Usage: removeAll()
Parameters: none
Returns: A promise with the method execution result.