Enables scripted content fragments to use user achievements
Methods
Create
Add an achievement to a user
Usage
#set($userAchievementResponse = $core_v2_userAchievement.Create($userId, $achievementId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userId | int | User Id | Required | ||
achievementId | Guid | Achievement Id | Required |
Return Type
Delete
Remove an achievement from a user
Usage
#set($additionalInfoResponse = $core_v2_userAchievement.Delete($achievementId, $userId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
achievementId | Guid | Achievement Id | Required | ||
userId | int | User Id | Required |
Return Type
Get
Get's a user's achievement
Usage
#set($userAchievementResponse = $core_v2_userAchievement.Get($achievementId, $userId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
achievementId | Guid | Achievement Id | Required | ||
userId | int | User Id | Required |
Return Type
List
List achievements earned by a user
Usage
#set($pagedListResponse = $core_v2_userAchievement.List($userId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
userId | int | User Id | Required |
Return Type
List
List achievements earned by a user
Usage
#set($pagedListResponse = $core_v2_userAchievement.List("%{AchievementId = $achievementIdArg, BadgeIconUrl = $badgeIconUrlArg, CreatedAfterDate = $createdAfterDateArg, CreatedBeforeDate = $createdBeforeDateArg, Enabled = $enabledArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, UserId = $userIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
AchievementId | int | 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 | 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 |
UserId | int | User to list achievements for | Optional |