PointTransactions In-Process API Service

Ben Tiedt — Fri, 08 Mar 2024 17:32:43 GMT

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

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

Events

Events.AfterCreate

Handler

void PointTransactionAfterCreateEventHandler([[PointTransactionAfterCreateEventArgs In-Process API Event Argument|PointTransactionAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void PointTransactionAfterDeleteEventHandler([[PointTransactionAfterDeleteEventArgs In-Process API Event Argument|PointTransactionAfterDeleteEventArgs]] e);

Events.AfterUpdate

Handler

void PointTransactionAfterUpdateEventHandler([[PointTransactionAfterUpdateEventArgs In-Process API Event Argument|PointTransactionAfterUpdateEventArgs]] e);

Events.BeforeCreate

Handler

void PointTransactionBeforeCreateEventHandler([[PointTransactionBeforeCreateEventArgs In-Process API Event Argument|PointTransactionBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void PointTransactionBeforeDeleteEventHandler([[PointTransactionBeforeDeleteEventArgs In-Process API Event Argument|PointTransactionBeforeDeleteEventArgs]] e);

Events.BeforeUpdate

Handler

void PointTransactionBeforeUpdateEventHandler([[PointTransactionBeforeUpdateEventArgs In-Process API Event Argument|PointTransactionBeforeUpdateEventArgs]] e);

Properties

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

Methods

PointTransaction Create(string description, int userId, int value, Guid contentId, Guid contentTypeId, PointTransactionCreateOptions options = null);

Point Transaction Create

Parameters

Name	Type	Description	Required
description	`string`	Short explanation of why points are being awarded	Required
userId	`int`	Which user points are being awarded to	Required
value	`int`	Amount of points being awarded (or removed if this number is negative)	Required
contentId	`Guid`	Identifier of content related to this point transaction	Required
contentTypeId	`Guid`	Content Type identifier of content related to this point transaction	Required
options	`[[PointTransactionCreateOptions In-Process API Supplementary Type\|PointTransactionCreateOptions]]`	Optional parameters are: CreatedDate	Optional

Return Type

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

AdditionalInfo Delete(Int64 pointTransactionId);

Point Transaction Delete

Parameters

Name	Type	Description	Required	Default	Options
pointTransactionId	`Int64`	Identifier for transaction	Required

Return Type

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

AdditionalInfo DeleteByType(Guid typeId);

Point Transaction Delete by TypeId. Schedules a job to delete all existing point transaction that match the TypeId provided.

Parameters

Name	Type	Description	Required	Default	Options
typeId	`Guid`	Categorization type of the point transactions	Required

Return Type

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

PointTransaction Get(Int64 pointTransactionId);

Point Transaction Get

Parameters

Name	Type	Description	Required	Default	Options
pointTransactionId	`Int64`	Identifier for transaction	Required

Return Type

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

bool HasPointsTransaction(int userId, string contextToken);

Point Transaction Check for ContextToken

Parameters

Name	Type	Description	Required	Default	Options
userId	`int`	User Id	Required
contextToken	`string`	Context Token	Required

Return Type

bool

PagedList<PointTransaction> List(PointTransactionListOptions options = null);

Point Transaction List

Parameters

Name	Type	Description	Required	Default	Options
options	`[[PointTransactionListOptions In-Process API Supplementary Type\|PointTransactionListOptions]]`	Optional parameter names are: UserId, ApplicationId, ContainerId, ContentTypeId, ContentId, StartDate, EndDate, SortBy, SortOrder, PageSize, PageIndex	Optional

Return Type

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

AdditionalInfo UpdateByType(Guid typeId, int value);

Point Transaction Update by TypeId. Schedules a job to update point values of all existing point transactions that match the TypeId provided.

Parameters

Name	Type	Description	Required	Default	Options
typeId	`Guid`	Categorization type of the point transactions	Required
value	`int`	New value of points	Required

Return Type

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