Enables scripted content fragments to use user achievements
Methods
Create
Add an achievement to a user
Velocity
JavaScript
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userId | Int32 | User Id | Required | ||
achievementId | Guid | Achievement Id | Required |
Returns
Delete
Remove an achievement from a user
Velocity
JavaScript
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
achievementId | Guid | Achievement Id | Required | ||
userId | Int32 | User Id | Required |
Returns
Get
Get's a user's achievement
Velocity
JavaScript
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
achievementId | Guid | Achievement Id | Required | ||
userId | Int32 | User Id | Required |
Returns
List
List Overload 1
List achievements earned by a user
Velocity
JavaScript
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userId | Int32 | User Id | Required |
List Overload 2
List achievements earned by a user
Velocity
JavaScript
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
options | Options | Set of optional parameters including: | Required | ||
AchievementId | Int32 | Lists awarded users for this achievement | Optional | ||
BadgeIconUrl | String | Url to the icon representing the achievement | Optional | ||
CreatedAfterDate | DateTime | Filter to achievements awarded after this date | Optional | ||
CreatedBeforeDate | DateTime | Filter to achievements awarded before this date | Optional | ||
Enabled | Boolean | Enabled state of the achievement | Optional | ||
PageIndex | Int32 | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
PageSize | Int32 | 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 |
UserId | Int32 | User to list achievements for | Optional |