Stay organized with collections
Save and categorize content based on your preferences.
gpg::ScorePage::ScorePageToken
#include <score_page.h>
A data structure that is a nearly-opaque type representing a query for a ScorePage (or is empty).
Summary
ScorePageToken is used in various Leaderboard functions that allow paging through pages of scores. Tokens created by this function will always start at the beginning of the requested range. The client may obtain a token either from a Leaderboard, in which case it represents a query for the initial page of results for that query, or from a previously-obtained ScorePage, in which case it represents a continuation (paging) of that query.
Public functions
|
Valid() const
|
bool
Returns true when the returned score page token is populated with data and is accompanied by a successful response status; false for an unpopulated user-created token or for a populated one accompanied by an unsuccessful response status.
|
operator=(const ScorePageToken & copy_from)
|
Assignment operator for assigning this score page token's value from another score page token.
|
operator=(ScorePageToken && move_from)
|
Assignment operator for assigning this score page token's value from another score page token.
|
Public functions
ScorePageToken
ScorePageToken()
ScorePageToken
ScorePageToken(
std::shared_ptr< const ScorePageTokenImpl > impl
)
ScorePageToken
ScorePageToken(
const ScorePageToken & copy_from
)
Copy constructor for copying an existing score page token into a new one.
ScorePageToken
ScorePageToken(
ScorePageToken && move_from
)
Constructor for moving an existing score page token into a new one.
r-value-reference version.
Valid
bool Valid() const
Returns true when the returned score page token is populated with data and is accompanied by a successful response status; false for an unpopulated user-created token or for a populated one accompanied by an unsuccessful response status.
It must be true for the getter functions on this token (LeaderboardId, Start, etc.) to be usable.
operator=
ScorePageToken & operator=(
const ScorePageToken & copy_from
)
Assignment operator for assigning this score page token's value from another score page token.
operator=
ScorePageToken & operator=(
ScorePageToken && move_from
)
Assignment operator for assigning this score page token's value from another score page token.
r-value-reference version.
~ScorePageToken
~ScorePageToken()
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::ScorePage::ScorePageToken Class Reference\n\ngpg::ScorePage::ScorePageToken\n==============================\n\n`#include \u003cscore_page.h\u003e`\n\nA data structure that is a nearly-opaque type representing a query for a [ScorePage](/games/services/cpp/api/class/gpg/score-page#classgpg_1_1_score_page) (or is empty).\n\nSummary\n-------\n\n[ScorePageToken](/games/services/cpp/api/class/gpg/score-page/score-page-token#classgpg_1_1_score_page_1_1_score_page_token) is used in various [Leaderboard](/games/services/cpp/api/class/gpg/leaderboard#classgpg_1_1_leaderboard) functions that allow paging through pages of scores. Tokens created by this function will always start at the beginning of the requested range. The client may obtain a token either from a [Leaderboard](/games/services/cpp/api/class/gpg/leaderboard#classgpg_1_1_leaderboard), in which case it represents a query for the initial page of results for that query, or from a previously-obtained [ScorePage](/games/services/cpp/api/class/gpg/score-page#classgpg_1_1_score_page), in which case it represents a continuation (paging) of that query.\n\n| ### Constructors and Destructors ||\n|---|---|\n| [ScorePageToken](#classgpg_1_1_score_page_1_1_score_page_token_1a74fb3ae88facbb172bfae12c53ea20e1)`()` ||\n| [ScorePageToken](#classgpg_1_1_score_page_1_1_score_page_token_1acbe9a55e21e5dc253a83b25c035efd34)`(std::shared_ptr\u003c const `[ScorePageTokenImpl](/games/services/cpp/api/class/gpg/score-page/score-page-token#classgpg_1_1_score_page_1_1_score_page_token_1af3d660a323938fb5353f1b487408af42)` \u003e impl)` Explicit constructor. ||\n| [ScorePageToken](#classgpg_1_1_score_page_1_1_score_page_token_1a135117027fcbb9a79c55ecc1db07951a)`(const `[ScorePageToken](/games/services/cpp/api/class/gpg/score-page/score-page-token#classgpg_1_1_score_page_1_1_score_page_token)` & copy_from)` Copy constructor for copying an existing score page token into a new one. ||\n| [ScorePageToken](#classgpg_1_1_score_page_1_1_score_page_token_1af05f1f5538759a71b186d3efa18585c9)`(`[ScorePageToken](/games/services/cpp/api/class/gpg/score-page/score-page-token#classgpg_1_1_score_page_1_1_score_page_token)` && move_from)` Constructor for moving an existing score page token into a new one. ||\n| [~ScorePageToken](#classgpg_1_1_score_page_1_1_score_page_token_1abb34feaceca114b53ee5de8fa8c4b339)`()` ||\n\n| ### Public functions ||\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Valid](#classgpg_1_1_score_page_1_1_score_page_token_1af7b57edc2a429597e2daa1ac1ffe2af0)`() const ` | `bool` Returns true when the returned score page token is populated with data and is accompanied by a successful response status; false for an unpopulated user-created token or for a populated one accompanied by an unsuccessful response status. |\n| [operator=](#classgpg_1_1_score_page_1_1_score_page_token_1a1c8986654d34fa9b45e5bfa78c82d0de)`(const `[ScorePageToken](/games/services/cpp/api/class/gpg/score-page/score-page-token#classgpg_1_1_score_page_1_1_score_page_token)` & copy_from)` | [ScorePageToken](/games/services/cpp/api/class/gpg/score-page/score-page-token#classgpg_1_1_score_page_1_1_score_page_token)` &` Assignment operator for assigning this score page token's value from another score page token. |\n| [operator=](#classgpg_1_1_score_page_1_1_score_page_token_1a34fee10e97d8ff9a713110c5816206b5)`(`[ScorePageToken](/games/services/cpp/api/class/gpg/score-page/score-page-token#classgpg_1_1_score_page_1_1_score_page_token)` && move_from)` | [ScorePageToken](/games/services/cpp/api/class/gpg/score-page/score-page-token#classgpg_1_1_score_page_1_1_score_page_token)` &` Assignment operator for assigning this score page token's value from another score page token. |\n\nPublic functions\n----------------\n\n### ScorePageToken\n\n```c++\n ScorePageToken()\n``` \n\n### ScorePageToken\n\n```c++\n ScorePageToken(\n std::shared_ptr\u003c const ScorePageTokenImpl \u003e impl\n)\n``` \nExplicit constructor. \n\n### ScorePageToken\n\n```c++\n ScorePageToken(\n const ScorePageToken & copy_from\n)\n``` \nCopy constructor for copying an existing score page token into a new one. \n\n### ScorePageToken\n\n```c++\n ScorePageToken(\n ScorePageToken && move_from\n)\n``` \nConstructor for moving an existing score page token into a new one.\n\nr-value-reference version. \n\n### Valid\n\n```c++\nbool Valid() const \n``` \nReturns true when the returned score page token is populated with data and is accompanied by a successful response status; false for an unpopulated user-created token or for a populated one accompanied by an unsuccessful response status.\n\nIt must be true for the getter functions on this token (LeaderboardId, Start, etc.) to be usable. \n\n### operator=\n\n```c++\nScorePageToken & operator=(\n const ScorePageToken & copy_from\n)\n``` \nAssignment operator for assigning this score page token's value from another score page token. \n\n### operator=\n\n```c++\nScorePageToken & operator=(\n ScorePageToken && move_from\n)\n``` \nAssignment operator for assigning this score page token's value from another score page token.\n\nr-value-reference version. \n\n### \\~ScorePageToken\n\n```c++\n ~ScorePageToken()\n```"]]
