GPGTurnBasedParticipantResult Class Reference

GPGTurnBasedParticipantResult Class Reference

Overview

Represents a participant's current placing and final status in a match.

Multiple participants in a single match can have the same placing and result.

Public Member Functions

(instancetype) - initWithParticipantId:
 Inits the result object with the given participantId.

Properties

NSString * participantId
 The ID of the participant.
int placing
 The placement or ranking of the participant in the match results; a number from one to the number of participants in the match.
GPGTurnBasedParticipantResultStatus result
 The result of the participant for this match.

Member Function Documentation

- (instancetype) initWithParticipantId: (NSString *)  participantId

Inits the result object with the given participantId.

Both placing and result are optional and will default to kGPGTurnBasedParticipantResultPlacingUninitialized and GPGTurnBasedParticipantResultStatusUninitialized respectively. Set one or both of them to specify the participant result.

Parameters:
participantIdThe participantId from the match.

Property Documentation

- (NSString*) participantId [read, write, copy]

The ID of the participant.

- (int) placing [read, write, assign]

The placement or ranking of the participant in the match results; a number from one to the number of participants in the match.

Multiple participants may have the same placing value in the case of a tie. This field is optional and defaults to kGPGTurnBasedParticipantResultPlacingUninitialized.

- (GPGTurnBasedParticipantResultStatus) result [read, write, assign]

The result of the participant for this match.

This field is optional and defaults to GPGTurnBasedParticipantResultStatusUninitialized.