Class FileAchievementDefinitionSyncConnector

A sync connector backed by a JSON file on disk instead of a live storefront API — the only connector this PR ships, and a permanent import path afterwards.

Inheritance
object
FileAchievementDefinitionSyncConnector
Implements
Inherited Members
Namespace: Serenity.Achievements.Infrastructure.Editor.Sync
Assembly: Serenity.UnityAchievements.Infrastructure.Editor.dll
Syntax
public sealed class FileAchievementDefinitionSyncConnector : IAchievementDefinitionSyncConnector
Remarks

Ships ahead of any network connector on purpose: the Achievement Platform Sync wizard's Pull flow, review UI and apply writer all need something real to drive them through end to end, and a file a user can hand-author or export from AchievementStorefrontSnapshotJson is the safest possible thing to run that flow against before a Steam HTTP connector lands. Capabilities is deliberately honest about being read-only: PushAsync(AchievementPushBatch, IProgress<AchievementSyncProgress>, CancellationToken) always fails, and no field is listed as pushable.

Constructors

FileAchievementDefinitionSyncConnector(string, AchievementPlatformKind, string)

Creates a connector that reads one snapshot file.

Declaration
public FileAchievementDefinitionSyncConnector(string filePath, AchievementPlatformKind platform, string displayName)
Parameters
Type Name Description
string filePath

The JSON file to read, in AchievementStorefrontSnapshotJson shape.
AchievementPlatformKind platform

The storefront this file's snapshot represents.
string displayName

The human-readable name shown for this connector in the sync window.

Properties

Capabilities

Declaration
public AchievementSyncCapabilities Capabilities { get; }
Property Value
Type Description
AchievementSyncCapabilities

DisplayName

Declaration
public string DisplayName { get; }
Property Value
Type Description
string

Platform

Declaration
public AchievementPlatformKind Platform { get; }
Property Value
Type Description
AchievementPlatformKind

Methods

CheckConnectionAsync(CancellationToken)

Declaration
public Task<AchievementSyncConnectionCheck> CheckConnectionAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<AchievementSyncConnectionCheck>

DownloadIconAsync(AchievementStorefrontIcon, CancellationToken)

Declaration
public Task<AchievementIconDownload> DownloadIconAsync(AchievementStorefrontIcon icon, CancellationToken cancellationToken)
Parameters
Type Name Description
AchievementStorefrontIcon icon
CancellationToken cancellationToken
Returns
Type Description
Task<AchievementIconDownload>

PullSnapshotAsync(CancellationToken)

Declaration
public Task<AchievementStorefrontSnapshot> PullSnapshotAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<AchievementStorefrontSnapshot>

PushAsync(AchievementPushBatch, IProgress<AchievementSyncProgress>, CancellationToken)

Declaration
public Task<AchievementPushOutcome> PushAsync(AchievementPushBatch batch, IProgress<AchievementSyncProgress> progress, CancellationToken cancellationToken)
Parameters
Type Name Description
AchievementPushBatch batch
IProgress<AchievementSyncProgress> progress
CancellationToken cancellationToken
Returns
Type Description
Task<AchievementPushOutcome>

Implements