Enables scripted content fragments to use rated items
Properties
Name | Type | Description | Default | Options |
---|---|---|---|---|
NotificationTypeId | Guid | The default notification type id for ratings |
Methods
Get
Gets a rating summary for a piece of content
Usage
#set($ratedItemResponse = $core_v2_ratedItem.Get($contentId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required |
Return Type
Get
Gets a rating summary for a piece of content
Usage
#set($ratedItemResponse = $core_v2_ratedItem.Get($contentId, "%{TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
TypeId | Guid | Categorization type | Optional |
Return Type
Get
Gets a rating summary for a piece of external content
Usage
#set($ratedItemResponse = $core_v2_ratedItem.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
List
Lists rating summaries for content
Usage
#set($pagedListResponse = $core_v2_ratedItem.List("%{ApplicationId = $applicationIdArg, ContainerId = $containerIdArg, ContentTypeId = $contentTypeIdArg, IncludeSubContainers = $includeSubContainersArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ApplicationId | Guid | Content application identifier | Optional | ||
ContainerId | Guid | Content container identifier | Optional | ||
ContentTypeId | Guid | Content type identifier | Optional | ||
IncludeSubContainers | bool | Include sub containers | Optional | ||
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 | Sort mechanism | Optional | Rating | Rating |
SortOrder | string | Sort order | Optional | Ascending | Ascending, Descending |
TypeId | Guid | Categorization type | Optional |