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 e);
Events.AfterDelete
Handler
void PointTransactionAfterDeleteEventHandler(PointTransactionAfterDeleteEventArgs e);
Events.AfterUpdate
Handler
void PointTransactionAfterUpdateEventHandler(PointTransactionAfterUpdateEventArgs e);
Events.BeforeCreate
Handler
void PointTransactionBeforeCreateEventHandler(PointTransactionBeforeCreateEventArgs e);
Events.BeforeDelete
Handler
void PointTransactionBeforeDeleteEventHandler(PointTransactionBeforeDeleteEventArgs e);
Events.BeforeUpdate
Handler
void PointTransactionBeforeUpdateEventHandler(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 | Default | Options |
|---|---|---|---|---|---|
| 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 | Optional parameters are: CreatedDate | Optional |
Return Type
AdditionalInfo Delete(Int64 pointTransactionId);
Point Transaction Delete
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| pointTransactionId | Int64 | Identifier for transaction | Required |
Return Type
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
PointTransaction Get(Int64 pointTransactionId);
Point Transaction Get
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| pointTransactionId | Int64 | Identifier for transaction | Required |
Return Type
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 | Optional parameter names are: UserId, ApplicationId, ContainerId, ContentTypeId, ContentId, StartDate, EndDate, SortBy, SortOrder, PageSize, PageIndex | Optional |
Return Type
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 |