Leaderboard In-Process API Supplementary Type

Ben Tiedt — Fri, 08 Mar 2024 17:37:24 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:37:24

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

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

Definition

class Leaderboard
{
	Guid ApplicationId { get; set;  }
	string ApplicationKey { get; set;  }
	Guid? ContainerId { get; set;  }
	Guid ContentId { get; set;  }
	Guid ContentTypeId { get;  }
	DateTime CreatedDate { get; set;  }
	DateTime? EndDate { get; set;  }
	DateTime? EndDisplayDate { get; set;  }
	[[ApiList(T) In-Process API Supplementary Type|ApiList]]<[[Role In-Process API Supplementary Type|Role]]> ExcludeRolesFilter { get;  }
	int Id { get; set;  }
	[[ApiList(T) In-Process API Supplementary Type|ApiList]]<[[Role In-Process API Supplementary Type|Role]]> IncludeRolesFilter { get;  }
	bool IsEnabled { get;  }
	DateTime? LastCalculatedDate { get; set;  }
	string Name { get; set;  }
	Guid NodeId { get;  }
	int NumberOfLeaders { get; set;  }
	DateTime? StartDate { get; set;  }
	DateTime? StartDisplayDate { get; set;  }
	string TimeSpanFilterType { get; set;  }
	int? TimeSpanLength { get; set;  }
	string TimeSpanType { get; set;  }
	string Url { get;  }
	string Description();
	string Description(string target);
}

Properties

Name	Type	Description
ApplicationId	`Guid`	A Guid uniquely identifying the application.
ApplicationKey	`string`
ContainerId	`Guid?`
ContentId	`Guid`	A Guid uniquely identifying the content.
ContentTypeId	`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	`DateTime`	The date the content was created.
EndDate	`DateTime?`
EndDisplayDate	`DateTime?`
ExcludeRolesFilter	`[[ApiList(T) In-Process API Supplementary Type\|ApiList]]<[[Role In-Process API Supplementary Type\|Role]]>`
Id	`int`
IncludeRolesFilter	`[[ApiList(T) In-Process API Supplementary Type\|ApiList]]<[[Role In-Process API Supplementary Type\|Role]]>`
IsEnabled	`bool`	A flag representing whether the application is enabled.
LastCalculatedDate	`DateTime?`
Name	`string`
NodeId	`Guid`
NumberOfLeaders	`int`
StartDate	`DateTime?`
StartDisplayDate	`DateTime?`
TimeSpanFilterType	`string`
TimeSpanLength	`int?`
TimeSpanType	`string`
Url	`string`	A Url to the application on the site.

Methods

string Description();

Return Type

string

string Description(string target);

Parameters

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

Return Type

string