Response Types

Types used by accessors to supply status / value pairs.

Summary

Response types are either returned through a callback, as explained in Callbacks, or through a blocking function, as defined in Managers.

Each response type contains both data and a ResponseStatus. In cases where the ResponseStatus IsSuccess(), the corresponding data is Valid() (in the case of a single data value) or is non-empty (in the case of a vector).

In cases where the ResponseStatus IsError(), the corresponding data is !Valid() (in the case of a single data value) or is empty (in the case of a vector).

Enumerations
StatusCode	enum Status code values returned in the status field.

Typedefs
PlayerSelectUIResponse	typedef TurnBasedMultiplayerManager::PlayerSelectUIResponse Data and ResponseStatus for the ShowPlayerSelectUI operation.

Structs
gpg::EndpointDetails	Details about a remote endpoint that the app has discovered.
gpg::LeaderboardManager::FetchAllResponse	Contains data and response statuses for all leaderboards.
gpg::LeaderboardManager::FetchAllScoreSummariesResponse	Contains all data and response statuses for all leaderboard score summaries.
gpg::LeaderboardManager::FetchResponse	Holds data for a leaderboard, along with a response status.
gpg::LeaderboardManager::FetchScorePageResponse	Returns response status and data from the accessed score page.
gpg::LeaderboardManager::FetchScoreSummaryResponse	Data and response status for a specified leaderboard score summary.
gpg::PlayerManager::FetchListResponse	A response which contains a vector of players.
gpg::PlayerManager::FetchSelfResponse	Holds all player data, along with a response status.
gpg::RealTimeMultiplayerManager::FetchInvitationsResponse	Data and ResponseStatus for the FetchInvitations operation.
gpg::RealTimeMultiplayerManager::RealTimeRoomResponse	Data and ResponseStatus for a specific RealTimeRoom object.
gpg::RealTimeMultiplayerManager::RoomInboxUIResponse	Data and ResponseStatus for the ShowRoomInboxUI operation.
gpg::RealTimeMultiplayerManager::WaitingRoomUIResponse	Data and ResponseStatus for the ShowWaitingRoomUI operation.
gpg::SnapshotManager::CommitResponse	Holds the data for an updated snapshot, along with a response status.
gpg::SnapshotManager::OpenResponse	Holds the data for a particular requested snapshot along with a response status.
gpg::SnapshotManager::ReadResponse	Reads response status and snapshot data returned from a snapshot read operation.
gpg::SnapshotManager::SnapshotSelectUIResponse	Data and ResponseStatus for the ShowSelectUIOperation operation.
gpg::StartAdvertisingResult	The ID and name of an instance registered on this device.
gpg::StatsManager::FetchForPlayerResponse	Holds all PlayerStats data, along with a response status.
gpg::TurnBasedMultiplayerManager::MatchInboxUIResponse	Data and ResponseStatus for the ShowMatchInboxUI operation.
gpg::TurnBasedMultiplayerManager::PlayerSelectUIResponse	Data and ResponseStatus for the ShowPlayerSelectUI operation.
gpg::TurnBasedMultiplayerManager::TurnBasedMatchResponse	Data and ResponseStatus for a specific TurnBasedMatch.
gpg::TurnBasedMultiplayerManager::TurnBasedMatchesResponse	Data and ResponseStatus for TurnBasedMatches and invitations.
gpg::VideoManager::GetCaptureCapabilitiesResponse	Holds data for video capabilities, along with a response status.
gpg::VideoManager::GetCaptureStateResponse	Holds data for video capture state, along with a response status.
gpg::VideoManager::IsCaptureAvailableResponse	Holds whether or not a capture mode (specified in IsCaptureAvailable) is available, along with a response status.

Enumerations

StatusCode

 StatusCode

Status code values returned in the status field.

Typedefs

PlayerSelectUIResponse

TurnBasedMultiplayerManager::PlayerSelectUIResponse PlayerSelectUIResponse

Data and ResponseStatus for the ShowPlayerSelectUI operation.

This is shared with Turn Based multiplayer.