Stay organized with collections
Save and categorize content based on your preferences.
gpg::Leaderboard
#include <leaderboard.h>
A single data structure allowing you to access data about the status of a specific leaderboard, such as its name and validity.
Summary
Public functions
|
IconUrl() const
|
const std::string &
Returns the URL leading to the image of the icon for this Leaderboard. |
Id() const
|
const std::string &
Returns the unique string that the Google Play Developer Console generated beforehand.
|
Name() const
|
const std::string &
Returns the short name of the leaderboard.
|
Order() const
|
Returns whether ascending or descending order is better.
|
Valid() const
|
bool
Returns true when the returned leaderboard is populated with data and is accompanied by a successful response status; false for an unpopulated user-created leaderboard or for a populated one accompanied by an unsuccessful response status.
|
operator=(const Leaderboard & copy_from)
|
Assignment operator for assigning this leaderboard's value from another leaderboard.
|
operator=(Leaderboard && move_from)
|
Assignment operator for assigning this leaderboard's value from another leaderboard.
|
Public functions
IconUrl
const std::string & IconUrl() const
Id
const std::string & Id() const
Returns the unique string that the Google Play Developer Console generated beforehand.
Use it to refer to a leaderboard in your game client. It can only be called when Leaderboard::Valid() returns true.
Leaderboard
Leaderboard()
Leaderboard
Leaderboard(
std::shared_ptr< const LeaderboardImpl > impl
)
Leaderboard
Leaderboard(
const Leaderboard & copy_from
)
Copy constructor for copying an existing leaderboard into a new one.
Leaderboard
Leaderboard(
Leaderboard && move_from
)
Constructor for moving an existing leaderboard into a new one.
r-value-reference version.
Name
const std::string & Name() const
Returns the short name of the leaderboard.
Up to 100 characters. It can only be called when Achievement::Valid() returns true.
Order
LeaderboardOrder Order() const
Returns whether ascending or descending order is better.
Possible values are "LARGER_IS_BETTER" or "SMALLER_IS_BETTER". LARGER_IS_BETTER places larger scores at the top (descending). SMALLER_IS_BETTER places smaller scores at the top (ascending). It can only be called when Achievement::Valid() returns true.
Valid
bool Valid() const
Returns true when the returned leaderboard is populated with data and is accompanied by a successful response status; false for an unpopulated user-created leaderboard or for a populated one accompanied by an unsuccessful response status.
It must be true for the getter functions on this leaderboard (id, Name, Description, etc.) to be usable.
operator=
Leaderboard & operator=(
const Leaderboard & copy_from
)
Assignment operator for assigning this leaderboard's value from another leaderboard.
operator=
Leaderboard & operator=(
Leaderboard && move_from
)
Assignment operator for assigning this leaderboard's value from another leaderboard.
r-value-reference version.
~Leaderboard
~Leaderboard()
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-10-28 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-28 UTC."],[],[],null,["# gpg::Leaderboard Class Reference\n\ngpg::Leaderboard\n================\n\n`#include \u003cleaderboard.h\u003e`\n\nA single data structure allowing you to access data about the status of a specific leaderboard, such as its name and validity.\n\nSummary\n-------\n\n| ### Constructors and Destructors ||\n|---|---|\n| [Leaderboard](#classgpg_1_1_leaderboard_1ae00cee7b5871b60ed0f8cf8ed2aeb4a6)`()` ||\n| [Leaderboard](#classgpg_1_1_leaderboard_1a9c87f8487ea39d307bea77c2f624387e)`(std::shared_ptr\u003c const LeaderboardImpl \u003e impl)` Explicit constructor. ||\n| [Leaderboard](#classgpg_1_1_leaderboard_1a943d7e864d459b1605794a6fabef1653)`(const `[Leaderboard](/games/services/cpp/api/class/gpg/leaderboard#classgpg_1_1_leaderboard)` & copy_from)` Copy constructor for copying an existing leaderboard into a new one. ||\n| [Leaderboard](#classgpg_1_1_leaderboard_1a10a16a9c1fccb70e8f231813d093b3a2)`(`[Leaderboard](/games/services/cpp/api/class/gpg/leaderboard#classgpg_1_1_leaderboard)` && move_from)` Constructor for moving an existing leaderboard into a new one. ||\n| [~Leaderboard](#classgpg_1_1_leaderboard_1aeeae550785fca1d79c8187ae12610123)`()` ||\n\n| ### Public functions ||\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [IconUrl](#classgpg_1_1_leaderboard_1a74076db7d71675e2e6228cb2f396e5c5)`() const ` | `const std::string &` Returns the URL leading to the image of the icon for this [Leaderboard](/games/services/cpp/api/class/gpg/leaderboard#classgpg_1_1_leaderboard). |\n| [Id](#classgpg_1_1_leaderboard_1ab30ace9344a5443519b8d70bb4947085)`() const ` | `const std::string &` Returns the unique string that the Google Play Developer Console generated beforehand. |\n| [Name](#classgpg_1_1_leaderboard_1a237846a501cea52e6a9142ee892af697)`() const ` | `const std::string &` Returns the short name of the leaderboard. |\n| [Order](#classgpg_1_1_leaderboard_1a008e480040a730e6729368a9c694f717)`() const ` | [LeaderboardOrder](/games/services/cpp/api/namespace/gpg#namespacegpg_1a17d647fceb4fee77f693520405f75cb9) Returns whether ascending or descending order is better. |\n| [Valid](#classgpg_1_1_leaderboard_1a510984968ca31ed44aafb18dec22a159)`() const ` | `bool` Returns true when the returned leaderboard is populated with data and is accompanied by a successful response status; false for an unpopulated user-created leaderboard or for a populated one accompanied by an unsuccessful response status. |\n| [operator=](#classgpg_1_1_leaderboard_1a4e893a80cc728b346368ff002a9f10a1)`(const `[Leaderboard](/games/services/cpp/api/class/gpg/leaderboard#classgpg_1_1_leaderboard)` & copy_from)` | [Leaderboard](/games/services/cpp/api/class/gpg/leaderboard#classgpg_1_1_leaderboard)` &` Assignment operator for assigning this leaderboard's value from another leaderboard. |\n| [operator=](#classgpg_1_1_leaderboard_1a2c99314b97150d4e24a6b7b0a399139d)`(`[Leaderboard](/games/services/cpp/api/class/gpg/leaderboard#classgpg_1_1_leaderboard)` && move_from)` | [Leaderboard](/games/services/cpp/api/class/gpg/leaderboard#classgpg_1_1_leaderboard)` &` Assignment operator for assigning this leaderboard's value from another leaderboard. |\n\nPublic functions\n----------------\n\n### IconUrl\n\n```c++\nconst std::string & IconUrl() const \n``` \nReturns the URL leading to the image of the icon for this [Leaderboard](/games/services/cpp/api/class/gpg/leaderboard#classgpg_1_1_leaderboard).\n\nIt can only be called when [Leaderboard::Valid()](/games/services/cpp/api/class/gpg/leaderboard#classgpg_1_1_leaderboard_1a510984968ca31ed44aafb18dec22a159) returns true. \n\n### Id\n\n```c++\nconst std::string & Id() const \n``` \nReturns the unique string that the Google Play Developer Console generated beforehand.\n\nUse it to refer to a leaderboard in your game client. It can only be called when [Leaderboard::Valid()](/games/services/cpp/api/class/gpg/leaderboard#classgpg_1_1_leaderboard_1a510984968ca31ed44aafb18dec22a159) returns true. \n\n### Leaderboard\n\n```c++\n Leaderboard()\n``` \n\n### Leaderboard\n\n```c++\n Leaderboard(\n std::shared_ptr\u003c const LeaderboardImpl \u003e impl\n)\n``` \nExplicit constructor. \n\n### Leaderboard\n\n```c++\n Leaderboard(\n const Leaderboard & copy_from\n)\n``` \nCopy constructor for copying an existing leaderboard into a new one. \n\n### Leaderboard\n\n```c++\n Leaderboard(\n Leaderboard && move_from\n)\n``` \nConstructor for moving an existing leaderboard into a new one.\n\nr-value-reference version. \n\n### Name\n\n```c++\nconst std::string & Name() const \n``` \nReturns the short name of the leaderboard.\n\nUp to 100 characters. It can only be called when [Achievement::Valid()](/games/services/cpp/api/class/gpg/achievement#classgpg_1_1_achievement_1aaabe36b88537ecef60d5eff48c98038c) returns true. \n\n### Order\n\n```c++\nLeaderboardOrder Order() const \n``` \nReturns whether ascending or descending order is better.\n\nPossible values are \"LARGER_IS_BETTER\" or \"SMALLER_IS_BETTER\". LARGER_IS_BETTER places larger scores at the top (descending). SMALLER_IS_BETTER places smaller scores at the top (ascending). It can only be called when [Achievement::Valid()](/games/services/cpp/api/class/gpg/achievement#classgpg_1_1_achievement_1aaabe36b88537ecef60d5eff48c98038c) returns true. \n\n### Valid\n\n```c++\nbool Valid() const \n``` \nReturns true when the returned leaderboard is populated with data and is accompanied by a successful response status; false for an unpopulated user-created leaderboard or for a populated one accompanied by an unsuccessful response status.\n\nIt must be true for the getter functions on this leaderboard (id, Name, Description, etc.) to be usable. \n\n### operator=\n\n```c++\nLeaderboard & operator=(\n const Leaderboard & copy_from\n)\n``` \nAssignment operator for assigning this leaderboard's value from another leaderboard. \n\n### operator=\n\n```c++\nLeaderboard & operator=(\n Leaderboard && move_from\n)\n``` \nAssignment operator for assigning this leaderboard's value from another leaderboard.\n\nr-value-reference version. \n\n### \\~Leaderboard\n\n```c++\n ~Leaderboard()\n```"]]
