Enables scripted content fragments to use likes
Methods
CanLike
Identifies if the accessing user can like the specified external content
Usage
#set($booleanResponse = $core_v2_like.CanLike($contentUrl, $oauthClientId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentUrl | string | Content Url | Required | ||
oauthClientId | Guid | Oauth Client Id | Required |
Return Type
bool
CanLike
Identifies if the accessing user can like the specified content
Usage
#set($booleanResponse = $core_v2_like.CanLike($contentId, $contentTypeId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
contentTypeId | Guid | Content Type Id | Required |
Return Type
bool
CanUnlike
Identifies if the accessing user can unlike the specified content
Usage
#set($booleanResponse = $core_v2_like.CanUnlike($contentId, $contentTypeId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
contentTypeId | Guid | Content Type Id | Required |
Return Type
bool
CanUnlike
Identifies if the accessing user can unlike the specified external content
Usage
#set($booleanResponse = $core_v2_like.CanUnlike($contentUrl, $oauthClientId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentUrl | string | Content Url | Required | ||
oauthClientId | Guid | Oauth Client Id | Required |
Return Type
bool
Create
Likes a piece of content for the accessing user
Usage
#set($likeResponse = $core_v2_like.Create($contentId, $contentTypeId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
contentTypeId | Guid | Content Type Id | Required |
Return Type
Create
Likes a piece of content for the accessing user
Usage
#set($likeResponse = $core_v2_like.Create($contentUrl, $oauthClientId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentUrl | string | Content Url | Required | ||
oauthClientId | Guid | Oauth Client Id | Required |
Return Type
Create
Likes a piece of content for the accessing user
Usage
#set($likeResponse = $core_v2_like.Create($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
Create
Likes a piece of content for the accessing user
Usage
#set($likeResponse = $core_v2_like.Create($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
Delete
Removes a like for a piece of content for the accessing user
Usage
#set($additionalInfoResponse = $core_v2_like.Delete($contentId, "%{TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
TypeId | Guid | Categorization type | Optional |
Return Type
Delete
Removes a like for a piece of content for the accessing user
Usage
#set($additionalInfoResponse = $core_v2_like.Delete($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
Delete
Removes a like for a piece of content for the accessing user
Usage
#set($additionalInfoResponse = $core_v2_like.Delete($contentUrl, $oauthClientId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentUrl | string | Content Url | Required | ||
oauthClientId | Guid | Oauth Client Id | Required |
Return Type
Delete
Removes a like for a piece of content for the accessing user
Usage
#set($additionalInfoResponse = $core_v2_like.Delete($contentId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required |
Return Type
Get
Gets an existing like for a piece of content for the accessing user
Usage
#set($likeResponse = $core_v2_like.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
Gets an existing like for a piece of content for the accessing user
Usage
#set($likeResponse = $core_v2_like.Get($contentUrl, $oauthClientId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentUrl | string | Content Url | Required | ||
oauthClientId | Guid | Oauth Client Id | Required |
Return Type
Get
Gets an existing like for a piece of content for the accessing user
Usage
#set($likeResponse = $core_v2_like.Get($contentId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required |
Return Type
Get
Gets an existing like for a piece of content for the accessing user
Usage
#set($likeResponse = $core_v2_like.Get($contentId, "%{TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
TypeId | Guid | Categorization type | Optional |
Return Type
List
Lists likes
Usage
#set($pagedListResponse = $core_v2_like.List("%{ApplicationId = $applicationIdArg, ContainerId = $containerIdArg, ContentCreatedAfterDate = $contentCreatedAfterDateArg, ContentCreatedBeforeDate = $contentCreatedBeforeDateArg, ContentId = $contentIdArg, ContentIds = $contentIdsArg, ContentTypeId = $contentTypeIdArg, ContentUrl = $contentUrlArg, IncludeSubContainers = $includeSubContainersArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, TypeId = $typeIdArg, UserId = $userIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ApplicationId | Guid | Content application identifier | Optional | ||
ContainerId | Guid | Content container identifier | Optional | ||
ContentCreatedAfterDate | DateTime? | Include only content created on or after. | Optional | ||
ContentCreatedBeforeDate | DateTime? | Include onlu content created before. | Optional | ||
ContentId | Guid | Content identifier | Optional | ||
ContentIds | string | Comma separated list of ContentIds. Used to limit to a specific set of likes as well as sort order if SoryBy is set to ContentIdsOrder. | Optional | ||
ContentTypeId | Guid | Content type identifier | Optional | ||
ContentUrl | string | Content url | Optional | ||
IncludeSubContainers | bool | Include sub containers. ContainerId must be set if this is set. | 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 | Date | ContentIdsOrder, Date |
SortOrder | string | Sort order | Optional | Ascending | Ascending, Descending |
TypeId | Guid | Categorization type | Optional | ||
UserId | int | User identifier | Optional |
Return Type
SupportsLikes
Identifies whether the specified content type supports likes
Usage
#set($booleanResponse = $core_v2_like.SupportsLikes($contentTypeId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentTypeId | Guid | Content Type Id | Required |
Return Type
bool