Enables scripted content fragments to use liked items
Properties
| Name | Access | Type | Description |
|---|---|---|---|
| NotificationTypeId | Read | Guid | The default notification type id for likes |
Methods
Get
Get Overload 1
Gets a like summary for a piece of content
Velocity
#set($likedItemResponse = $core_v2_likedItem.Get($contentId, "%{ TypeId = $typeIdArg }"))JavaScript
var likedItemResponse = core_v2_likedItem.Get(contentId, { TypeId: typeIdArg });Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| contentId | Guid | Content Id | Required | ||
| options | Options | Set of optional parameters including: | Required | ||
| TypeId | Guid | Categorization type | Optional |
Get Overload 2
Gets a like summary for a piece of external content
Velocity
#set($likedItemResponse = $core_v2_likedItem.Get($contentUrl, $oauthClientId, "%{ TypeId = $typeIdArg }"))JavaScript
var likedItemResponse = core_v2_likedItem.Get(contentUrl, oauthClientId, { TypeId: typeIdArg });Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| contentUrl | String | Content Url | Required | ||
| oauthClientId | Guid | Oauth Client Id | Required | ||
| options | Options | Set of optional parameters including: | Required | ||
| TypeId | Guid | Categorization type | Optional |
Returns
List
Lists like summaries for content
Velocity
#set($pagedListResponse = $core_v2_likedItem.List("%{ ApplicationId = $applicationIdArg, AuthorId = $authorIdArg, ContainerId = $containerIdArg, ContentCreatedAfterDate = $contentCreatedAfterDateArg, ContentCreatedBeforeDate = $contentCreatedBeforeDateArg, ContentIds = $contentIdsArg, ContentTypeId = $contentTypeIdArg, ContentTypeIds = $contentTypeIdsArg, ContentUrl = $contentUrlArg, IncludeAllTypeIds = $includeAllTypeIdsArg, IncludeSubContainers = $includeSubContainersArg, MaximumLikeCount = $maximumLikeCountArg, MinimumLikeCount = $minimumLikeCountArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, TypeId = $typeIdArg }"))JavaScript
var pagedListResponse = core_v2_likedItem.List({ ApplicationId: applicationIdArg, AuthorId: authorIdArg, ContainerId: containerIdArg, ContentCreatedAfterDate: contentCreatedAfterDateArg, ContentCreatedBeforeDate: contentCreatedBeforeDateArg, ContentIds: contentIdsArg, ContentTypeId: contentTypeIdArg, ContentTypeIds: contentTypeIdsArg, ContentUrl: contentUrlArg, IncludeAllTypeIds: includeAllTypeIdsArg, IncludeSubContainers: includeSubContainersArg, MaximumLikeCount: maximumLikeCountArg, MinimumLikeCount: minimumLikeCountArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, SortBy: sortByArg, SortOrder: sortOrderArg, TypeId: typeIdArg });Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| options | Options | Set of optional parameters including: | Required | ||
| ApplicationId | Guid | Content application identifier | Optional | ||
| AuthorId | Int32 | Author Id of the content that was liked. | Optional | ||
| ContainerId | Guid | Content container identifier | Optional | ||
| ContentCreatedAfterDate | Nullable of DateTime | Include only content created on or after. | Optional | ||
| ContentCreatedBeforeDate | Nullable of DateTime | Include only content created before. | Optional | ||
| ContentIds | String | Comma separated list of ContentIds. Used to limit to a specific set of liked items as well as sort order if SortBy is set to ContentIdsOrder. | Optional | ||
| ContentTypeId | Guid | Content type id. Used to filter likes to a specific content type. | Optional | ||
| ContentTypeIds | String | Comma separated list of Content type ids. Used to filter likes by specific content types. | Optional | ||
| ContentUrl | String | Content url | Optional | ||
| IncludeAllTypeIds | Boolean | Option to include all Type Id's. If TypeId is passed in, will be ignored. | Optional | False | |
| IncludeSubContainers | Boolean | Include sub containers | Optional | ||
| MaximumLikeCount | Int32 | Maximum number of likes the content can have for content to be returned. | Optional | ||
| MinimumLikeCount | Int32 | Minimum number of likes the content must have for content to be returned. | Optional | ||
| PageIndex | Int32 | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
| PageSize | Int32 | Specify the number of results to return per page. | Optional | 20 | |
| SortBy | String | Sort mechanism | Optional | LikeCount | ContentIdsOrder, LikeCount |
| SortOrder | String | Sort order | Optional | Ascending | Ascending, Descending |
| TypeId | Guid | Categorization type | Optional |