GameKit Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The GameKit namespace provides easy communication between iPhone/iPod Touch devices.
Classes
GKAchievement |
Represents an achievement in the game. |
GKAchievementChallenge |
A challenge to a player to complete a specific GKAchievement. |
GKAchievementDescription |
A combination of text and images that describe a GKAchievement. |
GKAchievementViewController |
A GKGameCenterViewController that presents a standard user experience to display achievement progress. |
GKAchievementViewController.GKAchievementViewControllerAppearance |
Appearance class for objects of type GKAchievementViewController. |
GKAchievementViewControllerDelegate |
A delegate object that allows GKAchievementViewController to respond to lifecycle events. |
GKBasePlayer | |
GKCategoryResult |
Category and title results from the asynchronous LoadCategoriesAsync() method. |
GKChallenge |
A challenge issued by a player to another player. |
GKChallengeComposeResult |
Holds the return values from the asynchronous method ChallengeComposeControllerAsync(String, GKPlayer[], UIViewController). |
GKChallengeEventHandler |
The singleton Instance is used to respond to events relating to GKChallenges. |
GKChallengeEventHandlerDelegate |
A delegate object that allows the application developer fine-grained response to life-cycle events relating to GKChallenges, such as receiving or completing a challenge. |
GKChallengeEventHandlerDelegate_Extensions |
Extension methods to the IGKChallengeEventHandlerDelegate interface to support all the methods from the GKChallengeEventHandlerDelegate protocol. |
GKChallengeListener |
A base class for GKLocalPlayerListener. |
GKChallengeListener_Extensions |
Extension methods to the IGKChallengeListener interface to support all the methods from the GKChallengeListener protocol. |
GKChallengesViewController | |
GKChallengesViewControllerDelegate | |
GKCloudPlayer | |
GKDataEventArgs |
Provides data for the DataReceived event. |
GKDataReceivedEventArgs |
Provides data for the ReceiveData event. |
GKDataReceivedForRecipientEventArgs |
Provides data for the DataReceivedForRecipient event. |
GKDialogController | |
GKErrorEventArgs |
Provides data for the DidFailWithError and E:GameKit.GKErrorEventArgs.DidFailWithError events. |
GKErrorExtensions |
Extension methods for the GameKit.GKError enumeration. |
GKFriendRequestComposeViewController |
A UINavigationController that presents a screen for sending friend requests. |
GKFriendRequestComposeViewController.GKFriendRequestComposeViewControllerAppearance |
Appearance class for objects of type GKFriendRequestComposeViewController. |
GKFriendRequestComposeViewControllerDelegate |
A delegate object that allows fine-grained response to GKFriendRequestComposeViewController life-cycle events. |
GKGameCenterControllerDelegate |
A delegate object that allows fine-grained response to GKGameCenterViewController events. |
GKGameCenterViewController |
Game Center user interface to present leaderboards and achievements. |
GKGameSession | |
GKGameSessionErrorCodeExtensions |
Extension methods for the GameKit.GKGameSessionErrorCode enumeration. |
GKGameSessionEventListener_Extensions | |
GKIdentityVerificationSignatureResult |
Holds the return values from the asynchronous method GenerateIdentityVerificationSignatureAsync() |
GKInvite |
A matchmaking invitation sent to another player. |
GKInviteEventListener |
A base class for GKLocalPlayerListener. |
GKInviteEventListener_Extensions |
Extension methods to the IGKInviteEventListener interface to support all the methods from the GKInviteEventListener protocol. |
GKLeaderboard |
A class that represents a leaderboard stored in Game Center. |
GKLeaderboardSet |
Contains a set of GKLeaderboard objects. |
GKLeaderboardViewController |
A GKGameCenterViewController that presents leaderboards to the player. |
GKLeaderboardViewController.GKLeaderboardViewControllerAppearance |
Appearance class for objects of type GKLeaderboardViewController. |
GKLeaderboardViewControllerDelegate |
A delegate object that allows fine-grained control over GKLeaderboardViewController events. |
GKLocalPlayer |
Represents the authenticated local player. |
GKLocalPlayer.Notifications |
Notification posted by the GKLocalPlayer class. |
GKLocalPlayerListener |
A listener that listens for challenges, invitations, and turn based events. |
GKMatch |
A peer-to-peer network managed by Game Center. |
GKMatchConnectionChangedEventArgs |
Provides data for the StateChangedForPlayer event. |
GKMatchDelegate |
A delegate object that allows fine-grained control over GKMatch events. |
GKMatchDelegate_Extensions |
Extension methods to the IGKMatchDelegate interface to support all the methods from the GKMatchDelegate protocol. |
GKMatchEventArgs |
Provides data for the DidFindMatch event. |
GKMatchmaker |
A class that creates matches between players and receives invitations to potential matches. |
GKMatchmakerViewController |
A UIViewController that presents a standard UI for inviting friends or to allow Game Center to fill remaining players for a match. |
GKMatchmakerViewControllerDelegate |
A delegate object that allows fine-grained control over GKMatchmakerViewController events. |
GKMatchmakerViewControllerDelegate_Extensions |
Extension methods to the IGKMatchmakerViewControllerDelegate interface to support all the methods from the GKMatchmakerViewControllerDelegate protocol. |
GKMatchmakingPlayerEventArgs |
Provides data for the HostedPlayerDidAccept event. |
GKMatchmakingPlayersEventArgs |
Provides data for the DidFindHostedPlayers event. |
GKMatchReceivedDataFromRemotePlayerEventArgs |
Provides data for the DataReceivedFromPlayer event. |
GKMatchRequest |
Contains the parameters for a new match. |
GKNotificationBanner |
A banner that can be used to display text to a player. |
GKPeerChangedStateEventArgs |
Provides data for the PeerChanged event. |
GKPeerConnectionEventArgs |
Provides data for the Failed, E:GameKit.GKPeerConnectionEventArgs.ConnectionRequest and E:GameKit.GKPeerConnectionEventArgs.Failed events. |
GKPeerPickerController |
A View Controller that can be use to discover other players on other iPhones or iPads. |
GKPeerPickerControllerDelegate |
Delegate object for the GKPeerPickerController class. |
GKPeerPickerControllerDelegate_Extensions |
Extension methods to the IGKPeerPickerControllerDelegate interface to support all the methods from the GKPeerPickerControllerDelegate protocol. |
GKPlayer |
Game Center information about a player. |
GKPlayer.Notifications |
Notification posted by the GKPlayer class. |
GKPlayerErrorEventArgs | |
GKPlayerEventArgs |
Provides data for the ReceivedAcceptFromHostedPlayer event. |
GKPlayersEventArgs |
Provides data for the DidFindPlayers event. |
GKSavedGame |
Contains information that is needed to locate and load a saved game. |
GKSavedGameListener |
Application developers override this class to respond to conflicts or player modifications in saved games. |
GKSavedGameListener_Extensions |
Extension methods to the IGKSavedGameListener interface to support all the methods from the GKSavedGameListener protocol. |
GKScore |
Information about a game score. |
GKScoreChallenge |
A GKChallenge based on a GKScore. Success requires equaling or bettering the score. |
GKSession |
Provides the functionality necessary to discover and connect to nearby iPhones and iPads over Bluetooth. |
GKSessionDelegate |
Delegate for the GKSession class. |
GKSessionDelegate_Extensions |
Extension methods to the IGKSessionDelegate interface to support all the methods from the GKSessionDelegate protocol. |
GKStateEventArgs |
Provides data for the StateChanged event. |
GKTurnBasedEventHandler |
A singleton object used to respond to important messages relating to turn-based matches. |
GKTurnBasedEventHandlerDelegate |
A delegate object that is allows fine-grained response to GKTurnBasedEventHandler events. |
GKTurnBasedEventHandlerDelegate_Extensions |
Extension methods to the IGKTurnBasedEventHandlerDelegate interface to support all the methods from the GKTurnBasedEventHandlerDelegate protocol. |
GKTurnBasedEventListener |
Listens for events in turn-based games. |
GKTurnBasedEventListener_Extensions |
Extension methods to the IGKTurnBasedEventListener interface to support all the methods from the GKTurnBasedEventListener protocol. |
GKTurnBasedExchange |
Manages the exchange of turn data, accounting for game actions that players take either in turn or out of turn. |
GKTurnBasedExchangeReply |
Contains a player's response to a turn exchange. |
GKTurnBasedMatch |
A type of game match that uses store-and-forward to share data and allow for asynchronous turn-taking. |
GKTurnBasedMatchmakerViewController |
A UINavigationController that provides a standard UX for managing turn-based matches. |
GKTurnBasedMatchmakerViewController.GKTurnBasedMatchmakerViewControllerAppearance |
Appearance class for objects of type GKTurnBasedMatchmakerViewController. |
GKTurnBasedMatchmakerViewControllerDelegate |
A delegate object that allows fine-grained response to GKTurnBasedMatchmakerViewController events. |
GKTurnBasedParticipant |
Stores information about a participant in a turn-based match. |
GKVoiceChat |
An object that allows players in a match to speak to each other. |
GKVoiceChatClient |
The model that GKVoiceChatService uses. |
GKVoiceChatClient_Extensions |
Extension methods to the IGKVoiceChatClient interface to support all the methods from the GKVoiceChatClient protocol. |
GKVoiceChatService |
Provides voice chat over connected iPhones/iPads. |
GKVoiceChatServiceErrorExtensions |
Extension methods for the GameKit.GKVoiceChatServiceError enumeration. |
Interfaces
IGKAchievementViewControllerDelegate |
Interface representing the required methods (if any) of the protocol GKAchievementViewControllerDelegate. |
IGKChallengeEventHandlerDelegate |
Interface representing the required methods (if any) of the protocol GKChallengeEventHandlerDelegate. |
IGKChallengeListener |
Interface representing the required methods (if any) of the protocol GKChallengeListener. |
IGKChallengesViewControllerDelegate | |
IGKFriendRequestComposeViewControllerDelegate |
Interface representing the required methods (if any) of the protocol GKFriendRequestComposeViewControllerDelegate. |
IGKGameCenterControllerDelegate |
Interface representing the required methods (if any) of the protocol GKGameCenterControllerDelegate. |
IGKGameSessionEventListener | |
IGKInviteEventListener |
Interface representing the required methods (if any) of the protocol GKInviteEventListener. |
IGKLeaderboardViewControllerDelegate |
Interface representing the required methods (if any) of the protocol GKLeaderboardViewControllerDelegate. |
IGKLocalPlayerListener |
Interface representing the required methods (if any) of the protocol GKLocalPlayerListener. |
IGKMatchDelegate |
Interface representing the required methods (if any) of the protocol GKMatchDelegate. |
IGKMatchmakerViewControllerDelegate |
Interface representing the required methods (if any) of the protocol GKMatchmakerViewControllerDelegate. |
IGKPeerPickerControllerDelegate |
Interface representing the required methods (if any) of the protocol GKPeerPickerControllerDelegate. |
IGKSavedGameListener |
Interface representing the required methods (if any) of the protocol GKSavedGameListener. |
IGKSessionDelegate |
Interface representing the required methods (if any) of the protocol GKSessionDelegate. |
IGKTurnBasedEventHandlerDelegate |
Interface representing the required methods (if any) of the protocol GKTurnBasedEventHandlerDelegate. |
IGKTurnBasedEventListener |
Interface representing the required methods (if any) of the protocol GKTurnBasedEventListener. |
IGKTurnBasedMatchmakerViewControllerDelegate |
Interface representing the required methods (if any) of the protocol GKTurnBasedMatchmakerViewControllerDelegate. |
IGKViewController | |
IGKVoiceChatClient |
Interface representing the required methods (if any) of the protocol GKVoiceChatClient. |
Enums
GKAuthenticationType | |
GKChallengeState |
An enumeration whose values specify the states of a GKChallenge. |
GKConnectionState | |
GKError |
An enumeration whose values specify Game Kit errors. |
GKGameCenterViewControllerState |
An enumeration whose values specify the current ViewState of a GKGameCenterViewController. |
GKGameSessionErrorCode | |
GKInviteeResponse |
An enumeration whose values specify the possible responses of a remote player to a GKInvite. |
GKInviteRecipientResponse |
Enumerates responses to game play invitations. |
GKLeaderboardPlayerScope |
An enumeration whose values specify whether a GKLeaderboard should display global results or only for friends. |
GKLeaderboardTimeScope |
An enumeration whose values specify the amount of time to which a player's best score is restricted. |
GKMatchSendDataMode |
An enumeration that allows data transmission to trade off speed for reliability. |
GKMatchType |
An enumeration whose values specify the form of a match. |
GKPeerConnectionState |
An enumeration whose values specify the state of a peer-to-peer connection. |
GKPeerPickerConnectionType |
An enumeration whose values specify acceptable ping for peer-to-peer connections. |
GKPhotoSize |
An enumeration whose values specify the size of a photo being loaded by LoadPhoto(GKPhotoSize, GKPlayerPhotoLoaded). |
GKPlayerConnectionState |
An enumeration whose values specify the connection state of a GKPlayer. |
GKSendDataMode |
An enumeration that allows data transmission to trade off speed for reliability. |
GKSessionMode |
The session mode. |
GKTransportType | |
GKTurnBasedExchangeStatus |
Enumerates turn status information. |
GKTurnBasedMatchOutcome |
An enumeration whose values specify valid outcomes of turn-based matches. |
GKTurnBasedMatchStatus |
An eumeration whose values specify the status of a turn-based match. (See Status.) |
GKTurnBasedParticipantStatus |
An enumeration whose values specify the status of turn-based participants. (See Status.) |
GKVoiceChatPlayerState |
An enumeration whose values specify the state of a GKVoiceChat channel. (See GKPlayerStateUpdateHandler.) |
GKVoiceChatServiceError |
Errors returned by the GKVoiceChatService. |
Delegates
GKAchievementDescriptionHandler |
A delegate that is called by LoadAchievementDescriptions(GKAchievementDescriptionHandler). |
GKCategoryHandler |
A delegate that is called by LoadCategories(GKCategoryHandler). |
GKChallengeComposeHandler |
Completion handler for for the ChallengeComposeControllerAsync(String, GKPlayer[], UIViewController) method. |
GKChallengePredicate |
A delegate returned by several properties in GKChallengeEventHandler. |
GKCompletionHandler |
A delegate passed to LoadAchievements(GKCompletionHandler) that specifies behavior after the downloading of achievements from Game Center is completed. |
GKFriendsHandler |
A delegate used with LoadFriends(GKFriendsHandler) and FindPlayers(GKMatchRequest, GKFriendsHandler) that defines behavior after the request completes. |
GKIdentityVerificationSignatureHandler |
Completion handler for the GenerateIdentityVerificationSignature(GKIdentityVerificationSignatureHandler) method. |
GKImageLoadedHandler |
A delegate passed to GKAchievementDescription that defines behavior after the image has been loaded. |
GKInviteHandler |
A delegate that is used to define behavior after a response to a GKInvite. |
GKLeaderboardSetsHandler |
Completion handler for the LoadLeaderboardSets(GKLeaderboardSetsHandler) method. |
GKLeaderboardsHandler |
Completion handler for the LoadLeaderboards(GKLeaderboardsHandler) method. |
GKMatchReinvitation |
A delegate used with ShouldReinvitePlayer that allows the application developer to control whether a player should be reinvited. |
GKMatchReinvitationForDisconnectedPlayer |
Completion handler that app developers can specify for the ShouldReinviteDisconnectedPlayer property. |
GKNotificationMatch |
A delegate used with FindMatch(GKMatchRequest, GKNotificationMatch) that specifies behavior after a match has been made. |
GKPlayerPhotoLoaded |
A delegate used with LoadPhoto(GKPhotoSize, GKPlayerPhotoLoaded) to specify behavior after the photo is loaded. |
GKPlayersHandler |
A delegate used with LoadPlayersForIdentifiers(String[], GKPlayersHandler) to specify behavior to happen after the players are loaded. |
GKPlayerStateUpdateHandler |
A delegate used with PlayerStateUpdateHandler that specifies behavior when the player's GKVoiceChatPlayerState changes. |
GKQueryHandler |
A delegate used with QueryActivity(GKQueryHandler) and QueryPlayerGroupActivity(nint, GKQueryHandler) to specify behavior after the query is completed. |
GKScoresLoadedHandler |
A delegate used with LoadScores(GKScoresLoadedHandler) that specifies behavior after the scores are loaded. |
GKTurnBasedMatchData |
A delegate that is used with LoadMatchData(GKTurnBasedMatchData) to specify behavior after the data is loaded. |
GKTurnBasedMatchesRequest |
A delegate used with LoadMatches(GKTurnBasedMatchesRequest) to specify behavior after the matches have been loaded. |
GKTurnBasedMatchRequest |
A delegate that specifies the completion handler for FindMatch(GKMatchRequest, GKTurnBasedMatchRequest). |
Remarks
The framework provides the foundation to send data between nearby iPhone/iPod touch devices (using Bluetooth) and to provide voice chat between the devices.