Class CopilotIconInstruction

One icon a Copilot walkthrough asks the author to upload by hand: which achievement, which icon, the same bytes a push would have sent, and the file name a Copilot bundle export suggests for it.

Inheritance

object

CopilotIconInstruction

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Namespace: Serenity.Achievements.Application.Sync

Assembly: Serenity.Achievements.Application.dll

Syntax

public sealed class CopilotIconInstruction

Remarks

Carries the already-encoded AchievementIconPayload a push produced rather than a fresh re-encode — see AchievementCopilotScript. Only ever built for an icon whose field change was accepted AND that carries bytes; an unaccepted icon produces no instruction at all, the same gating AchievementPushPlanExecutor already applies to a real push.

Constructors

CopilotIconInstruction(string, CopilotIconKind, AchievementIconPayload, string)

Creates an icon instruction.

Declaration

public CopilotIconInstruction(string apiName, CopilotIconKind kind, AchievementIconPayload icon, string suggestedFileName)

Parameters

Type	Name	Description
string	apiName	The achievement's platform-side identity key.
CopilotIconKind	kind	Which of the achievement's two icons this instruction is for.
AchievementIconPayload	icon	The icon payload to upload, carrying the same PNG bytes a push would send.
string	suggestedFileName	The file name a Copilot bundle export suggests for this icon.

Exceptions

Type	Condition
ArgumentNullException	When no icon payload was given.

Properties

ApiName

Declaration

public string ApiName { get; }

Property Value

Type	Description
string	The achievement's platform-side identity key.

Icon

Declaration

public AchievementIconPayload Icon { get; }

Property Value

Type	Description
AchievementIconPayload	The icon payload to upload, carrying the same PNG bytes a push would send.

Kind

Declaration

public CopilotIconKind Kind { get; }

Property Value

Type	Description
CopilotIconKind	Which of the achievement's two icons this instruction is for.

SuggestedFileName

Declaration

public string SuggestedFileName { get; }

Property Value

Type	Description
string	The file name a Copilot bundle export suggests for this icon.