Ratings In-Process API Service

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

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

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

Events

Events.AfterCreate

Handler

void RatingAfterCreateEventHandler([[RatingAfterCreateEventArgs In-Process API Event Argument|RatingAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void RatingAfterDeleteEventHandler([[RatingAfterDeleteEventArgs In-Process API Event Argument|RatingAfterDeleteEventArgs]] e);

Events.AfterUpdate

Handler

void RatingAfterUpdateEventHandler([[RatingAfterUpdateEventArgs In-Process API Event Argument|RatingAfterUpdateEventArgs]] e);

Events.BeforeCreate

Handler

void RatingBeforeCreateEventHandler([[RatingBeforeCreateEventArgs In-Process API Event Argument|RatingBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void RatingBeforeDeleteEventHandler([[RatingBeforeDeleteEventArgs In-Process API Event Argument|RatingBeforeDeleteEventArgs]] e);

Events.BeforeUpdate

Handler

void RatingBeforeUpdateEventHandler([[RatingBeforeUpdateEventArgs In-Process API Event Argument|RatingBeforeUpdateEventArgs]] e);

Properties

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

Methods

bool CanCreate(Guid contentId, Guid contentTypeId);

Returns whether the accessing user can rate a given piece of content

Parameters

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

Return Type

bool

bool CanCreate(string contentUrl, Guid oauthClientId);

Returns whether the accessing user can rate a given piece of 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 CanDelete(Guid contentId, Guid? typeId, int ratingUserId);

Returns whether the accessing user can delete a rating of a piece of content

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
typeId	`Guid?`	Categorization type	Required
ratingUserId	`int`	User who rated the content	Required

Return Type

bool

bool CanDelete(string contentUrl, Guid oauthClientId, Guid? typeId, int ratingUserId);

Returns whether the accessing user can delete a rating of a piece of external content

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
typeId	`Guid?`	Categorization type	Required
ratingUserId	`int`	User who rated the content	Required

Return Type

bool

Rating Create(Guid contentId, Guid contentTypeId, double? value, RatingCreateOptions options = null);

Rates a piece of content for the accessing user

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content type Id	Required
value	`double?`	Value of the rating	Required
options	`[[RatingCreateOptions In-Process API Supplementary Type\|RatingCreateOptions]]`	Options include: TypeId	Optional

Return Type

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

Rating Create(string contentUrl, Guid oauthClientId, double? value, RatingCreateOptions options = null);

Rates 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
value	`double?`	Value of the rating	Required
options	`[[RatingCreateOptions In-Process API Supplementary Type\|RatingCreateOptions]]`	Options include: TypeId	Optional

Return Type

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

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

Deletes a rating of a piece of content by the accessing user

Parameters

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

Return Type

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

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

Deletes a rating of an external content by 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	`[[RatingDeleteOptions In-Process API Supplementary Type\|RatingDeleteOptions]]`	Options include: TypeId	Optional

Return Type

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

Rating Get(Guid contentId, RatingGetOptions options = null);

Gets an existing rating for a piece of content by the accessing user

Parameters

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

Return Type

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

Rating Get(string contentUrl, Guid oauthClientId, RatingGetOptions options = null);

Gets an existing rating for an external content by 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	`[[RatingGetOptions In-Process API Supplementary Type\|RatingGetOptions]]`	Options include: TypeId	Optional

Return Type

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

PagedList<Rating> List(RatingListOptions options = null);

Lists ratings

Parameters

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

Return Type

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

bool Supports(Guid contentTypeId);

Returns whether a content type supports rating

Parameters

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

Return Type

bool