Leaderboard Script API Type

Content created on the site must implement this interface for the social services to support it.

Properties

Name	Access	Type	Description
ApplicationId	Read, Write	`Guid`	A Guid uniquely identifying the application.
ApplicationKey	Read, Write	`String`	Application Key
ContainerId	Read, Write	`Nullable of Guid`	Container Id
ContentId	Read, Write	`Guid`	A Guid uniquely identifying the content.
ContentTypeId	Read	`Guid`	A Guid identifying the type of content. All content of the same type (i.e. wiki page) will have the same value here.
CreatedDate	Read, Write	`DateTime`	The date the content was created.
EndDate	Read, Write	`Nullable of DateTime`	End Date
EndDisplayDate	Read, Write	`Nullable of DateTime`	End Display Date
Errors	Read	`IList of Error`	Errors
ExcludeRolesFilter	Read	`ApiList of Role`	Exclude Roles Filter
Id	Read, Write	`Int32`	Id
IncludeRolesFilter	Read	`ApiList of Role`	Include Roles Filter
IsEnabled	Read	`Boolean`	A flag representing whether the application is enabled.
LastCalculatedDate	Read, Write	`Nullable of DateTime`	Last Calculated Date
Name	Read, Write	`String`	Name
NodeId	Read	`Guid`	Node Id
NumberOfLeaders	Read, Write	`Int32`	Number Of Leaders
StartDate	Read, Write	`Nullable of DateTime`	Start Date
StartDisplayDate	Read, Write	`Nullable of DateTime`	Start Display Date
TimeSpanFilterType	Read, Write	`String`	Time Span Filter Type
TimeSpanLength	Read, Write	`Nullable of Int32`	Time Span Length
TimeSpanType	Read, Write	`String`	Time Span Type
Url	Read	`String`	A Url to the application on the site.
Warnings	Read	`IList of Warning`	Warnings

#set($stringResponse = $leaderboard.Description())

var stringResponse = leaderboard.Description();

#set($stringResponse = $leaderboard.Description($target))

var stringResponse = leaderboard.Description(target);

Name	Type	Description	Required	Default	Options
target	`String`	Target	Required

String

#set($booleanResponse = $leaderboard.HasErrors())

var booleanResponse = leaderboard.HasErrors();

Boolean

#set($booleanResponse = $leaderboard.HasWarnings())

var booleanResponse = leaderboard.HasWarnings();

Boolean

#set($booleanResponse = $leaderboard.HasWarningsOrErrors())

var booleanResponse = leaderboard.HasWarningsOrErrors();

Boolean

$leaderboard.ThrowErrors()

leaderboard.ThrowErrors();

Nothing

Recommended