symbols:
# region models
'ModelsAchievementOrderUpdateRequest@cs.achievement.mod':
id: 'ModelsAchievementOrderUpdateRequest@cs.achievement.mod'
name: 'ModelsAchievementOrderUpdateRequest'
type: 'model'
fields:
'TargetOrder':
type: 'int'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Model/ModelsAchievementOrderUpdateRequest.cs'
'ModelsAchievementRequest@cs.achievement.mod':
id: 'ModelsAchievementRequest@cs.achievement.mod'
name: 'ModelsAchievementRequest'
type: 'model'
fields:
'AchievementCode':
type: 'string'
required: true
'DefaultLanguage':
type: 'string'
required: true
'Description':
type: 'Dictionary<string, string>'
required: true
'GoalValue':
type: 'double'
required: true
'Hidden':
type: 'bool'
required: true
'Incremental':
type: 'bool'
required: true
'LockedIcons':
type: 'List<ModelsIcon>'
required: true
'Name':
type: 'Dictionary<string, string>'
required: true
'StatCode':
type: 'string'
required: true
'Tags':
type: 'List<string>'
required: true
'UnlockedIcons':
type: 'List<ModelsIcon>'
required: true
'CustomAttributes':
type: 'Dictionary<string, object>'
required: false
'Global':
type: 'bool'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Model/ModelsAchievementRequest.cs'
'ModelsAchievementResponse@cs.achievement.mod':
id: 'ModelsAchievementResponse@cs.achievement.mod'
name: 'ModelsAchievementResponse'
type: 'model'
fields:
'AchievementCode':
type: 'string'
required: true
'CreatedAt':
type: 'DateTime'
required: true
'DefaultLanguage':
type: 'string'
required: true
'Description':
type: 'Dictionary<string, string>'
required: true
'Global':
type: 'bool'
required: true
'Hidden':
type: 'bool'
required: true
'Incremental':
type: 'bool'
required: true
'ListOrder':
type: 'int'
required: true
'LockedIcons':
type: 'List<ModelsIcon>'
required: true
'Name':
type: 'Dictionary<string, string>'
required: true
'Namespace':
type: 'string'
required: true
'Tags':
type: 'List<string>'
required: true
'UnlockedIcons':
type: 'List<ModelsIcon>'
required: true
'UpdatedAt':
type: 'DateTime'
required: true
'CustomAttributes':
type: 'Dictionary<string, object>'
required: false
'GoalValue':
type: 'double'
required: false
'StatCode':
type: 'string'
required: false
'Status':
type: 'string'
required: false
description: |-
Achievement progression status: [INIT, TIED]
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Model/ModelsAchievementResponse.cs'
'ModelsAchievementUpdateRequest@cs.achievement.mod':
id: 'ModelsAchievementUpdateRequest@cs.achievement.mod'
name: 'ModelsAchievementUpdateRequest'
type: 'model'
fields:
'DefaultLanguage':
type: 'string'
required: true
'Description':
type: 'Dictionary<string, string>'
required: true
'GoalValue':
type: 'double'
required: true
'Hidden':
type: 'bool'
required: true
'Incremental':
type: 'bool'
required: true
'LockedIcons':
type: 'List<ModelsIcon>'
required: true
'Name':
type: 'Dictionary<string, string>'
required: true
'StatCode':
type: 'string'
required: true
'Tags':
type: 'List<string>'
required: true
'UnlockedIcons':
type: 'List<ModelsIcon>'
required: true
'CustomAttributes':
type: 'Dictionary<string, object>'
required: false
'Global':
type: 'bool'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Model/ModelsAchievementUpdateRequest.cs'
'ModelsAdditionalInfo@cs.achievement.mod':
id: 'ModelsAdditionalInfo@cs.achievement.mod'
name: 'ModelsAdditionalInfo'
type: 'model'
fields:
'NumberOfAchievements':
type: 'long'
required: true
'NumberOfHiddenAchievements':
type: 'long'
required: true
'NumberOfVisibleAchievements':
type: 'long'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Model/ModelsAdditionalInfo.cs'
'ModelsBulkCreatePSNEventResponse@cs.achievement.mod':
id: 'ModelsBulkCreatePSNEventResponse@cs.achievement.mod'
name: 'ModelsBulkCreatePSNEventResponse'
type: 'model'
fields:
'Data':
type: 'List<ModelsPSNEventResult>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Model/ModelsBulkCreatePSNEventResponse.cs'
'ModelsBulkCreatePSNEvents@cs.achievement.mod':
id: 'ModelsBulkCreatePSNEvents@cs.achievement.mod'
name: 'ModelsBulkCreatePSNEvents'
type: 'model'
fields:
'Data':
type: 'List<ModelsCreatePSNEvent>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Model/ModelsBulkCreatePSNEvents.cs'
'ModelsBulkUnlockAchievementRequest@cs.achievement.mod':
id: 'ModelsBulkUnlockAchievementRequest@cs.achievement.mod'
name: 'ModelsBulkUnlockAchievementRequest'
type: 'model'
fields:
'AchievementCodes':
type: 'List<string>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Model/ModelsBulkUnlockAchievementRequest.cs'
'ModelsBulkUnlockAchievementResponse@cs.achievement.mod':
id: 'ModelsBulkUnlockAchievementResponse@cs.achievement.mod'
name: 'ModelsBulkUnlockAchievementResponse'
type: 'model'
fields:
'AchievementCode':
type: 'string'
required: true
'Success':
type: 'bool'
required: true
'ErrorDetail':
type: 'ModelsErrorDetails'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Model/ModelsBulkUnlockAchievementResponse.cs'
'ModelsContributorResponse@cs.achievement.mod':
id: 'ModelsContributorResponse@cs.achievement.mod'
name: 'ModelsContributorResponse'
type: 'model'
fields:
'AchievementCode':
type: 'string'
required: true
'ContributedValue':
type: 'double'
required: true
'CreatedAt':
type: 'DateTime'
required: true
'Id':
type: 'string'
required: true
'Namespace':
type: 'string'
required: true
'UserId':
type: 'string'
required: true
'UpdatedAt':
type: 'DateTime'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Model/ModelsContributorResponse.cs'
'ModelsCreatePSNEvent@cs.achievement.mod':
id: 'ModelsCreatePSNEvent@cs.achievement.mod'
name: 'ModelsCreatePSNEvent'
type: 'model'
fields:
'Events':
type: 'List<ModelsPSNEvent>'
required: true
'ThirdPartyUserId':
type: 'string'
required: true
'UserId':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Model/ModelsCreatePSNEvent.cs'
'ModelsErrorDetails@cs.achievement.mod':
id: 'ModelsErrorDetails@cs.achievement.mod'
name: 'ModelsErrorDetails'
type: 'model'
fields:
'ErrorCode':
type: 'int'
required: true
'ErrorMessage':
type: 'string'
required: true
'ThirdPartyReferenceId':
type: 'string'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Model/ModelsErrorDetails.cs'
'ModelsGlobalAchievementResponse@cs.achievement.mod':
id: 'ModelsGlobalAchievementResponse@cs.achievement.mod'
name: 'ModelsGlobalAchievementResponse'
type: 'model'
fields:
'AchievementCode':
type: 'string'
required: true
'CreatedAt':
type: 'DateTime'
required: true
'Id':
type: 'string'
required: true
'LatestValue':
type: 'double'
required: true
'Name':
type: 'Dictionary<string, string>'
required: true
'Namespace':
type: 'string'
required: true
'Status':
type: 'int'
required: true
'AchievedAt':
type: 'DateTime'
required: false
'UpdatedAt':
type: 'DateTime'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Model/ModelsGlobalAchievementResponse.cs'
'ModelsIcon@cs.achievement.mod':
id: 'ModelsIcon@cs.achievement.mod'
name: 'ModelsIcon'
type: 'model'
fields:
'Slug':
type: 'string'
required: true
'Url':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Model/ModelsIcon.cs'
'ModelsPaginatedAchievementResponse@cs.achievement.mod':
id: 'ModelsPaginatedAchievementResponse@cs.achievement.mod'
name: 'ModelsPaginatedAchievementResponse'
type: 'model'
fields:
'Data':
type: 'List<ModelsAchievementResponse>'
required: true
'Paging':
type: 'ModelsPagination'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Model/ModelsPaginatedAchievementResponse.cs'
'ModelsPaginatedContributorResponse@cs.achievement.mod':
id: 'ModelsPaginatedContributorResponse@cs.achievement.mod'
name: 'ModelsPaginatedContributorResponse'
type: 'model'
fields:
'Data':
type: 'List<ModelsContributorResponse>'
required: true
'Paging':
type: 'ModelsPagination'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Model/ModelsPaginatedContributorResponse.cs'
'ModelsPaginatedGlobalAchievementResponse@cs.achievement.mod':
id: 'ModelsPaginatedGlobalAchievementResponse@cs.achievement.mod'
name: 'ModelsPaginatedGlobalAchievementResponse'
type: 'model'
fields:
'Data':
type: 'List<ModelsGlobalAchievementResponse>'
required: true
'Paging':
type: 'ModelsPagination'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Model/ModelsPaginatedGlobalAchievementResponse.cs'
'ModelsPaginatedTagResponse@cs.achievement.mod':
id: 'ModelsPaginatedTagResponse@cs.achievement.mod'
name: 'ModelsPaginatedTagResponse'
type: 'model'
fields:
'Data':
type: 'List<ModelsTagResponse>'
required: true
'Paging':
type: 'ModelsPagination'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Model/ModelsPaginatedTagResponse.cs'
'ModelsPaginatedUserAchievementResponse@cs.achievement.mod':
id: 'ModelsPaginatedUserAchievementResponse@cs.achievement.mod'
name: 'ModelsPaginatedUserAchievementResponse'
type: 'model'
fields:
'CountInfo':
type: 'ModelsAdditionalInfo'
required: true
'Data':
type: 'List<ModelsUserAchievementResponse>'
required: true
'Paging':
type: 'ModelsPagination'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Model/ModelsPaginatedUserAchievementResponse.cs'
'ModelsPaginatedUserContributionResponse@cs.achievement.mod':
id: 'ModelsPaginatedUserContributionResponse@cs.achievement.mod'
name: 'ModelsPaginatedUserContributionResponse'
type: 'model'
fields:
'Data':
type: 'List<ModelsUserContributionResponse>'
required: true
'Paging':
type: 'ModelsPagination'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Model/ModelsPaginatedUserContributionResponse.cs'
'ModelsPagination@cs.achievement.mod':
id: 'ModelsPagination@cs.achievement.mod'
name: 'ModelsPagination'
type: 'model'
fields:
'Next':
type: 'string'
required: true
'Previous':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Model/ModelsPagination.cs'
'ModelsPSNEvent@cs.achievement.mod':
id: 'ModelsPSNEvent@cs.achievement.mod'
name: 'ModelsPSNEvent'
type: 'model'
fields:
'DateTime':
type: 'string'
required: true
'EventData':
type: 'ModelsPSNEventData'
required: true
'EventId':
type: 'string'
required: true
'Version':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Model/ModelsPSNEvent.cs'
'ModelsPSNEventData@cs.achievement.mod':
id: 'ModelsPSNEventData@cs.achievement.mod'
name: 'ModelsPSNEventData'
type: 'model'
fields:
'EventName':
type: 'string'
required: true
'Properties':
type: 'Dictionary<string, object>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Model/ModelsPSNEventData.cs'
'ModelsPSNEventResult@cs.achievement.mod':
id: 'ModelsPSNEventResult@cs.achievement.mod'
name: 'ModelsPSNEventResult'
type: 'model'
fields:
'IsSuccess':
type: 'bool'
required: true
'ThirdPartyUserId':
type: 'string'
required: true
'ErrorDetail':
type: 'ModelsErrorDetails'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Model/ModelsPSNEventResult.cs'
'ModelsPublicAchievementResponse@cs.achievement.mod':
id: 'ModelsPublicAchievementResponse@cs.achievement.mod'
name: 'ModelsPublicAchievementResponse'
type: 'model'
fields:
'AchievementCode':
type: 'string'
required: true
'CreatedAt':
type: 'DateTime'
required: true
'Description':
type: 'string'
required: true
'Global':
type: 'bool'
required: true
'Hidden':
type: 'bool'
required: true
'Incremental':
type: 'bool'
required: true
'ListOrder':
type: 'int'
required: true
'LockedIcons':
type: 'List<ModelsIcon>'
required: true
'Name':
type: 'string'
required: true
'Namespace':
type: 'string'
required: true
'Tags':
type: 'List<string>'
required: true
'UnlockedIcons':
type: 'List<ModelsIcon>'
required: true
'UpdatedAt':
type: 'DateTime'
required: true
'CustomAttributes':
type: 'Dictionary<string, object>'
required: false
'GoalValue':
type: 'double'
required: false
'StatCode':
type: 'string'
required: false
'Status':
type: 'string'
required: false
description: |-
Achievement progression status: [INIT, TIED]
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Model/ModelsPublicAchievementResponse.cs'
'ModelsPublicAchievementsResponse@cs.achievement.mod':
id: 'ModelsPublicAchievementsResponse@cs.achievement.mod'
name: 'ModelsPublicAchievementsResponse'
type: 'model'
fields:
'Data':
type: 'List<ModelsPublicAchievementResponse>'
required: true
'Paging':
type: 'ModelsPagination'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Model/ModelsPublicAchievementsResponse.cs'
'ModelsTagResponse@cs.achievement.mod':
id: 'ModelsTagResponse@cs.achievement.mod'
name: 'ModelsTagResponse'
type: 'model'
fields:
'CreatedAt':
type: 'DateTime'
required: true
'Name':
type: 'string'
required: true
'Namespace':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Model/ModelsTagResponse.cs'
'ModelsUserAchievementResponse@cs.achievement.mod':
id: 'ModelsUserAchievementResponse@cs.achievement.mod'
name: 'ModelsUserAchievementResponse'
type: 'model'
fields:
'AchievedAt':
type: 'DateTime'
required: true
'AchievementCode':
type: 'string'
required: true
'Id':
type: 'string'
required: true
'LatestValue':
type: 'double'
required: true
'Name':
type: 'Dictionary<string, string>'
required: true
'Status':
type: 'int'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Model/ModelsUserAchievementResponse.cs'
'ModelsUserContributionResponse@cs.achievement.mod':
id: 'ModelsUserContributionResponse@cs.achievement.mod'
name: 'ModelsUserContributionResponse'
type: 'model'
fields:
'AchievementCode':
type: 'string'
required: true
'CanClaimReward':
type: 'bool'
required: true
description: |-
CanClaimReward is a flag whether the user can claim the reward of not
'ContributedValue':
type: 'double'
required: true
'Id':
type: 'string'
required: true
'Name':
type: 'Dictionary<string, string>'
required: true
description: |-
Name is achievement name
'Namespace':
type: 'string'
required: true
'UserId':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Model/ModelsUserContributionResponse.cs'
'ResponseError@cs.achievement.mod':
id: 'ResponseError@cs.achievement.mod'
name: 'ResponseError'
type: 'model'
fields:
'ErrorCode':
type: 'int'
required: true
'ErrorMessage':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Model/ResponseError.cs'
'ServiceImportConfigResponse@cs.achievement.mod':
id: 'ServiceImportConfigResponse@cs.achievement.mod'
name: 'ServiceImportConfigResponse'
type: 'model'
fields:
'FailedConfigs':
type: 'List<string>'
required: true
'IgnoredConfigs':
type: 'List<string>'
required: true
'NewConfigs':
type: 'List<string>'
required: true
'ReplacedConfigs':
type: 'List<string>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Model/ServiceImportConfigResponse.cs'
# endregion models
# region functions
'AdminAnonymizeUserAchievement@cs.achievement.fun':
id: 'AdminAnonymizeUserAchievement@cs.achievement.fun'
name: 'AdminAnonymizeUserAchievement'
type: 'function'
description: |-
This API will delete specified user achievement
Required permission
`ADMIN:NAMESPACE:{namespace}:USER:{userId}:ANONYMIZATION [DELETE]`
arguments:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'UserId':
type: 'string'
required: true
description: |-
user id
return_type: 'void'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
- 'using AccelByte.Sdk.Api.Achievement.Operation;'
- 'using AccelByte.Sdk.Api.Achievement.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Wrapper/Anonymization.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Operation/Anonymization/AdminAnonymizeUserAchievement.cs'
example: |-
try
{
var operation = sdk.Achievement.Anonymization.AdminAnonymizeUserAchievementOp
.Build();
sdk.Achievement.Anonymization.AdminAnonymizeUserAchievement(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'achievement'
- 'admin'
- 'anonymization'
- 'anonymize'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:ANONYMIZATION [DELETE]'
'AdminBulkUnlockAchievement@cs.achievement.fun':
id: 'AdminBulkUnlockAchievement@cs.achievement.fun'
name: 'AdminBulkUnlockAchievement'
type: 'function'
description: |-
Required permission
`ADMIN:NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [UPDATE]` and scope `social`
arguments:
'Body':
type: 'ModelsBulkUnlockAchievementRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'UserId':
type: 'string'
required: true
description: |-
user id
return_type: 'List<ModelsBulkUnlockAchievementResponse>'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
- 'using AccelByte.Sdk.Api.Achievement.Operation;'
- 'using AccelByte.Sdk.Api.Achievement.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Wrapper/UserAchievements.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Operation/UserAchievements/AdminBulkUnlockAchievement.cs'
example: |-
try
{
var operation = sdk.Achievement.UserAchievements.AdminBulkUnlockAchievementOp
.Build();
var response = sdk.Achievement.UserAchievements.AdminBulkUnlockAchievement(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'achievement'
- 'achievements'
- 'admin'
- 'bulk'
- 'unlock'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [UPDATE]'
scopes:
- 'social'
'AdminCreateNewAchievement@cs.achievement.fun':
id: 'AdminCreateNewAchievement@cs.achievement.fun'
name: 'AdminCreateNewAchievement'
type: 'function'
description: |-
Required permission
`ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [CREATE]` and scope `social`
Other detail info:
- achievementCode: Human readable unique code to indentify the achievement. Must be lowercase
and maximum length is 32
- incremental: If the achievement is not incremental, it does not need to store a goal value
of a stat to be unlocked.
If the achievement is incremental, it needs to set statCode and goalValue
- statCode: Selected statistic code, from the published statistic code event.Human readable unique
code to indentify the achievement. Must be lowercase and maximum length is 32
- goalValue: Statistics value required to unlock the achievement.
- defaultLanguage: localozation for achievement name and achievement description. Allowed format : en, en-US
- slug: specify the image they want to use, it can be file image name or something
to define the achievement icon.
arguments:
'Body':
type: 'ModelsAchievementRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
return_type: 'ModelsAchievementResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
- 'using AccelByte.Sdk.Api.Achievement.Operation;'
- 'using AccelByte.Sdk.Api.Achievement.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Wrapper/Achievements.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Operation/Achievements/AdminCreateNewAchievement.cs'
example: |-
try
{
var operation = sdk.Achievement.Achievements.AdminCreateNewAchievementOp
.Build();
var response = sdk.Achievement.Achievements.AdminCreateNewAchievement(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'achievement'
- 'achievements'
- 'admin'
- 'create'
- 'new'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [CREATE]'
scopes:
- 'social'
'AdminDeleteAchievement@cs.achievement.fun':
id: 'AdminDeleteAchievement@cs.achievement.fun'
name: 'AdminDeleteAchievement'
type: 'function'
description: |-
Required permission
`ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [DELETE]` and scope `social`
arguments:
'AchievementCode':
type: 'string'
required: true
description: |-
achievement code
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
return_type: 'void'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
- 'using AccelByte.Sdk.Api.Achievement.Operation;'
- 'using AccelByte.Sdk.Api.Achievement.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Wrapper/Achievements.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Operation/Achievements/AdminDeleteAchievement.cs'
example: |-
try
{
var operation = sdk.Achievement.Achievements.AdminDeleteAchievementOp
.Build();
sdk.Achievement.Achievements.AdminDeleteAchievement(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'achievement'
- 'achievements'
- 'admin'
- 'delete'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [DELETE]'
scopes:
- 'social'
'AdminGetAchievement@cs.achievement.fun':
id: 'AdminGetAchievement@cs.achievement.fun'
name: 'AdminGetAchievement'
type: 'function'
description: |-
Required permission
`ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]` and scope `social`
arguments:
'AchievementCode':
type: 'string'
required: true
description: |-
achievement code
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
return_type: 'ModelsAchievementResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
- 'using AccelByte.Sdk.Api.Achievement.Operation;'
- 'using AccelByte.Sdk.Api.Achievement.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Wrapper/Achievements.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Operation/Achievements/AdminGetAchievement.cs'
example: |-
try
{
var operation = sdk.Achievement.Achievements.AdminGetAchievementOp
.Build();
var response = sdk.Achievement.Achievements.AdminGetAchievement(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'achievement'
- 'achievements'
- 'admin'
- 'get'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]'
scopes:
- 'social'
'AdminListAchievements@cs.achievement.fun':
id: 'AdminListAchievements@cs.achievement.fun'
name: 'AdminListAchievements'
type: 'function'
description: |-
Required permission
`ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]` and scope `social`
arguments:
'Global':
type: 'bool'
required: false
description: |-
filter by global achievement flag
'Limit':
type: 'long'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Offset':
type: 'long'
required: false
description: |-
offset
'SortBy':
type: 'string'
required: false
description: |-
sort by, default is 'listOrder:asc', allow values: [listOrder, listOrder:asc, listOrder:desc, createdAt, createdAt:asc, createdAt:desc, updatedAt, updatedAt:asc, updatedAt:desc]
'Tags':
type: 'List<string>'
required: false
description: |-
tags
return_type: 'ModelsPaginatedAchievementResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
- 'using AccelByte.Sdk.Api.Achievement.Operation;'
- 'using AccelByte.Sdk.Api.Achievement.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Wrapper/Achievements.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Operation/Achievements/AdminListAchievements.cs'
example: |-
try
{
var operation = sdk.Achievement.Achievements.AdminListAchievementsOp
.SetGlobal(...)
.SetLimit(...)
.SetOffset(...)
.SetSortBy(...)
.SetTags(...)
.Build(
namespace_,
);
var response = sdk.Achievement.Achievements.AdminListAchievements(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'achievements'
- 'admin'
- 'list'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]'
scopes:
- 'social'
'AdminListGlobalAchievementContributors@cs.achievement.fun':
id: 'AdminListGlobalAchievementContributors@cs.achievement.fun'
name: 'AdminListGlobalAchievementContributors'
type: 'function'
description: |-
Required permission
`ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]` and scope `social`
arguments:
'AchievementCode':
type: 'string'
required: true
description: |-
achievement code
'Limit':
type: 'long'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Offset':
type: 'long'
required: false
description: |-
offset
'SortBy':
type: 'string'
required: false
description: |-
sort by, default is 'contributedValue:desc', allow values: [contributedValue, contributedValue:asc, contributedValue:desc]
return_type: 'ModelsPaginatedContributorResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
- 'using AccelByte.Sdk.Api.Achievement.Operation;'
- 'using AccelByte.Sdk.Api.Achievement.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Wrapper/GlobalAchievements.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Operation/GlobalAchievements/AdminListGlobalAchievementContributors.cs'
example: |-
try
{
var operation = sdk.Achievement.GlobalAchievements.AdminListGlobalAchievementContributorsOp
.SetLimit(...)
.SetOffset(...)
.SetSortBy(...)
.Build(
achievementCode,
namespace_,
);
var response = sdk.Achievement.GlobalAchievements.AdminListGlobalAchievementContributors(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'achievement'
- 'achievements'
- 'admin'
- 'contributors'
- 'global'
- 'list'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]'
scopes:
- 'social'
'AdminListGlobalAchievements@cs.achievement.fun':
id: 'AdminListGlobalAchievements@cs.achievement.fun'
name: 'AdminListGlobalAchievements'
type: 'function'
description: |-
Required permission
`ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]` and scope `social`
Note:
Global achievement status value mean: `status = 1 (in progress)` and `status = 2 (unlocked)`
arguments:
'AchievementCodes':
type: 'string'
required: false
description: |-
filter by achievement codes. multiple value separated by comma
'Limit':
type: 'long'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Offset':
type: 'long'
required: false
description: |-
offset
'SortBy':
type: 'string'
required: false
description: |-
sort by, allow values: [achievedAt, achievedAt:asc, achievedAt:desc, createdAt, createdAt:asc, createdAt:desc]
'Status':
type: 'string'
required: false
description: |-
filter by status. available value: [in_progress, unlocked]
'Tags':
type: 'List<string>'
required: false
description: |-
tags
return_type: 'ModelsPaginatedGlobalAchievementResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
- 'using AccelByte.Sdk.Api.Achievement.Operation;'
- 'using AccelByte.Sdk.Api.Achievement.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Wrapper/GlobalAchievements.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Operation/GlobalAchievements/AdminListGlobalAchievements.cs'
example: |-
try
{
var operation = sdk.Achievement.GlobalAchievements.AdminListGlobalAchievementsOp
.SetAchievementCodes(...)
.SetLimit(...)
.SetOffset(...)
.SetSortBy(...)
.SetStatus(...)
.SetTags(...)
.Build(
namespace_,
);
var response = sdk.Achievement.GlobalAchievements.AdminListGlobalAchievements(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'achievements'
- 'admin'
- 'global'
- 'list'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]'
scopes:
- 'social'
'AdminListTags@cs.achievement.fun':
id: 'AdminListTags@cs.achievement.fun'
name: 'AdminListTags'
type: 'function'
description: |-
Required permission
`ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]` and scope `social`
arguments:
'Limit':
type: 'long'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'Name':
type: 'string'
required: false
description: |-
like's query by tag name
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Offset':
type: 'long'
required: false
description: |-
offset
'SortBy':
type: 'string'
required: false
description: |-
sort by, default is 'name:asc', allow values: [name, name:asc, name:desc, createdAt, createdAt:asc, createdAt:desc]
return_type: 'ModelsPaginatedTagResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
- 'using AccelByte.Sdk.Api.Achievement.Operation;'
- 'using AccelByte.Sdk.Api.Achievement.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Wrapper/Tags.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Operation/Tags/AdminListTags.cs'
example: |-
try
{
var operation = sdk.Achievement.Tags.AdminListTagsOp
.SetLimit(...)
.SetName(...)
.SetOffset(...)
.SetSortBy(...)
.Build(
namespace_,
);
var response = sdk.Achievement.Tags.AdminListTags(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'list'
- 'tags'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]'
scopes:
- 'social'
'AdminListUserAchievements@cs.achievement.fun':
id: 'AdminListUserAchievements@cs.achievement.fun'
name: 'AdminListUserAchievements'
type: 'function'
description: |-
Required permission
`ADMIN:NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [READ]` and scope `social`
Note:
User Achievement status value mean: `status = 1 (in progress)` and `status = 2 (unlocked)`
`achievedAt` value will return default value: `0001-01-01T00:00:00Z` for user achievement that locked or in progress
arguments:
'Limit':
type: 'long'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Offset':
type: 'long'
required: false
description: |-
offset
'PreferUnlocked':
type: 'bool'
required: false
description: |-
prefer to query achieved
'SortBy':
type: 'string'
required: false
description: |-
sort by, allow values: [achievedAt, achievedAt:asc, achievedAt:desc, createdAt, createdAt:asc, createdAt:desc]
'Tags':
type: 'List<string>'
required: false
description: |-
tags
'UserId':
type: 'string'
required: true
description: |-
user id
return_type: 'ModelsPaginatedUserAchievementResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
- 'using AccelByte.Sdk.Api.Achievement.Operation;'
- 'using AccelByte.Sdk.Api.Achievement.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Wrapper/UserAchievements.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Operation/UserAchievements/AdminListUserAchievements.cs'
example: |-
try
{
var operation = sdk.Achievement.UserAchievements.AdminListUserAchievementsOp
.SetLimit(...)
.SetOffset(...)
.SetPreferUnlocked(...)
.SetSortBy(...)
.SetTags(...)
.Build(
namespace_,
userId,
);
var response = sdk.Achievement.UserAchievements.AdminListUserAchievements(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'achievements'
- 'admin'
- 'list'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [READ]'
scopes:
- 'social'
'AdminListUserContributions@cs.achievement.fun':
id: 'AdminListUserContributions@cs.achievement.fun'
name: 'AdminListUserContributions'
type: 'function'
description: |-
Required permission
`ADMIN:NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [READ]` and scope `social`
arguments:
'AchievementCodes':
type: 'string'
required: false
description: |-
achievement codes. multiple value separated by comma
'Limit':
type: 'long'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Offset':
type: 'long'
required: false
description: |-
offset
'SortBy':
type: 'string'
required: false
description: |-
sort by, default is 'contributedValue:desc', allow values: [contributedValue, contributedValue:asc, contributedValue:desc]
'Tags':
type: 'List<string>'
required: false
description: |-
tags
'UserId':
type: 'string'
required: true
description: |-
user ID
return_type: 'ModelsPaginatedUserContributionResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
- 'using AccelByte.Sdk.Api.Achievement.Operation;'
- 'using AccelByte.Sdk.Api.Achievement.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Wrapper/GlobalAchievements.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Operation/GlobalAchievements/AdminListUserContributions.cs'
example: |-
try
{
var operation = sdk.Achievement.GlobalAchievements.AdminListUserContributionsOp
.SetAchievementCodes(...)
.SetLimit(...)
.SetOffset(...)
.SetSortBy(...)
.SetTags(...)
.Build(
namespace_,
userId,
);
var response = sdk.Achievement.GlobalAchievements.AdminListUserContributions(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'achievements'
- 'admin'
- 'contributions'
- 'global'
- 'list'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [READ]'
scopes:
- 'social'
'AdminResetAchievement@cs.achievement.fun':
id: 'AdminResetAchievement@cs.achievement.fun'
name: 'AdminResetAchievement'
type: 'function'
description: |-
[TEST FACILITY ONLY]
Required permission
`ADMIN:NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [DELETE]` and scope `social`
arguments:
'AchievementCode':
type: 'string'
required: true
description: |-
achievement code
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'UserId':
type: 'string'
required: true
description: |-
user id
return_type: 'void'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
- 'using AccelByte.Sdk.Api.Achievement.Operation;'
- 'using AccelByte.Sdk.Api.Achievement.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Wrapper/UserAchievements.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Operation/UserAchievements/AdminResetAchievement.cs'
example: |-
try
{
var operation = sdk.Achievement.UserAchievements.AdminResetAchievementOp
.Build();
sdk.Achievement.UserAchievements.AdminResetAchievement(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'achievement'
- 'achievements'
- 'admin'
- 'reset'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [DELETE]'
scopes:
- 'social'
'AdminUnlockAchievement@cs.achievement.fun':
id: 'AdminUnlockAchievement@cs.achievement.fun'
name: 'AdminUnlockAchievement'
type: 'function'
description: |-
Required permission
`ADMIN:NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [UPDATE]` and scope `social`
arguments:
'AchievementCode':
type: 'string'
required: true
description: |-
achievement code
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'UserId':
type: 'string'
required: true
description: |-
user id
return_type: 'void'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
- 'using AccelByte.Sdk.Api.Achievement.Operation;'
- 'using AccelByte.Sdk.Api.Achievement.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Wrapper/UserAchievements.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Operation/UserAchievements/AdminUnlockAchievement.cs'
example: |-
try
{
var operation = sdk.Achievement.UserAchievements.AdminUnlockAchievementOp
.Build();
sdk.Achievement.UserAchievements.AdminUnlockAchievement(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'achievement'
- 'achievements'
- 'admin'
- 'unlock'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [UPDATE]'
scopes:
- 'social'
'AdminUpdateAchievement@cs.achievement.fun':
id: 'AdminUpdateAchievement@cs.achievement.fun'
name: 'AdminUpdateAchievement'
type: 'function'
description: |-
Required permission
`ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [UPDATE]` and scope `social`
arguments:
'AchievementCode':
type: 'string'
required: true
description: |-
achievement code
'Body':
type: 'ModelsAchievementUpdateRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
return_type: 'ModelsAchievementResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
- 'using AccelByte.Sdk.Api.Achievement.Operation;'
- 'using AccelByte.Sdk.Api.Achievement.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Wrapper/Achievements.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Operation/Achievements/AdminUpdateAchievement.cs'
example: |-
try
{
var operation = sdk.Achievement.Achievements.AdminUpdateAchievementOp
.Build();
var response = sdk.Achievement.Achievements.AdminUpdateAchievement(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'achievement'
- 'achievements'
- 'admin'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [UPDATE]'
scopes:
- 'social'
'AdminUpdateAchievementListOrder@cs.achievement.fun':
id: 'AdminUpdateAchievementListOrder@cs.achievement.fun'
name: 'AdminUpdateAchievementListOrder'
type: 'function'
description: |-
Required permission
`ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [UPDATE]` and scope `social`
arguments:
'AchievementCode':
type: 'string'
required: true
description: |-
achievement code
'Body':
type: 'ModelsAchievementOrderUpdateRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
return_type: 'void'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
- 'using AccelByte.Sdk.Api.Achievement.Operation;'
- 'using AccelByte.Sdk.Api.Achievement.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Wrapper/Achievements.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Operation/Achievements/AdminUpdateAchievementListOrder.cs'
example: |-
try
{
var operation = sdk.Achievement.Achievements.AdminUpdateAchievementListOrderOp
.Build();
sdk.Achievement.Achievements.AdminUpdateAchievementListOrder(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'achievement'
- 'achievements'
- 'admin'
- 'list'
- 'order'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [UPDATE]'
scopes:
- 'social'
'BulkCreatePSNEvent@cs.achievement.fun':
id: 'BulkCreatePSNEvent@cs.achievement.fun'
name: 'BulkCreatePSNEvent'
type: 'function'
description: |-
Create PSN UDS events. Player need to login first using playstation token to IAM service.
arguments:
'Body':
type: 'ModelsBulkCreatePSNEvents'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
return_type: 'ModelsBulkCreatePSNEventResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
- 'using AccelByte.Sdk.Api.Achievement.Operation;'
- 'using AccelByte.Sdk.Api.Achievement.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Wrapper/PlatformAchievement.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Operation/PlatformAchievement/BulkCreatePSNEvent.cs'
example: |-
try
{
var operation = sdk.Achievement.PlatformAchievement.BulkCreatePSNEventOp
.Build();
var response = sdk.Achievement.PlatformAchievement.BulkCreatePSNEvent(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'achievement'
- 'bulk'
- 'create'
- 'event'
- 'platform'
- 'psn'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT:PLATFORM [CREATE]'
scopes:
- 'social'
'ClaimGlobalAchievementReward@cs.achievement.fun':
id: 'ClaimGlobalAchievementReward@cs.achievement.fun'
name: 'ClaimGlobalAchievementReward'
type: 'function'
description: |-
Required permission
`NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [UPDATE]` and scope `social`
Note:
Global achievement should be unlocked to claim the reward. Only contributor of global achievement are eligible for rewards
arguments:
'AchievementCode':
type: 'string'
required: true
description: |-
achievement code
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'UserId':
type: 'string'
required: true
description: |-
user ID
return_type: 'void'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
- 'using AccelByte.Sdk.Api.Achievement.Operation;'
- 'using AccelByte.Sdk.Api.Achievement.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Wrapper/GlobalAchievements.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Operation/GlobalAchievements/ClaimGlobalAchievementReward.cs'
example: |-
try
{
var operation = sdk.Achievement.GlobalAchievements.ClaimGlobalAchievementRewardOp
.Build();
sdk.Achievement.GlobalAchievements.ClaimGlobalAchievementReward(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'achievement'
- 'achievements'
- 'claim'
- 'global'
- 'reward'
permissions:
- 'NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [UPDATE]'
scopes:
- 'social'
'ExportAchievements@cs.achievement.fun':
id: 'ExportAchievements@cs.achievement.fun'
name: 'ExportAchievements'
type: 'function'
description: |-
Required permission `ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]`
Required Scope: `social`
Successful response header will contain: `content-disposition: attachment; filename=achievement__config.json`
arguments:
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Tags':
type: 'List<string>'
required: false
description: |-
tags
return_type: 'Stream'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
- 'using AccelByte.Sdk.Api.Achievement.Operation;'
- 'using AccelByte.Sdk.Api.Achievement.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Wrapper/Achievements.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Operation/Achievements/ExportAchievements.cs'
example: |-
try
{
var operation = sdk.Achievement.Achievements.ExportAchievementsOp
.SetTags(...)
.Build(
namespace_,
);
var response = sdk.Achievement.Achievements.ExportAchievements(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'achievements'
- 'export'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]'
scopes:
- 'social'
'ImportAchievements@cs.achievement.fun':
id: 'ImportAchievements@cs.achievement.fun'
name: 'ImportAchievements'
type: 'function'
description: |-
Required permission ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [UPDATE]
Required Scope: social
Import achievement configuration from file. It will merge with existing achievement.
Available import strategy:
- leaveOut: if achievement with same key exist, the existing will be used and imported one will be ignored (default)
- replace: if achievement with same key exist, the imported achievement will be used and existing one will be removed
arguments:
'File':
type: 'Stream'
required: false
description: |-
file to be imported
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Strategy':
type: 'string'
required: false
description: |-
strategy for import
return_type: 'ServiceImportConfigResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
- 'using AccelByte.Sdk.Api.Achievement.Operation;'
- 'using AccelByte.Sdk.Api.Achievement.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Wrapper/Achievements.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Operation/Achievements/ImportAchievements.cs'
example: |-
try
{
var operation = sdk.Achievement.Achievements.ImportAchievementsOp
.SetFile(...)
.SetStrategy(...)
.Build(
namespace_,
);
var response = sdk.Achievement.Achievements.ImportAchievements(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'achievements'
- 'import'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [UPDATE]'
scopes:
- 'social'
'ListGlobalAchievementContributors@cs.achievement.fun':
id: 'ListGlobalAchievementContributors@cs.achievement.fun'
name: 'ListGlobalAchievementContributors'
type: 'function'
description: |-
Required permission
`NAMESPACE:{namespace}:ACHIEVEMENT [READ]` and scope `social`
arguments:
'AchievementCode':
type: 'string'
required: true
description: |-
achievement code
'Limit':
type: 'long'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Offset':
type: 'long'
required: false
description: |-
offset
'SortBy':
type: 'string'
required: false
description: |-
sort by, default is 'contributedValue:desc', allow values: [contributedValue, contributedValue:asc, contributedValue:desc]
return_type: 'ModelsPaginatedContributorResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
- 'using AccelByte.Sdk.Api.Achievement.Operation;'
- 'using AccelByte.Sdk.Api.Achievement.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Wrapper/GlobalAchievements.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Operation/GlobalAchievements/ListGlobalAchievementContributors.cs'
example: |-
try
{
var operation = sdk.Achievement.GlobalAchievements.ListGlobalAchievementContributorsOp
.SetLimit(...)
.SetOffset(...)
.SetSortBy(...)
.Build(
achievementCode,
namespace_,
);
var response = sdk.Achievement.GlobalAchievements.ListGlobalAchievementContributors(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'achievement'
- 'achievements'
- 'contributors'
- 'global'
- 'list'
permissions:
- 'NAMESPACE:{namespace}:ACHIEVEMENT [READ]'
scopes:
- 'social'
'ListUserContributions@cs.achievement.fun':
id: 'ListUserContributions@cs.achievement.fun'
name: 'ListUserContributions'
type: 'function'
description: |-
Required permission
`NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [READ]` and scope `social`
arguments:
'AchievementCodes':
type: 'string'
required: false
description: |-
achievement codes. multiple value separated by comma
'Limit':
type: 'long'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Offset':
type: 'long'
required: false
description: |-
offset
'SortBy':
type: 'string'
required: false
description: |-
sort by, default is 'contributedValue:desc', allow values: [contributedValue, contributedValue:asc, contributedValue:desc]
'Tags':
type: 'List<string>'
required: false
description: |-
tags
'UserId':
type: 'string'
required: true
description: |-
user ID
return_type: 'ModelsPaginatedUserContributionResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
- 'using AccelByte.Sdk.Api.Achievement.Operation;'
- 'using AccelByte.Sdk.Api.Achievement.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Wrapper/GlobalAchievements.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Operation/GlobalAchievements/ListUserContributions.cs'
example: |-
try
{
var operation = sdk.Achievement.GlobalAchievements.ListUserContributionsOp
.SetAchievementCodes(...)
.SetLimit(...)
.SetOffset(...)
.SetSortBy(...)
.SetTags(...)
.Build(
namespace_,
userId,
);
var response = sdk.Achievement.GlobalAchievements.ListUserContributions(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'achievements'
- 'contributions'
- 'global'
- 'list'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [READ]'
scopes:
- 'social'
'PublicBulkUnlockAchievement@cs.achievement.fun':
id: 'PublicBulkUnlockAchievement@cs.achievement.fun'
name: 'PublicBulkUnlockAchievement'
type: 'function'
description: |-
Required permission
`NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [UPDATE]` and scope `social`
arguments:
'Body':
type: 'ModelsBulkUnlockAchievementRequest'
required: true
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'UserId':
type: 'string'
required: true
description: |-
user id
return_type: 'List<ModelsBulkUnlockAchievementResponse>'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
- 'using AccelByte.Sdk.Api.Achievement.Operation;'
- 'using AccelByte.Sdk.Api.Achievement.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Wrapper/UserAchievements.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Operation/UserAchievements/PublicBulkUnlockAchievement.cs'
example: |-
try
{
var operation = sdk.Achievement.UserAchievements.PublicBulkUnlockAchievementOp
.Build();
var response = sdk.Achievement.UserAchievements.PublicBulkUnlockAchievement(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'achievement'
- 'achievements'
- 'bulk'
- 'public'
- 'unlock'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [UPDATE]'
scopes:
- 'social'
'PublicGetAchievement@cs.achievement.fun':
id: 'PublicGetAchievement@cs.achievement.fun'
name: 'PublicGetAchievement'
type: 'function'
description: |-
Required permission
`NAMESPACE:{namespace}:ACHIEVEMENT [READ]` and scope `social`
arguments:
'AchievementCode':
type: 'string'
required: true
description: |-
achievement code
'Language':
type: 'string'
required: true
description: |-
language, if the selected language not exist in achievement,it use default language
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
return_type: 'ModelsPublicAchievementResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
- 'using AccelByte.Sdk.Api.Achievement.Operation;'
- 'using AccelByte.Sdk.Api.Achievement.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Wrapper/Achievements.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Operation/Achievements/PublicGetAchievement.cs'
example: |-
try
{
var operation = sdk.Achievement.Achievements.PublicGetAchievementOp
.Build();
var response = sdk.Achievement.Achievements.PublicGetAchievement(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'achievement'
- 'achievements'
- 'get'
- 'public'
permissions:
- 'NAMESPACE:{namespace}:ACHIEVEMENT [READ]'
scopes:
- 'social'
'PublicListAchievements@cs.achievement.fun':
id: 'PublicListAchievements@cs.achievement.fun'
name: 'PublicListAchievements'
type: 'function'
description: |-
Required permission
`NAMESPACE:{namespace}:ACHIEVEMENT [READ]` and scope `social`
arguments:
'Global':
type: 'bool'
required: false
description: |-
filter by global achievement flag
'Language':
type: 'string'
required: true
description: |-
language, if the selected language not exist in achievement,it use default language
'Limit':
type: 'long'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Offset':
type: 'long'
required: false
description: |-
offset
'SortBy':
type: 'string'
required: false
description: |-
sort by, default is 'listOrder:asc', allow values: [listOrder, listOrder:asc, listOrder:desc, createdAt, createdAt:asc, createdAt:desc, updatedAt, updatedAt:asc, updatedAt:desc]
'Tags':
type: 'List<string>'
required: false
description: |-
tags
return_type: 'ModelsPublicAchievementsResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
- 'using AccelByte.Sdk.Api.Achievement.Operation;'
- 'using AccelByte.Sdk.Api.Achievement.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Wrapper/Achievements.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Operation/Achievements/PublicListAchievements.cs'
example: |-
try
{
var operation = sdk.Achievement.Achievements.PublicListAchievementsOp
.SetGlobal(...)
.SetLimit(...)
.SetOffset(...)
.SetSortBy(...)
.SetTags(...)
.Build(
language,
namespace_,
);
var response = sdk.Achievement.Achievements.PublicListAchievements(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'achievements'
- 'list'
- 'public'
permissions:
- 'NAMESPACE:{namespace}:ACHIEVEMENT [READ]'
scopes:
- 'social'
'PublicListGlobalAchievements@cs.achievement.fun':
id: 'PublicListGlobalAchievements@cs.achievement.fun'
name: 'PublicListGlobalAchievements'
type: 'function'
description: |-
Required permission
`NAMESPACE:{namespace}:ACHIEVEMENT [READ]` and scope `social`
Note:
Global achievement status value mean: `status = 1 (in progress)` and `status = 2 (unlocked)`
arguments:
'AchievementCodes':
type: 'string'
required: false
description: |-
filter by achievement codes. multiple value separated by comma
'Limit':
type: 'long'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Offset':
type: 'long'
required: false
description: |-
offset
'SortBy':
type: 'string'
required: false
description: |-
sort by, allow values: [achievedAt, achievedAt:asc, achievedAt:desc, createdAt, createdAt:asc, createdAt:desc]
'Status':
type: 'string'
required: false
description: |-
filter by status. available value: [in_progress, unlocked]
'Tags':
type: 'List<string>'
required: false
description: |-
tags
return_type: 'ModelsPaginatedGlobalAchievementResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
- 'using AccelByte.Sdk.Api.Achievement.Operation;'
- 'using AccelByte.Sdk.Api.Achievement.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Wrapper/GlobalAchievements.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Operation/GlobalAchievements/PublicListGlobalAchievements.cs'
example: |-
try
{
var operation = sdk.Achievement.GlobalAchievements.PublicListGlobalAchievementsOp
.SetAchievementCodes(...)
.SetLimit(...)
.SetOffset(...)
.SetSortBy(...)
.SetStatus(...)
.SetTags(...)
.Build(
namespace_,
);
var response = sdk.Achievement.GlobalAchievements.PublicListGlobalAchievements(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'achievements'
- 'global'
- 'list'
- 'public'
permissions:
- 'NAMESPACE:{namespace}:ACHIEVEMENT [READ]'
scopes:
- 'social'
'PublicListTags@cs.achievement.fun':
id: 'PublicListTags@cs.achievement.fun'
name: 'PublicListTags'
type: 'function'
description: |-
Required permission
`NAMESPACE:{namespace}:ACHIEVEMENT [READ]` and scope `social`
arguments:
'Limit':
type: 'long'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'Name':
type: 'string'
required: false
description: |-
like's query by tag name
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Offset':
type: 'long'
required: false
description: |-
offset
'SortBy':
type: 'string'
required: false
description: |-
sort by, default is 'name:asc', allow values: [name, name:asc, name:desc, createdAt, createdAt:asc, createdAt:desc]
return_type: 'ModelsPaginatedTagResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
- 'using AccelByte.Sdk.Api.Achievement.Operation;'
- 'using AccelByte.Sdk.Api.Achievement.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Wrapper/Tags.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Operation/Tags/PublicListTags.cs'
example: |-
try
{
var operation = sdk.Achievement.Tags.PublicListTagsOp
.SetLimit(...)
.SetName(...)
.SetOffset(...)
.SetSortBy(...)
.Build(
namespace_,
);
var response = sdk.Achievement.Tags.PublicListTags(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'list'
- 'public'
- 'tags'
permissions:
- 'NAMESPACE:{namespace}:ACHIEVEMENT [READ]'
scopes:
- 'social'
'PublicListUserAchievements@cs.achievement.fun':
id: 'PublicListUserAchievements@cs.achievement.fun'
name: 'PublicListUserAchievements'
type: 'function'
description: |-
Required permission
`NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [READ]` and scope `social`
Note:
User Achievement status value mean: `status = 1 (in progress)` and `status = 2 (unlocked)`
`achievedAt` value will return default value: `0001-01-01T00:00:00Z` for user achievement that locked or in progress
arguments:
'Limit':
type: 'long'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'Offset':
type: 'long'
required: false
description: |-
offset
'PreferUnlocked':
type: 'bool'
required: false
description: |-
prefer to query achieved
'SortBy':
type: 'string'
required: false
description: |-
sort by, allow values: [achievedAt, achievedAt:asc, achievedAt:desc, createdAt, createdAt:asc, createdAt:desc]
'Tags':
type: 'List<string>'
required: false
description: |-
tags
'UserId':
type: 'string'
required: true
description: |-
user id
return_type: 'ModelsPaginatedUserAchievementResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
- 'using AccelByte.Sdk.Api.Achievement.Operation;'
- 'using AccelByte.Sdk.Api.Achievement.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Wrapper/UserAchievements.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Operation/UserAchievements/PublicListUserAchievements.cs'
example: |-
try
{
var operation = sdk.Achievement.UserAchievements.PublicListUserAchievementsOp
.SetLimit(...)
.SetOffset(...)
.SetPreferUnlocked(...)
.SetSortBy(...)
.SetTags(...)
.Build(
namespace_,
userId,
);
var response = sdk.Achievement.UserAchievements.PublicListUserAchievements(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'achievements'
- 'list'
- 'public'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [READ]'
scopes:
- 'social'
'PublicUnlockAchievement@cs.achievement.fun':
id: 'PublicUnlockAchievement@cs.achievement.fun'
name: 'PublicUnlockAchievement'
type: 'function'
description: |-
Required permission
`NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [UPDATE]` and scope `social`
arguments:
'AchievementCode':
type: 'string'
required: true
description: |-
achievement code
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
'UserId':
type: 'string'
required: true
description: |-
user id
return_type: 'void'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
- 'using AccelByte.Sdk.Api.Achievement.Operation;'
- 'using AccelByte.Sdk.Api.Achievement.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Wrapper/UserAchievements.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Operation/UserAchievements/PublicUnlockAchievement.cs'
example: |-
try
{
var operation = sdk.Achievement.UserAchievements.PublicUnlockAchievementOp
.Build();
sdk.Achievement.UserAchievements.PublicUnlockAchievement(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'achievement'
- 'achievements'
- 'public'
- 'unlock'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [UPDATE]'
scopes:
- 'social'
'ResetGlobalAchievement@cs.achievement.fun':
id: 'ResetGlobalAchievement@cs.achievement.fun'
name: 'ResetGlobalAchievement'
type: 'function'
description: |-
[TEST FACILITY ONLY]
Required permission
`ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [DELETE]` and scope `social`
arguments:
'AchievementCode':
type: 'string'
required: true
description: |-
achievement code
'Namespace':
type: 'string'
required: true
description: |-
namespace of the game
return_type: 'void'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Achievement.Model;'
- 'using AccelByte.Sdk.Api.Achievement.Operation;'
- 'using AccelByte.Sdk.Api.Achievement.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Wrapper/GlobalAchievements.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Achievement/Operation/GlobalAchievements/ResetGlobalAchievement.cs'
example: |-
try
{
var operation = sdk.Achievement.GlobalAchievements.ResetGlobalAchievementOp
.Build();
sdk.Achievement.GlobalAchievements.ResetGlobalAchievement(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'achievement'
- 'achievements'
- 'global'
- 'reset'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [DELETE]'
scopes:
- 'social'
# endregion functions
