core_v2_leaderboardLookup Property Template

Ben Tiedt — Fri, 23 Apr 2021 19:57:39 GMT

Current Revision posted to API Documentation by Ben Tiedt on 04/23/2021 19:57:39

Enables leaderboard selection using type-ahead search. Represents selections as a querystring or comma-separated values.

Supported Data Types

custom

Scripted Extension Configuration XML

<property id="propertyId" labelResourceName="nameResource" descriptionResourceName="descriptionResource" dataType="custom" template="core_v2_leaderboardLookup" enableCurrent="true" maxSelections="1" format="query" />

Plugin Configuration C#

var property = new Property
{
	Id = "propertyId",
	LabelResourceName = "nameResource",
	DescriptionResourceName = "descriptionResource",
	DataType = "custom",
	Template = "core_v2_leaderboardLookup",
	Options = new NameValueCollection
	{
		{ "enableCurrent", "true" },
		{ "maxSelections", "1" },
		{ "format", "query" }
	}
};

Options

Name	Description	Default	Options
enableCurrent	When true, enables curent leaderboard selection (represented with an ID of -1).	true	true, false
maxSelections	The number of leaderboards that can be selected.	1
format	Identifies whether to serialize selected values as a querystring (Leaderboard=ID&Leaderboard=ID&...) or comma-seperated list (ID,ID,ID,..).	query	query, csv