LeaderboardCreateOptions In-Process API Supplementary Type

LeaderboardCreateOptions is defined in the Telligent.Evolution.Extensibility.Api.Version1 namespace of Telligent.Evolution.Platform.dll

Definition

class LeaderboardCreateOptions
{
	string ApplicationKey { get; set;  }
	Guid? ContainerId { get; set;  }
	string Description { get; set;  }
	DateTime? EndDate { get; set;  }
	DateTime? EndDisplayDate { get; set;  }
	IList<int> ExcludeRolesFilter { get; set;  }
	IList<int> IncludeRolesFilter { get; set;  }
	string PeriodType { get; set;  }
	DateTime? StartDate { get; set;  }
	DateTime? StartDisplayDate { get; set;  }
	string TimeSpanType { get; set;  }
	int? TimeSpanValue { get; set;  }
}

Properties

Name	Type	Description
ApplicationKey	`string`	ApplicationKey for url. Optional.
ContainerId	`Guid?`	Filter by Container. Optional.
Description	`string`	Accompanying text field for the leaderboard, allowing HTML. Optional.
EndDate	`DateTime?`	Filter to points earned before this date. Either StartDate + EndDate or TimeSpanValue + TimeSpanType are required, but not both.
EndDisplayDate	`DateTime?`	Only show the leaderboard on the site before this date. Optional, defaults to EndDate.
ExcludeRolesFilter	`IList<int>`	Comma separated list of Site RoleIds. Used to limit the leaders for the leaderboard. Only users who are not assigned the provided site roles will be eligable to be on the leaderboard.
IncludeRolesFilter	`IList<int>`	Comma separated list of Site RoleIds. Used to limit the leaders for the leaderboard. Only users assigned the provided site roles will be eligable to be on the leaderboard.
PeriodType	`string`	Time period type (AllTime, Static, Rolling). Optional but recommended.
StartDate	`DateTime?`	Filter to points earned after this date. Either StartDate + EndDate or TimeSpanValue + TimeSpanType are required, but not both.
StartDisplayDate	`DateTime?`	Only show the leaderboard on the site after this date. Optional, defaults to StartDate.
TimeSpanType	`string`	Type of time span (Day, Month, Year). Either StartDate + EndDate or TimeSpanValue + TimeSpanType are required, but not both.
TimeSpanValue	`int?`	Number of [TimeSpanType] to use as the rolling window. Either StartDate + EndDate or TimeSpanValue + TimeSpanType are required, but not both.

Recommended