Likes In-Process API Service

Ben Tiedt — Fri, 08 Mar 2024 17:31:58 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:31:58

This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.ILikes>() and is defined in Telligent.Evolution.Platform.dll

Events

Events.AfterCreate

Handler

void LikeAfterCreateEventHandler([[LikeAfterCreateEventArgs In-Process API Event Argument|LikeAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void LikeAfterDeleteEventHandler([[LikeAfterDeleteEventArgs In-Process API Event Argument|LikeAfterDeleteEventArgs]] e);

Events.BeforeCreate

Handler

void LikeBeforeCreateEventHandler([[LikeBeforeCreateEventArgs In-Process API Event Argument|LikeBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void LikeBeforeDeleteEventHandler([[LikeBeforeDeleteEventArgs In-Process API Event Argument|LikeBeforeDeleteEventArgs]] e);

Properties

Name	Type	Description	Default	Options
DataTypeId Obsolete	`Guid`	Migrate usage to scripted email or scripted plugins.

Methods

bool CanLike(Guid contentId, Guid contentType);

Identifies if the accessing user can like the specified content

Parameters

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

Return Type

bool

bool CanLike(string contentUrl, Guid oauthClientId);

Identifies if the accessing user can like the specified external content

Parameters

Name	Type	Description	Required	Default	Options
contentUrl	`string`	The URL at which this content can be accessed.	Required
oauthClientId	`Guid`	OAuth client ID containing this external content.	Required

Return Type

bool

bool CanUnlike(Guid contentId, Guid contentType);

Identifies if the accessing user can unlike the specified content

Parameters

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

Return Type

bool

bool CanUnlike(string contentUrl, Guid oauthClientId);

Identifies if the accessing user can unlike the specified external content

Parameters

Name	Type	Description	Required	Default	Options
contentUrl	`string`	The URL at which this content can be accessed.	Required
oauthClientId	`Guid`	OAuth client ID containing this external content.	Required

Return Type

bool

Like Create(Guid contentId, Guid contentTypeId, LikeCreateOptions options = null);

Likes a piece of content for the accessing user

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content type Id	Required
options	`[[LikeCreateOptions In-Process API Supplementary Type\|LikeCreateOptions]]`	Options include: TypeId	Optional

Return Type

[[Like In-Process API Supplementary Type|Like]]

Like Create(string contentUrl, Guid oauthClientId, LikeCreateOptions options = null);

Likes an external content for the accessing user

Parameters

Name	Type	Description	Required
contentUrl	`string`	The URL at which this content can be accessed.	Required
oauthClientId	`Guid`	OAuth client ID containing this external content.	Required
options	`[[LikeCreateOptions In-Process API Supplementary Type\|LikeCreateOptions]]`	Options include: TypeId	Optional

Return Type

[[Like In-Process API Supplementary Type|Like]]

AdditionalInfo Delete(Guid contentId, LikeDeleteOptions options = null);

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

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content Id	Required
options	`[[LikeDeleteOptions In-Process API Supplementary Type\|LikeDeleteOptions]]`	Options include: TypeId	Optional

Return Type

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

AdditionalInfo Delete(string contentUrl, Guid oauthClientId, LikeDeleteOptions options = null);

Removes a like for an external content for the accessing user

Parameters

Name	Type	Description	Required
contentUrl	`string`	The URL at which this content can be accessed.	Required
oauthClientId	`Guid`	OAuth client ID containing this external content.	Required
options	`[[LikeDeleteOptions In-Process API Supplementary Type\|LikeDeleteOptions]]`	Options include: TypeId	Optional

Return Type

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

Like Get(Guid contentId, LikeGetOptions options = null);

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

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content Id	Required
options	`[[LikeGetOptions In-Process API Supplementary Type\|LikeGetOptions]]`	Options include: TypeId	Optional

Return Type

[[Like In-Process API Supplementary Type|Like]]

Like Get(string contentUrl, Guid oauthClientId, LikeGetOptions options = null);

Gets an existing like for an external content for the accessing user

Parameters

Name	Type	Description	Required
contentUrl	`string`	The URL at which this content can be accessed.	Required
oauthClientId	`Guid`	OAuth client ID containing this external content.	Required
options	`[[LikeGetOptions In-Process API Supplementary Type\|LikeGetOptions]]`	Options include: TypeId	Optional

Return Type

[[Like In-Process API Supplementary Type|Like]]

PagedList<Like> List(LikeListOptions options = null);

Lists likes

Parameters

Name	Type	Description	Required	Default	Options
options	`[[LikeListOptions In-Process API Supplementary Type\|LikeListOptions]]`	Options include: ContentId, ContentUrl, ContentIds, ContainerId, ApplicationId, ContentTypeId, UserId, TypeId, SortBy, SortOrder, PageSize, PageIndex	Optional

Return Type

[[PagedList(T) In-Process API Supplementary Type|PagedList]]<[[Like In-Process API Supplementary Type|Like]]>

bool SupportsLikes(Guid contentType);

Identifies whether the specified content type supports likes

Parameters

Name	Type	Description	Required	Default	Options
contentType	`Guid`	Content type	Required

Return Type

bool