Class CopilotAchievementScript
One achievement's Copilot walkthrough: its field-by-field paste instructions and its icon uploads.
Inherited Members
Namespace: Serenity.Achievements.Application.Sync
Assembly: Serenity.Achievements.Application.dll
Syntax
public sealed class CopilotAchievementScriptRemarks
Built by AchievementCopilotScript. See that type's remarks for the gating contract.
Constructors
CopilotAchievementScript(Fields)
Creates an achievement script.
Declaration
public CopilotAchievementScript(CopilotAchievementScript.Fields fields)Parameters
| Type | Name | Description |
|---|---|---|
| CopilotAchievementScript.Fields | fields | The values to build it from. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | When no fields were given. |
Properties
ApiName
Declaration
public string ApiName { get; }Property Value
| Type | Description |
|---|---|
| string | The achievement's platform-side identity key. |
Icons
Declaration
public IReadOnlyList<CopilotIconInstruction> Icons { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyList<CopilotIconInstruction> | The icon uploads this achievement needs, in the same order a push would send them. |
Instructions
Declaration
public IReadOnlyList<CopilotFieldInstruction> Instructions { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyList<CopilotFieldInstruction> | The field-by-field paste instructions, in the same order a push would send them. |
IsNew
Declaration
public bool IsNew { get; }Property Value
| Type | Description |
|---|---|
| bool | Whether this achievement does not exist on the platform yet. |
TotalStepCount
Declaration
public int TotalStepCount { get; }Property Value
| Type | Description |
|---|---|
| int | How many fields and icons this achievement's walkthrough asks the author to act on. |