Class LeaderboardRecord

Inheritance Relationships

Base Type

Class Documentation

class LeaderboardRecord : public axr::sdk::EntityBase

Describes a user’s single score record within a given leaderboard.

Public Functions

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

Sets the object’s underlying map of stored values.

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

Sets the underlying map of stored values for the object.

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

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

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

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

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

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

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

Sets the value of the Uid property.

Parameters

value – The value to set.

inline virtual LeaderboardRecord &SetDateCreated(const datetime &value) override

Sets the value of the DateCreated property.

Parameters

value – The value to set.

inline virtual LeaderboardRecord &SetDateModified(const datetime &value) override

Sets the value of the DateModified property.

Parameters

value – The value to set.

inline virtual LeaderboardRecord &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 GetLeaderboardUid() const

Returns the unique identifier of the leaderboard that the record belongs to.

LeaderboardRecord &SetLeaderboardUid(const utility::string_t &value)

Sets the unique identifier of the leaderboard that the record belongs to.

Parameters

value – The value to set.

utility::string_t GetPersonaUid() const

Returns unique identifier of the persona that submitted the record.

LeaderboardRecord &SetPersonaUid(const utility::string_t &value)

Sets unique identifier of the persona that submitted the record.

Parameters

value – The value to set.

int64_t GetRank() const

Returns the global rank of the record in relation to other records within the leaderboard (lower is better).

std::shared_ptr<Object> GetStats() const

Returns an object containing all of the persona’s stats that will be ranked.

LeaderboardRecord &SetStats(std::shared_ptr<Object> value)

Sets an object containing all of the persona’s stats that will be ranked.

Parameters

value – The value to set.

double GetStatDouble(const utility::string_t &name) const

Returns the value of the stat with the given name as a double.

Parameters

name – The name of the stat whose value will be retrieved.

float GetStatFloat(const utility::string_t &name) const

Returns the value of the stat with the given name as a float.

int16_t GetStatInt16(const utility::string_t &name) const

Returns the value of the stat with the given name as a 32-bit integer.

int32_t GetStatInt32(const utility::string_t &name) const

Returns the value of the stat with the given name as a 32-bit integer.

int64_t GetStatInt64(const utility::string_t &name) const

Returns the value of the stat with the given name as a 64-bit integer.

uint16_t GetStatUInt16(const utility::string_t &name) const

Returns the value of the stat with the given name as a 32-bit unsigned integer.

uint32_t GetStatUInt32(const utility::string_t &name) const

Returns the value of the stat with the given name as a 32-bit unsigned integer.

uint64_t GetStatUInt64(const utility::string_t &name) const

Returns the value of the stat with the given name as a 64-bit unsigned integer.

bool HasStat(const utility::string_t &name) const

Returns true if there exists a stat with the given name, otherwise returns false.

LeaderboardRecord &SetStat(const utility::string_t &name, double value)

Sets the value of the stat with the given name.

LeaderboardRecord &SetStat(const utility::string_t &name, float value)

Sets the value of the stat with the given name.

LeaderboardRecord &SetStat(const utility::string_t &name, int16_t value)

Sets the value of the stat with the given name.

LeaderboardRecord &SetStat(const utility::string_t &name, int32_t value)

Sets the value of the stat with the given name.

LeaderboardRecord &SetStat(const utility::string_t &name, int64_t value)

Sets the value of the stat with the given name.

LeaderboardRecord &SetStat(const utility::string_t &name, uint16_t value)

Sets the value of the stat with the given name.

LeaderboardRecord &SetStat(const utility::string_t &name, uint32_t value)

Sets the value of the stat with the given name.

LeaderboardRecord &SetStat(const utility::string_t &name, uint64_t value)

Sets the value of the stat with the given name.

Public Static Functions

static inline const utility::char_t *ClassName()

Returns the fully qualified name of the class.