Struct LeaderboardSubmission

Input for submitting a new score to a leaderboard.

Inherited Members
Namespace: Serenity.Leaderboard.Application.DTO
Assembly: Serenity.Leaderboard.Application.dll
Syntax
public readonly struct LeaderboardSubmission

Constructors

LeaderboardSubmission(BoardId, PlayerId, string, double, long, string)

Creates a new LeaderboardSubmission with the specified data.

Declaration
public LeaderboardSubmission(BoardId board, PlayerId player, string displayName, double value, long achievedAtUtcTicks, string metadata)
Parameters
Type Name Description
BoardId board

The board to submit to.
PlayerId player

The player submitting the score.
string displayName

The display name to record for this submission.
double value

The achieved metric value.
long achievedAtUtcTicks

The UTC timestamp (in ticks) at which this value was achieved. Zero means unset.
string metadata

Optional free-form metadata. May be null.

Fields

AchievedAtUtcTicks

The UTC timestamp (in ticks) at which this value was achieved. Zero means unset: the Infrastructure layer (or the service, as a fallback) stamps the current UTC time.

Declaration
public readonly long AchievedAtUtcTicks
Field Value
Type Description
long

Board

The board to submit to.

Declaration
public readonly BoardId Board
Field Value
Type Description
BoardId

DisplayName

The display name to record for this submission.

Declaration
public readonly string DisplayName
Field Value
Type Description
string

Metadata

Optional free-form metadata associated with this submission. May be null.

Declaration
public readonly string Metadata
Field Value
Type Description
string

Player

The player submitting the score.

Declaration
public readonly PlayerId Player
Field Value
Type Description
PlayerId

Value

The achieved metric value.

Declaration
public readonly double Value
Field Value
Type Description
double

Methods

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides