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.

Constructors and Destructors
ScorePageToken()
ScorePageToken(std::shared_ptr< const ScorePageTokenImpl > impl)
Explicit constructor.
ScorePageToken(const ScorePageToken & copy_from)
Copy constructor for copying an existing score page token into a new one.
ScorePageToken(ScorePageToken && move_from)
Constructor for moving an existing score page token into a new one.
~ScorePageToken()

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
)

Explicit constructor.

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()