Template.getVisibleTemplateCategories (Method)

Returns zero or more structures, each containing information about an active template category, such as its name, description, etc.

Returns:

Categories_GetList_Result (query)

Each row of the returned query results has the following fields:

Field Name Type Description
Description PlainText The category's description.
ID CategoryID The category's ID.
isActive Boolean Boolean flag which when set to true indicates the category is active.
isDefault Boolean Boolean flag which when set to true indicates that this is the default category.
Name PlainText The category's name .
Type CategoryType String identifying a category's type; for example, 'Document', 'Element', 'Image', 'Task', and so on.

Arguments:

Name Type Required Description
searchString String Optional. Defaults to an empty string. The text sought by CommonSpot in the name or description fields.
searchOperator SearchOperator_EmptyString Optional. Defaults to an empty string. A search operator or an empty string. Examples are 'Begins With', 'Contains', 'Ends With', and 'Equals'.

Context:

License Requirements (none)
Permission Requirements ContributorOrServerCode
Deny Context None
Require Context (none)
Author Lock (not required)
Transaction Logging Transaction logging is disabled for this method
Customization Customization is not supported for this method.

Error Codes:

None

Notes:

None