Enables scripted content fragments to get tags.
Methods
Add
Add a tag or tags to a piece of content.
Usage
#set($additionalInfoResponse = $core_v2_tags.Add($contentUrl, $oauthClientId, $tags))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentUrl | string | Content Url | Required | ||
oauthClientId | Guid | Oauth Client Id | Required | ||
tags | string | Comma-separated list of tags | Required |
Return Type
Add
Creates a seed tag.
Usage
#set($additionalInfoResponse = $core_v2_tags.Add($tag, "%{ApplicationId = $applicationIdArg, ApplicationTypeId = $applicationTypeIdArg, TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
tag | string | Tag | Required | ||
ApplicationId | Guid | A content application identifier to filter by | Optional | ||
ApplicationTypeId | Guid | A content application type identifier to filter by | Optional | ||
TypeId | Guid | A tag type identifier to filter by | Optional |
Return Type
Add
Add a tag or tags to a piece of content.
Usage
#set($additionalInfoResponse = $core_v2_tags.Add($contentUrl, $oauthClientId, $tags, "%{TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentUrl | string | Content Url | Required | ||
oauthClientId | Guid | Oauth Client Id | Required | ||
tags | string | Comma-separated list of tags | Required | ||
TypeId | Guid | Categorization type | Optional |
Return Type
Add
Add a tag or tags to a piece of content.
Usage
#set($additionalInfoResponse = $core_v2_tags.Add($contentId, $contentTypeId, $tags))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
contentTypeId | Guid | Content Type Id | Required | ||
tags | string | Comma-separated list of tags | Required |
Return Type
Add
Add a tag or tags to a piece of content.
Usage
#set($additionalInfoResponse = $core_v2_tags.Add($contentId, $contentTypeId, $tags, "%{TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
contentTypeId | Guid | Content Type Id | Required | ||
tags | string | Comma-separated list of tags | Required | ||
TypeId | Guid | Categorization type | Optional |
Return Type
CanAddTags
Checks whether the accessing user can add tags to this content type.
Usage
#set($booleanResponse = $core_v2_tags.CanAddTags($contentUrl, $oauthClientId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentUrl | string | Content Url | Required | ||
oauthClientId | Guid | Oauth Client Id | Required |
Return Type
bool
CanAddTags
Checks whether the accessing user can add tags to this content type.
Usage
#set($booleanResponse = $core_v2_tags.CanAddTags($contentId, $contentTypeId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
contentTypeId | Guid | Content Type Id | Required |
Return Type
bool
CanAddTagsInApplication
Checks whether the accessing user can add seed tags for a specific application
Usage
#set($booleanResponse = $core_v2_tags.CanAddTagsInApplication($applicationId, $applicationTypeId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
applicationId | Guid | Application Id | Required | ||
applicationTypeId | Guid | Application Type Id | Required |
Return Type
bool
CanAddTagsInApplicationType
Checks whether the accessing user can add seed tags for a specific application
Usage
#set($booleanResponse = $core_v2_tags.CanAddTagsInApplicationType($applicationTypeId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
applicationTypeId | Guid | Application Type Id | Required |
Return Type
bool
CanDeleteTagsInApplication
Checks whether the accessing user can remove tags in bulk for a specific application
Usage
#set($booleanResponse = $core_v2_tags.CanDeleteTagsInApplication($applicationId, $applicationTypeId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
applicationId | Guid | Application Id | Required | ||
applicationTypeId | Guid | Application Type Id | Required |
Return Type
bool
CanDeleteTagsInApplicationType
Checks whether the accessing user can remove tags in bulk for a specific application type
Usage
#set($booleanResponse = $core_v2_tags.CanDeleteTagsInApplicationType($applicationTypeId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
applicationTypeId | Guid | Application Type Id | Required |
Return Type
bool
CanRemoveTags
Checks whether the accessing user can remove tags from this content type.
Usage
#set($booleanResponse = $core_v2_tags.CanRemoveTags($contentId, $contentTypeId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
contentTypeId | Guid | Content Type Id | Required |
Return Type
bool
CanRemoveTags
Checks whether the accessing user can remove tags from this content type.
Usage
#set($booleanResponse = $core_v2_tags.CanRemoveTags($contentUrl, $oauthClientId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentUrl | string | Content Url | Required | ||
oauthClientId | Guid | Oauth Client Id | Required |
Return Type
bool
CanRenameTagsInApplication
Checks whether the accessing user can rename tags in bulk for a specific application
Usage
#set($booleanResponse = $core_v2_tags.CanRenameTagsInApplication($applicationId, $applicationTypeId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
applicationId | Guid | Application Id | Required | ||
applicationTypeId | Guid | Application Type Id | Required |
Return Type
bool
CanRenameTagsInApplicationType
Checks whether the accessing user can rename tags in bulk for a specific application
Usage
#set($booleanResponse = $core_v2_tags.CanRenameTagsInApplicationType($applicationTypeId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
applicationTypeId | Guid | Application Type Id | Required |
Return Type
bool
Delete
Delete a tag.
Usage
#set($additionalInfoResponse = $core_v2_tags.Delete($tag, "%{ApplicationId = $applicationIdArg, ApplicationTypeId = $applicationTypeIdArg, TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
tag | string | Tag | Required | ||
ApplicationId | Guid | A content application identifier to filter by | Optional | ||
ApplicationTypeId | Guid | A content application type identifier to filter by | Optional | ||
TypeId | Guid | A tag type identifier to filter by | Optional |
Return Type
Get
Get tags for a piece of content.
Usage
#set($apiListResponse = $core_v2_tags.Get($contentId, $contentTypeId, "%{TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
contentTypeId | Guid | Content Type Id | Required | ||
TypeId | Guid | Categorization type | Optional |
Return Type
Get
Get tags for a piece of content.
Usage
#set($apiListResponse = $core_v2_tags.Get($contentId, $contentTypeId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
contentTypeId | Guid | Content Type Id | Required |
Return Type
Get
Get tags for a piece of content.
Usage
#set($apiListResponse = $core_v2_tags.Get($contentUrl, $oauthClientId, "%{TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentUrl | string | Content Url | Required | ||
oauthClientId | Guid | Oauth Client Id | Required | ||
TypeId | Guid | Categorization type | Optional |
Return Type
Get
Get tags for a piece of content.
Usage
#set($apiListResponse = $core_v2_tags.Get($contentUrl, $oauthClientId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentUrl | string | Content Url | Required | ||
oauthClientId | Guid | Oauth Client Id | Required |
Return Type
List
Gets a list of tags given the options provided.
Usage
#set($pagedListResponse = $core_v2_tags.List("%{ApplicationIds = $applicationIdsArg, ApplicationTypeIds = $applicationTypeIdsArg, ContainerIds = $containerIdsArg, ContentTypeIds = $contentTypeIdsArg, IncludeSubContainers = $includeSubContainersArg, LogicallyOrTags = $logicallyOrTagsArg, MinimumContentCount = $minimumContentCountArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, TagNameFilter = $tagNameFilterArg, Tags = $tagsArg, TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ApplicationIds | string | Comma-separated list of content application identifiers to filter by | Optional | ||
ApplicationTypeIds | string | Comma-separated list of content application type identifiers to filter by | Optional | ||
ContainerIds | string | Comma-separated list of content container identifiers to filter by | Optional | ||
ContentTypeIds | string | Comma-separated list of content type identifiers to filter by | Optional | ||
IncludeSubContainers | string | Include sub containers of the containers listed in ContainerIds | Optional | ||
LogicallyOrTags | bool | Enables filtering by logically OR-ing the filter tags | Optional | False | |
MinimumContentCount | int | Sets the minimum number of matching content required to return a tag | Optional | 1 | |
PageIndex | int | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
PageSize | int | Specify the number of results to return per page. | Optional | 20 | |
SortBy | string | How the results will be sorted(Name, ContentCount, LatestTaggedDate) | Optional | Name | |
SortOrder | string | The sort order of the items | Optional | Ascending | Ascending, Descending |
TagNameFilter | string | Search for tags by name | Optional | ||
Tags | string | A comma-seperated list of filter tags | Optional | ||
TypeId | Guid | A tag type identifier to filter by | Optional |
Return Type
ListTaggedContent
Lists tagged content. This method is supported for backwards compatibility, but $core_v2_taggedContent.List() should be used if possible.
Usage
#set($pagedListResponse = $core_v2_tags.ListTaggedContent($tags, "%{PageIndex = $pageIndexArg, PageSize = $pageSizeArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
tags | IList<string> | Tags | Required | ||
PageIndex | int | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
PageSize | int | Specify the number of results to return per page. | Optional | 20 |
Return Type
ListTags
Lists tags. This method is supported for backwards compatibility, but $core_v2_tags.List() should be used if possible.
Usage
#set($pagedListResponse = $core_v2_tags.ListTags("%{FilterTags = $filterTagsArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
FilterTags | IList<string> | Comma separated list of tags to filter | Optional |
Return Type
Remove
Remove a tag or tags from a piece of content.
Usage
#set($additionalInfoResponse = $core_v2_tags.Remove($contentUrl, $oauthClientId, $tags, "%{TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentUrl | string | Content Url | Required | ||
oauthClientId | Guid | Oauth Client Id | Required | ||
tags | string | Comma-separated list of tags | Required | ||
TypeId | Guid | Categorization type | Optional |
Return Type
Remove
Remove a tag or tags from a piece of content.
Usage
#set($additionalInfoResponse = $core_v2_tags.Remove($contentId, $contentTypeId, $tags))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
contentTypeId | Guid | Content Type Id | Required | ||
tags | string | Comma-separated list of tags | Required |
Return Type
Remove
Remove a tag or tags from a piece of content.
Usage
#set($additionalInfoResponse = $core_v2_tags.Remove($contentUrl, $oauthClientId, $tags))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentUrl | string | Content Url | Required | ||
oauthClientId | Guid | Oauth Client Id | Required | ||
tags | string | Comma-separated list of tags | Required |
Return Type
Remove
Remove a tag or tags from a piece of content.
Usage
#set($additionalInfoResponse = $core_v2_tags.Remove($contentId, $contentTypeId, $tags, "%{TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
contentTypeId | Guid | Content Type Id | Required | ||
tags | string | Comma-separated list of tags | Required | ||
TypeId | Guid | Categorization type | Optional |
Return Type
Rename
Rename a tag.
Usage
#set($additionalInfoResponse = $core_v2_tags.Rename($originalTag, $replacementTag, "%{ApplicationId = $applicationIdArg, ApplicationTypeId = $applicationTypeIdArg, TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
originalTag | string | Original Tag | Required | ||
replacementTag | string | Replacement Tag | Required | ||
ApplicationId | Guid | A content application identifier to filter by | Optional | ||
ApplicationTypeId | Guid | A content application type identifier to filter by | Optional | ||
TypeId | Guid | A tag type identifier to filter by | Optional |
Return Type
Set
Set tags for a piece of content.
Usage
#set($additionalInfoResponse = $core_v2_tags.Set($contentUrl, $oauthClientId, $tags))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentUrl | string | Content Url | Required | ||
oauthClientId | Guid | Oauth Client Id | Required | ||
tags | string | Comma-separated list of tags | Required |
Return Type
Set
Set tags for a piece of content.
Usage
#set($additionalInfoResponse = $core_v2_tags.Set($contentUrl, $oauthClientId, $tags, "%{TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentUrl | string | Content Url | Required | ||
oauthClientId | Guid | Oauth Client Id | Required | ||
tags | string | Comma-separated list of tags | Required | ||
TypeId | Guid | Categorization type | Optional |
Return Type
Set
Set tags for a piece of content.
Usage
#set($additionalInfoResponse = $core_v2_tags.Set($contentId, $contentTypeId, $tags, "%{TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
contentTypeId | Guid | Content Type Id | Required | ||
tags | string | Comma-separated list of tags | Required | ||
TypeId | Guid | Categorization type | Optional |
Return Type
Set
Set tags for a piece of content.
Usage
#set($additionalInfoResponse = $core_v2_tags.Set($contentId, $contentTypeId, $tags))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
contentTypeId | Guid | Content Type Id | Required | ||
tags | string | Comma-separated list of tags | Required |
Return Type
Sort
Sorts a list of tag instances
Usage
#set($iListResponse = $core_v2_tags.Sort($tags))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
tags | IList<tag> | Tags | Required |
Return Type
IList<tag>
Sort
Sorts a list of tag instances
Usage
#set($iListResponse = $core_v2_tags.Sort($tags, "%{CssClasses = $cssClassesArg, MaximumNumberOfTags = $maximumNumberOfTagsArg, MinimumItemsPerTag = $minimumItemsPerTagArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
tags | IList<tag> | Tags | Required | ||
CssClasses | IList<string> | When provided, applies CSS classes to tags according to their relative use. | Optional | ||
MaximumNumberOfTags | int | When provided, removes tags that are used more than the maximum threshold from the sorted list | Optional | ||
MinimumItemsPerTag | int | When provided, removes tags that are used less than the minium threshold from the sorted list | Optional |
Return Type
IList<tag>
SupportsTags
Check whether the content type supports tagging.
Usage
#set($booleanResponse = $core_v2_tags.SupportsTags($contentTypeId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentTypeId | Guid | Content Type Id | Required |
Return Type
bool
ToStrings
Converts a list of tag instances to a list of tag name strings
Usage
#set($iListResponse = $core_v2_tags.ToStrings($tags))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
tags | IList<tag> | Tags | Required |
Return Type
IList<string>