Enables scripted content fragments to use achievements
Properties
Name | Type | Description | Default | Options |
---|---|---|---|---|
Current | Achievement | Contextual achievement |
Methods
Create
Create an achievement
Usage
#set($achievementResponse = $core_v2_achievement.Create($title, $criteria, $badgeIconName, "%{BadgeIconData = $badgeIconDataArg, BadgeIconUploadContext = $badgeIconUploadContextArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
title | string | Title | Required | ||
criteria | string | Criteria | Required | ||
badgeIconName | string | Badge Icon Name | Required | ||
BadgeIconData | Byte[] | Either BadgeIconData, BadgeIconUploadContext is required. | Optional | ||
BadgeIconUploadContext | string | Either BadgeIconData, BadgeIconUploadContext is required. | Optional |
Return Type
Delete
Delete achievement by its Id
Usage
#set($additionalInfoResponse = $core_v2_achievement.Delete($achievementId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
achievementId | Guid | Achievement Id | Required |
Return Type
Get
Gets an achievement by its Id
Usage
#set($achievementResponse = $core_v2_achievement.Get($achievementId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
achievementId | Guid | Achievement Id | Required |
Return Type
List
List achievements
Usage
#set($pagedListResponse = $core_v2_achievement.List())
Return Type
List
List achievements
Usage
#set($pagedListResponse = $core_v2_achievement.List("%{Enabled = $enabledArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
Enabled | bool | Enabled state of the achievement | Optional | ||
PageIndex | int | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
PageSize | int | Specify the number of results to return per page. | Optional | 20 | |
SortBy | string | Sort mechanism | Optional | Title | DateCreated, Title |
SortOrder | string | Sort order | Optional | Ascending | Ascending, Descending |
Return Type
Update
Update an achievement
Usage
#set($achievementResponse = $core_v2_achievement.Update($id, "%{BadgeIconData = $badgeIconDataArg, BadgeIconName = $badgeIconNameArg, BadgeIconUploadContext = $badgeIconUploadContextArg, Criteria = $criteriaArg, Enabled = $enabledArg, Title = $titleArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | Guid | Id | Required | ||
BadgeIconData | Byte[] | When updating a badge icon BadgeIconName and either BadgeIconData, BadgeIconUploadContext are required. | Optional | ||
BadgeIconName | string | When updating a badge icon BadgeIconName and either BadgeIconData, BadgeIconUploadContext are required. | Optional | ||
BadgeIconUploadContext | string | When updating a badge icon BadgeIconName and either BadgeIconData, BadgeIconUploadContext are required. | Optional | ||
Criteria | string | Criteria to earn the achievement | Optional | ||
Enabled | bool | Enabled state of the achievement | Optional | ||
Title | string | Title of the achievement | Optional |