Class AchievementSyncConnectionCheck

The result of asking a connector whether it can currently reach its platform.

Inheritance
object
AchievementSyncConnectionCheck
Inherited Members
Namespace: Serenity.Achievements.Application.Sync
Assembly: Serenity.Achievements.Application.dll
Syntax
public sealed class AchievementSyncConnectionCheck

Constructors

AchievementSyncConnectionCheck(bool, string, int, string, bool)

Creates a connection check result.

Declaration
public AchievementSyncConnectionCheck(bool isConnected, string summary, int visibleAchievementCount, string failureReason, bool authenticationExpired = false)
Parameters
Type Name Description
bool isConnected

Whether the connector reached the platform.
string summary

A one-line human-readable summary, ready for a status label.
int visibleAchievementCount

How many achievements are visible on the platform.
string failureReason

Why the connection failed, or empty when it succeeded.
bool authenticationExpired

Whether the platform turned the connector away because its sign-in ran out, so signing in again would help.

Properties

AuthenticationExpired

Declaration
public bool AuthenticationExpired { get; }
Property Value
Type Description
bool

Whether the platform turned the connector away because its sign-in ran out, so signing in again would help.

FailureReason

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

Why the connection failed, or empty when it succeeded.

IsConnected

Declaration
public bool IsConnected { get; }
Property Value
Type Description
bool

Whether the connector reached the platform.

Summary

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

A one-line human-readable summary, ready for a status label.

VisibleAchievementCount

Declaration
public int VisibleAchievementCount { get; }
Property Value
Type Description
int

How many achievements are visible on the platform.