core_v2_like Script API

Ben Tiedt — Wed, 20 Nov 2019 14:53:03 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/20/2019 14:53:03

Enables scripted content fragments to use likes

CanLike
CanUnlike
Create
Delete
Get
List
SupportsLikes

Methods

CanLike

CanLike Overload 1

Identifies if the accessing user can like the specified content

Velocity

#set($booleanResponse = $core_v2_like.CanLike($contentId, $contentTypeId))

JavaScript

var 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

CanLike Overload 2

Identifies if the accessing user can like the specified external content

Velocity

#set($booleanResponse = $core_v2_like.CanLike($contentUrl, $oauthClientId))

JavaScript

var 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

Returns

Boolean

CanUnlike

CanUnlike Overload 1

Identifies if the accessing user can unlike the specified content

Velocity

#set($booleanResponse = $core_v2_like.CanUnlike($contentId, $contentTypeId))

JavaScript

var 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

CanUnlike Overload 2

Identifies if the accessing user can unlike the specified external content

Velocity

#set($booleanResponse = $core_v2_like.CanUnlike($contentUrl, $oauthClientId))

JavaScript

var 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

Returns

Boolean

Create

Create Overload 1

Likes a piece of content for the accessing user

Velocity

#set($likeResponse = $core_v2_like.Create($contentId, $contentTypeId))

JavaScript

var 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

Create Overload 2

Likes a piece of content for the accessing user

Velocity

#set($likeResponse = $core_v2_like.Create($contentId, $contentTypeId, "%{ TypeId = $typeIdArg }"))

JavaScript

var likeResponse = core_v2_like.Create(contentId, contentTypeId, { TypeId: typeIdArg });

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required
TypeId	`Guid`	Categorization type	Optional

Create Overload 3

Likes a piece of content for the accessing user

Velocity

#set($likeResponse = $core_v2_like.Create($contentUrl, $oauthClientId))

JavaScript

var 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

Create Overload 4

Likes a piece of content for the accessing user

Velocity

#set($likeResponse = $core_v2_like.Create($contentUrl, $oauthClientId, "%{ TypeId = $typeIdArg }"))

JavaScript

var likeResponse = core_v2_like.Create(contentUrl, oauthClientId, { TypeId: typeIdArg });

Parameters

Name	Type	Description	Required
contentUrl	`String`	Content Url	Required
oauthClientId	`Guid`	Oauth Client Id	Required
TypeId	`Guid`	Categorization type	Optional

Returns

[[Like Script API Type|Like]]

Delete

Delete Overload 1

Removes a like for a piece of content for the accessing user

Velocity

#set($additionalInfoResponse = $core_v2_like.Delete($contentId))

JavaScript

var additionalInfoResponse = core_v2_like.Delete(contentId);

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content Id	Required

Delete Overload 2

Removes a like for a piece of content for the accessing user

Velocity

#set($additionalInfoResponse = $core_v2_like.Delete($contentId, "%{ TypeId = $typeIdArg }"))

JavaScript

var 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

Delete Overload 3

Removes a like for a piece of content for the accessing user

Velocity

#set($additionalInfoResponse = $core_v2_like.Delete($contentUrl, $oauthClientId))

JavaScript

var 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

Delete Overload 4

Removes a like for a piece of content for the accessing user

Velocity

#set($additionalInfoResponse = $core_v2_like.Delete($contentUrl, $oauthClientId, "%{ TypeId = $typeIdArg }"))

JavaScript

var additionalInfoResponse = core_v2_like.Delete(contentUrl, oauthClientId, { TypeId: typeIdArg });

Parameters

Name	Type	Description	Required
contentUrl	`String`	Content Url	Required
oauthClientId	`Guid`	Oauth Client Id	Required
TypeId	`Guid`	Categorization type	Optional

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]

Get

Get Overload 1

Gets an existing like for a piece of content for the accessing user

Velocity

#set($likeResponse = $core_v2_like.Get($contentId))

JavaScript

var likeResponse = core_v2_like.Get(contentId);

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content Id	Required

Get Overload 2

Gets an existing like for a piece of content for the accessing user

Velocity

#set($likeResponse = $core_v2_like.Get($contentId, "%{ TypeId = $typeIdArg }"))

JavaScript

var 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

Get Overload 3

Gets an existing like for a piece of content for the accessing user

Velocity

#set($likeResponse = $core_v2_like.Get($contentUrl, $oauthClientId))

JavaScript

var 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

Get Overload 4

Gets an existing like for a piece of content for the accessing user

Velocity

#set($likeResponse = $core_v2_like.Get($contentUrl, $oauthClientId, "%{ TypeId = $typeIdArg }"))

JavaScript

var likeResponse = core_v2_like.Get(contentUrl, oauthClientId, { TypeId: typeIdArg });

Parameters

Name	Type	Description	Required
contentUrl	`String`	Content Url	Required
oauthClientId	`Guid`	Oauth Client Id	Required
TypeId	`Guid`	Categorization type	Optional

Returns

[[Like Script API Type|Like]]

List

Lists likes

Velocity

#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 }"))

JavaScript

var 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	`Nullable of DateTime`	Include only content created on or after.	Optional
ContentCreatedBeforeDate	`Nullable of 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	`Boolean`	Include sub containers. ContainerId must be set if this is set.	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	Date	ContentIdsOrder, Date
SortOrder	`String`	Sort order	Optional	Ascending	Ascending, Descending
TypeId	`Guid`	Categorization type	Optional
UserId	`Int32`	User identifier	Optional

Returns

[[PagedList Script API Type|PagedList]] of [[Like Script API Type|Like]]

SupportsLikes

Identifies whether the specified content type supports likes

Velocity

#set($booleanResponse = $core_v2_like.SupportsLikes($contentTypeId))

JavaScript

var booleanResponse = core_v2_like.SupportsLikes(contentTypeId);

Parameters

Name	Type	Description	Required	Default	Options
contentTypeId	`Guid`	Content Type Id	Required

Returns

Boolean