Class Leaderboard

Class Leaderboard#

Inheritance Relationships#

Base Type#

Class Documentation#

class Leaderboard : public xbe::sdk::EntityBase#

Describes a single leaderboard.

Public Functions

inline Leaderboard()#
inline Leaderboard(const Leaderboard &value)#
inline Leaderboard(Leaderboard &&value)#
inline virtual ~Leaderboard()#
inline virtual Leaderboard &SetProperties(const std::map<utility::string_t, Variant> &value) override#

Sets the object’s underlying map of stored values.

inline virtual Leaderboard &SetProperties(std::map<utility::string_t, Variant> &&value) override#

Sets the underlying map of stored values for the object.

inline virtual Leaderboard &SetProperty(const utility::char_t *name, const Variant &value) override#

Sets the property of the given name to the provided value.

inline virtual Leaderboard &SetProperty(const utility::string_t &name, const Variant &value) override#

Sets the property of the given name to the provided value.

inline virtual Leaderboard &SetRemoteUrl(const utility::string_t &url) override#

Returns the URL of the remote server endpoint where the object is managed.

inline virtual Leaderboard &SetUid(const utility::string_t &value) override#

Sets the value of the Uid property.

Parameters:

value – The value to set.

inline virtual Leaderboard &SetDateCreated(const datetime &value) override#

Sets the value of the DateCreated property.

Parameters:

value – The value to set.

inline virtual Leaderboard &SetDateModified(const datetime &value) override#

Sets the value of the DateModified property.

Parameters:

value – The value to set.

inline virtual Leaderboard &SetVersion(const uint64_t value) override#

Sets the value of the Version property.

Parameters:

value – The value to set.

virtual void Validate() override#
utility::string_t GetName() const#

The unique name of the leaderboard.

utility::string_t GetDescription() const#

A textual description of the leaderboard.

utility::string_t GetIcon() const#

The icon to display when representing the leaderboard.

utility::string_t GetProductUid() const#

The uid of the product that the zone is associated with.

utility::string_t GetRankingSchedule() const#

Returns the cron-tab like schedule that will rank the leaderboard records. Setting to undefined will rank all records in real-time. Make sure to use a staggered schedule when also setting a value for resetSchedule to prevent from trying to rank the leaderboard at the same time the reset operation is occurring.

utility::string_t GetResetSchedule() const#

Returns the cron-tab like schedule that will reset all leaderboard records. Setting to undefined will retain all records indefinitely. Make sure to use a staggered schedule when also setting a value for rankingSchedule to prevent from trying to reset the leaderboard at the same time the ranking operation is occurring.

const SortDirection *GetSort() const#

Returns direction to sort the leaderboard record set. SORT_ASCENDING will sort from records from lowest to highest score, SORT_DESCENDING sorts from highest to lowest score.

utility::string_t GetSortBy() const#

Returns the name of the stat that leaderboard records will be sorted and ranked by. Default value is score.

const UpdateMethod *GetUpdateMethod() const#

Returns the update method by which to accept new leaderboard records. UPDATE_BEST will retain only the best score, UPDATE_FIRST accepts only the first submitted record. UPDATE_LAST will always accept the most recently submitted record.

Public Static Functions

static inline const utility::char_t *ClassName()#

Returns the fully qualified name of the class.