Class AchievementSyncCapabilities.Fields

The values one capabilities set is built from, named rather than positional.

Inheritance

object

AchievementSyncCapabilities.Fields

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 AchievementSyncCapabilities.Fields

Constructors

Fields()

Declaration

public Fields()

Fields

CanCreateOnPlatform

Whether pushing a local-only achievement creates it on the platform.

Declaration

public bool CanCreateOnPlatform

Field Value

Type	Description
bool

CanDeleteOnPlatform

Whether the connector can remove an achievement from the platform.

Declaration

public bool CanDeleteOnPlatform

Field Value

Type	Description
bool

CanPull

Whether the connector can read achievement definitions back from the platform.

Declaration

public bool CanPull

Field Value

Type	Description
bool

CanPush

Whether the connector can send achievement definitions to the platform.

Declaration

public bool CanPush

Field Value

Type	Description
bool

IconRequirement

Which icons the platform requires before it will accept a pushed achievement.

Declaration

public AchievementIconRequirement IconRequirement

Field Value

Type	Description
AchievementIconRequirement

LocaleAliases

For a locale code the platform names, the other codes a project may spell the same language with (for example zh-CN to zh-Hans), so a project that has the language under another code is not offered a duplicate of it.

Declaration

public IReadOnlyDictionary<string, IReadOnlyList<string>> LocaleAliases

Field Value

Type	Description
IReadOnlyDictionary<string, IReadOnlyList<string>>

LocaleDisplayNames

The name the platform gives each language it takes, keyed by locale code (for example fr to French), so a review can say which language it means. A locale with no name here is shown by its code.

Declaration

public IReadOnlyDictionary<string, string> LocaleDisplayNames

Field Value

Type	Description
IReadOnlyDictionary<string, string>

PlatformLanguageLocaleCodes

Every locale code the platform has a language for, whatever this run is scoped to, or empty when the platform's languages are not known. Unlike SupportedLocaleCodes it is never narrowed to the run's scope, which is what lets a project language the platform has no counterpart for be named as one whose text will not be sent.

Declaration

public IReadOnlyList<string> PlatformLanguageLocaleCodes

Field Value

Type	Description
IReadOnlyList<string>

PullableFields

The fields a pull can read. Empty means the connector cannot pull any field.

Declaration

public IReadOnlyList<AchievementSyncFieldKind> PullableFields

Field Value

Type	Description
IReadOnlyList<AchievementSyncFieldKind>

PushableFields

The fields a push can send. Empty means the connector cannot push any field.

Declaration

public IReadOnlyList<AchievementSyncFieldKind> PushableFields

Field Value

Type	Description
IReadOnlyList<AchievementSyncFieldKind>

RequiresManualPublish

Whether a pushed change still needs a manual publish step on the platform's own portal.

Declaration

public bool RequiresManualPublish

Field Value

Type	Description
bool

RequiresSignIn

Whether the connector needs an interactive sign-in before it can pull or push.

Declaration

public bool RequiresSignIn

Field Value

Type	Description
bool

StoredIconDescription

How the platform keeps an icon it was sent, in words an author reads after "the storefront keeps" (for example a recompressed JPEG copy of what was uploaded); empty when the connector says nothing.

Declaration

public string StoredIconDescription

Field Value

Type	Description
string

SupportedLocaleCodes

The locale codes the platform accepts, or empty when the platform imposes no locale restriction of its own.

Declaration

public IReadOnlyList<string> SupportedLocaleCodes

Field Value

Type	Description
IReadOnlyList<string>