GPGTurnBasedParticipant Class Reference

GPGTurnBasedParticipant Class Reference

Overview

Represents a participant in the context of a GPGTurnBasedMatch.

Properties

NSString * displayName
 The name to display for this participant.
NSURL * imageUrl
 The URL of the image to display for this participant.
NSString * participantId
 An identifier for the participant in the scope of the match.
GPGPlayerplayer
 The GPGPlayer that this participant represents.
GPGTurnBasedParticipantStatus status
 The status of the participant with respect to the match.

Property Documentation

- (NSString *) displayName [read, copy]

The name to display for this participant.

If the identity of the player is unknown, this will be a generic handle to describe the player.

- (NSURL *) imageUrl [read, copy]

The URL of the image to display for this participant.

If the identity of the player is unknown, this will be the automatch avatar icon image for the player. It may also be nil if the player simply has no image.

- (NSString*) participantId [read, copy]

An identifier for the participant in the scope of the match.

Cannot be used to identify a player across matches or in other contexts.

- (GPGPlayer*) player [read, assign]

The GPGPlayer that this participant represents.

Note that this may be nil if the identity of the player is unknown. This occurs in automatching scenarios where some players are not permitted to see the real identity of others.

- (GPGTurnBasedParticipantStatus) status [read, assign]

The status of the participant with respect to the match.