Class ResetConfig

Configuration for automatic scheduled resets to apply to the leaderboard.

Inheritance

object

ResetConfig

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.Apis.Admin.Leaderboards

Assembly: Unity.Services.Apis.dll

Syntax

[DataContract(Name = "ResetConfig")]
[Preserve]
public class ResetConfig

Constructors

ResetConfig(DateTime, string, bool)

Initializes a new instance of the ResetConfig class.

Declaration

[Preserve]
public ResetConfig(DateTime start = default, string schedule = null, bool archive = false)

Parameters

Type	Name	Description
DateTime	start	The date and time that the first reset should occur, formatted according to the <a href='https://www.rfc-editor.org/rfc/rfc3339#section-5.8'>RFC-3339 specification</a>. If start is provided without a schedule, then a one-off reset will occur at the date and time specified by start. The date and time specified by start must be later that the time of the request. Accuracy of the start date and time is maintained to the minute. (required).
string	schedule	The schedule on which to reset the leaderboard. Can be either a valid five-element cron tab or a cron string using @every shorthand (see <a href='https://pkg.go.dev/github.com/robfig/cron'>Cron Package Specifications</a> for details), e.g. "@every 72h" for a leaderboard reset every three days. The schedule will be applied after the first reset specified by start. The schedule can not be more frequent than once per minute. .
bool	archive	Whether or not to archive the current set of scores before resetting the leaderboard.

Properties

Archive

Whether or not to archive the current set of scores before resetting the leaderboard

Declaration

[DataMember(Name = "archive", EmitDefaultValue = true)]
[Preserve]
public bool Archive { get; set; }

Property Value

Type	Description
bool	Whether or not to archive the current set of scores before resetting the leaderboard

Schedule

The schedule on which to reset the leaderboard. Can be either a valid five-element cron tab or a cron string using @every shorthand (see <a href='https://pkg.go.dev/github.com/robfig/cron'>Cron Package Specifications</a> for details), e.g. "@every 72h" for a leaderboard reset every three days. The schedule will be applied after the first reset specified by start. The schedule can not be more frequent than once per minute.

Declaration

[DataMember(Name = "schedule", EmitDefaultValue = false)]
[Preserve]
public string Schedule { get; set; }

Property Value

Type

Description

string

The schedule on which to reset the leaderboard. Can be either a valid five-element cron tab or a cron string using @every shorthand (see <a href='https://pkg.go.dev/github.com/robfig/cron'>Cron Package Specifications</a> for details), e.g. "@every 72h" for a leaderboard reset every three days. The schedule will be applied after the first reset specified by start. The schedule can not be more frequent than once per minute.

Start

The date and time that the first reset should occur, formatted according to the <a href='https://www.rfc-editor.org/rfc/rfc3339#section-5.8'>RFC-3339 specification</a>. If start is provided without a schedule, then a one-off reset will occur at the date and time specified by start. The date and time specified by start must be later that the time of the request. Accuracy of the start date and time is maintained to the minute.

Declaration

[DataMember(Name = "start", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public DateTime Start { get; set; }

Property Value

Type

Description

DateTime

The date and time that the first reset should occur, formatted according to the <a href='https://www.rfc-editor.org/rfc/rfc3339#section-5.8'>RFC-3339 specification</a>. If start is provided without a schedule, then a one-off reset will occur at the date and time specified by start. The date and time specified by start must be later that the time of the request. Accuracy of the start date and time is maintained to the minute.