Skip to main content

GetTemplates

Gets the templates. Note: In the template object the icon and additional classes property are passed as null / empty value for now. This will be handled in future.

Syntax

// Assumes shellUI has been initialized with IShellUI instance
const results = await shellUI.Vault.ObjectOperations.GetTemplates({
object_type_id: 0,
class_id: 0,
search_keywords: [] /* Array of string */,
});

Message

NameDescriptionType
object_type_idThe object type of the templates.number
class_idOptional class ID for fetching the templates of a specific class.number
search_keywordsThe search keywords for the templates.string[]

Return type

NameDescriptionType
templatesTemplates.Template[]

Example

{
"templates": [] /* Array of Template */
}