GKLocalPlayer Class

Definition

Namespace:

GameKit

Assembly:

Xamarin.iOS.dll

Represents the authenticated local player.

[Foundation.Register("GKLocalPlayer", true)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.WatchOS, 3, 0, ObjCRuntime.PlatformArchitecture.All, null)]
public class GKLocalPlayer : GameKit.GKPlayer, GameKit.IGKSavedGameListener, IDisposable

type GKLocalPlayer = class
    inherit GKPlayer
    interface IGKSavedGameListener
    interface INativeObject
    interface IDisposable

Inheritance

Object

NSObject

GKBasePlayer

GKPlayer

GKLocalPlayer

Attributes

RegisterAttribute

Implements

IGKSavedGameListener INativeObject IDisposable

Remarks

Represents the authenticated player for this device.

On iOS 6.0 and newer, to authenticate the user, set the AuthenticateHandler property to a delegate that takes both a UIViewController and an NSError parameters. This will trigger the authentication to take place. For older versions of iOS, you should call the Authenticate(Action<NSError>) method. The difference is that with iOS 6.0 your callback receives a UIViewController that you can present to your user, while the old API would present the API and invoke your callback on an arbitrary thread.

GameKit will call AuthenticateHandler on demand as your application transitions from background and foreground. It is important that you update any internal state when authenticated as the user might have logged off, and logged in with a different account.

//
// This shows how to authenticate on both iOS 6.0 and older versions
//
if (UIDevice.CurrentDevice.CheckSystemVersion (6, 0)) {
    //
    // iOS 6.0 and newer
    //
    GKLocalPlayer.LocalPlayer.AuthenticateHandler = (ui, error) => {

        // If ui is null, that means the user is already authenticated,
	// for example, if the user used Game Center directly to log in

	if (ui != null)
            current.PresentModalViewController (ui, true);
	else {
	    // Check if you are authenticated:
	    var authenticated = GKLocalPlayer.LocalPlayer.Authenticated;
	}
	Console.WriteLine ("Authentication result: {0}",err);
    };
} else {
    // Versions prior to iOS 6.0
    GKLocalPlayer.LocalPlayer.Authenticate ((err) => {
        Console.WriteLine ("Authentication result: {0}",err);
    });
};

Constructors

GKLocalPlayer()	Default constructor that initializes a new instance of this class with no parameters.
GKLocalPlayer(IntPtr)	A constructor used when creating managed representations of unmanaged objects; Called by the runtime.
GKLocalPlayer(NSCoder)	A constructor that initializes the object from the data stored in the unarchiver object.
GKLocalPlayer(NSObjectFlag)	Constructor to call on derived classes to skip initialization and merely allocate the object.

Properties

Alias	Gets the player's chosen name. (Inherited from GKPlayer)
Authenticated	Current authentication state for the local player.
AuthenticateHandler	Handler used to authenticate the user, triggers authentication when set.
AuthenticationDidChangeNotificationName	Notification constant for AuthenticationDidChangeNoti
Class	(Inherited from NSObject)
ClassHandle	The handle for this class.
DebugDescription	A developer-meaningful description of this object. (Inherited from NSObject)
Description	Description of the object, the Objective-C version of ToString. (Inherited from NSObject)
DisplayName	Gets the diplay name for the player. (Inherited from GKPlayer)
Friends	Deprecated. Gets an array of the local player's friends' identifiers.
GuestIdentifier	Get the identifier that the developer assigned to a guest player. (Inherited from GKPlayer)
Handle	Handle (pointer) to the unmanaged object representation. (Inherited from NSObject)
IsDirectBinding	(Inherited from NSObject)
IsFriend	Developers should not use this deprecated property. Developers should use 'GKLocalPlayer.LoadFriendPlayers' instead. (Inherited from GKPlayer)
IsProxy	(Inherited from NSObject)
IsUnderage	Gets a value that tells whether the player is undreaged.
LocalPlayer	Gets the shared instance of the local player.
PlayerID	Gets the unique identifier that Game Center assigned to the player. (Inherited from GKPlayer)
RetainCount	Returns the current Objective-C retain count for the object. (Inherited from NSObject)
Self	(Inherited from NSObject)
Superclass	(Inherited from NSObject)
SuperHandle	Handle used to represent the methods in the base class for this NSObject. (Inherited from NSObject)
Zone	(Inherited from NSObject)

Methods

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)	Registers an object for being observed externally (using NSString keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method. (Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)	Registers an object for being observed externally (using string keyPath).   Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method. (Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)	Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)	Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject)
Authenticate(Action<NSError>)	Developers should not use this deprecated method. Set the 'AuthenticationHandler' instead.
AuthenticateAsync()	Developers should not use this deprecated method. Set the 'AuthenticationHandler' instead.
AwakeFromNib()	Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib(). (Inherited from NSObject)
BeginInvokeOnMainThread(Action)	(Inherited from NSObject)
BeginInvokeOnMainThread(Selector, NSObject)	Invokes asynchrously the specified code on the main UI thread. (Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary)	(Inherited from NSObject)
Bind(String, NSObject, String, NSDictionary)	(Inherited from NSObject)
BindingInfo(String)	(Inherited from NSObject)
BindingOptionDescriptions(String)	(Inherited from NSObject)
BindingValueClass(String)	(Inherited from NSObject)
CommitEditing()	(Inherited from NSObject)
CommitEditing(NSObject, Selector, IntPtr)	(Inherited from NSObject)
ConformsToProtocol(IntPtr)	Invoked to determine if this object implements the specified protocol. (Inherited from NSObject)
Copy()	Performs a copy of the underlying Objective-C object. (Inherited from NSObject)
DangerousAutorelease()	(Inherited from NSObject)
DangerousRelease()	(Inherited from NSObject)
DangerousRetain()	(Inherited from NSObject)
DeleteSavedGames(String, Action<NSError>)	Deletes all saved games that are named name and passes null to handler on success, or an error on failure.
DidChange(NSKeyValueChange, NSIndexSet, NSString)	Indicates a change occurred to the indexes for a to-many relationship. (Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
DidChangeValue(String)	Indicates that a change occurred on the specified key. (Inherited from NSObject)
DidModifySavedGame(GKPlayer, GKSavedGame)
Dispose()	Releases the resources used by the NSObject object. (Inherited from NSObject)
Dispose(Boolean)	Releases the resources used by the NSObject object. (Inherited from NSObject)
DoesNotRecognizeSelector(Selector)	Indicates that this object does not recognize the specified selector. (Inherited from NSObject)
EncodeTo(NSCoder)	Encodes the state of the object on the provided encoder (Inherited from GKPlayer)
Equals(NSObject)	(Inherited from NSObject)
Equals(Object)	(Inherited from NSObject)
ExposedBindings()	(Inherited from NSObject)
FetchSavedGames(Action<GKSavedGame[],NSError>)	Retrieves all saved games and passes them to handler, along with null for success, or an error on failure.
GenerateIdentityVerificationSignature(GKIdentityVerificationSignatureHandler)	Creates and returns a signature for authenticating the local player on a third-party server. See remarks
GenerateIdentityVerificationSignatureAsync()	Creates and returns a signature for authenticating the local player on a third-party server. See remarks
GetBindingInfo(NSString)	(Inherited from NSObject)
GetBindingOptionDescriptions(NSString)	(Inherited from NSObject)
GetBindingValueClass(NSString)	(Inherited from NSObject)
GetDictionaryOfValuesFromKeys(NSString[])	Retrieves the values of the specified keys. (Inherited from NSObject)
GetHashCode()	Generates a hash code for the current instance. (Inherited from NSObject)
GetMethodForSelector(Selector)	(Inherited from NSObject)
GetNativeField(String)	Obsolete. (Inherited from NSObject)
GetNativeHash()	(Inherited from NSObject)
HasConflictingSavedGames(GKPlayer, GKSavedGame[])
Init()	(Inherited from NSObject)
InitializeHandle(IntPtr, String)	(Inherited from NSObject)
InitializeHandle(IntPtr)	(Inherited from NSObject)
Invoke(Action, Double)	(Inherited from NSObject)
Invoke(Action, TimeSpan)	(Inherited from NSObject)
InvokeOnMainThread(Action)	(Inherited from NSObject)
InvokeOnMainThread(Selector, NSObject)	Invokes synchrously the specified code on the main UI thread. (Inherited from NSObject)
IsEqual(NSObject)	(Inherited from NSObject)
IsKindOfClass(Class)	(Inherited from NSObject)
IsMemberOfClass(Class)	(Inherited from NSObject)
LoadDefaultLeaderboardCategoryID(Action<String,NSError>)	Loads the local player's default leaderboard category ID, and passes it to completionHandler, along with an error object that is null if no error occurred.
LoadDefaultLeaderboardCategoryIDAsync()	Loads the local player's default leaderboard category ID, and passes it to completionHandler, along with an error object that is null if no error occurred.
LoadDefaultLeaderboardIdentifier(Action<String,NSError>)	Loads the local player's default leaderboard identifier, and passes it to completionHandler, along with an error object that is null if no error occurred.
LoadDefaultLeaderboardIdentifierAsync()	Loads the local player's default leaderboard identifier, and passes it to completionHandler, along with an error object that is null if no error occurred.
LoadFriendPlayers(Action<GKPlayer[],NSError>)	Loads an array of the local player's friends' identifiers and passes it to completionHandler, along with an error object that is null if no error occurred.
LoadFriendPlayersAsync()	Loads an array of the local player's friends' identifiers and passes it to completionHandler, along with an error object that is null if no error occurred.
LoadFriends(GKFriendsHandler)	Deprecated. Loads an array of the local player's friends' identifiers and passes it to handler, along with an error object that is null if no error occurred.
LoadFriendsAsync()	Deprecated. Loads an array of the local player's friends' identifiers and passes it to handler, along with an error object that is null if no error occurred.
LoadPhoto(GKPhotoSize, GKPlayerPhotoLoaded)	Loads the player's photo from the Game Center and runs a completion handler after the photo is loaded. (Inherited from GKPlayer)
LoadPhotoAsync(GKPhotoSize)	Asynchronously loads the player's photo from the Game Center. (Inherited from GKPlayer)
LoadRecentPlayers(Action<GKPlayer[],NSError>)	Loads the recent players.
LoadRecentPlayersAsync()	Loads the recent players.
MarkDirty()	Promotes a regular peer object (IsDirectBinding is true) into a toggleref object. (Inherited from NSObject)
MutableCopy()	Creates a mutable copy of the specified NSObject. (Inherited from NSObject)
ObjectDidEndEditing(NSObject)	(Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr)	Indicates that the value at the specified keyPath relative to this object has changed. (Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[])	(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double)	Invokes the selector on the current instance and if the obj is not null, it passes this as its single parameter. (Inherited from NSObject)
PerformSelector(Selector, NSObject, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[])	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean)	(Inherited from NSObject)
PerformSelector(Selector)	(Inherited from NSObject)
PrepareForInterfaceBuilder()	(Inherited from NSObject)
RegisterListener(IGKLocalPlayerListener)	Registers listener in order to monitor the events that it listens for.
RemoveObserver(NSObject, NSString, IntPtr)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context. (Inherited from NSObject)
RemoveObserver(NSObject, NSString)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath. (Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context. (Inherited from NSObject)
RemoveObserver(NSObject, String)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath. (Inherited from NSObject)
ResolveConflictingSavedGames(GKSavedGame[], NSData, Action<GKSavedGame[],NSError>)	Resolves the specified conflicting saved games that are listed in conflictingSavedGames and stored in data, then passes a list of all the games (conflicting games first) to handler, along with an error object that is null if no error occurred.
RespondsToSelector(Selector)	Whether this object recognizes the specified selector. (Inherited from NSObject)
SaveGameData(NSData, String, Action<GKSavedGame,NSError>)	Saves the game data data under the name name, and then passes the game metadata to handler, along with an error object that is null if no error occurred.
SetDefaultLeaderboardCategoryID(String, Action<NSError>)	Deprecated. Sets the local player's default leaderboard category ID, and passes it to completionHandler, along with an error object that is null if no error occurred.
SetDefaultLeaderboardCategoryIDAsync(String)	Deprecated. Sets the local player's default leaderboard category ID, and passes it to completionHandler, along with an error object that is null if no error occurred.
SetDefaultLeaderboardIdentifier(String, Action<NSError>)	Sets the local player's default leaderboard identifier, and passes it to completionHandler, along with an error object that is null if no error occurred..
SetDefaultLeaderboardIdentifierAsync(String)	Sets the local player's default leaderboard identifier, and passes it to completionHandler, along with an error object that is null if no error occurred..
SetNativeField(String, NSObject)	Obsolete. (Inherited from NSObject)
SetNilValueForKey(NSString)	Sets the value of the specified key to null. (Inherited from NSObject)
SetValueForKey(NSObject, NSString)	Sets the value of the property specified by the key to the specified value. (Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString)	A constructor used when creating managed representations of unmanaged objects; Called by the runtime. (Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString)	Sets the value of a property that can be reached using a keypath. (Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString)	Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException. (Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary)	Sets the values of this NSObject to those in the specified dictionary. (Inherited from NSObject)
ToString()	Returns a string representation of the value of the current instance. (Inherited from NSObject)
Unbind(NSString)	(Inherited from NSObject)
Unbind(String)	(Inherited from NSObject)
UnregisterAllListeners()	Unregisters all event listeners.
UnregisterListener(IGKLocalPlayerListener)	Unregisters listener.
ValueForKey(NSString)	Returns the value of the property associated with the specified key. (Inherited from NSObject)
ValueForKeyPath(NSString)	Returns the value of a property that can be reached using a keypath. (Inherited from NSObject)
ValueForUndefinedKey(NSString)	Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException. (Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString)	Indicates that the values of the specified indices in the specified key are about to change. (Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
WillChangeValue(String)	Indicates that the value of the specified key is about to change. (Inherited from NSObject)

Extension Methods

GetDebugDescription(INSObjectProtocol)
DidModifySavedGame(IGKSavedGameListener, GKPlayer, GKSavedGame)
HasConflictingSavedGames(IGKSavedGameListener, GKPlayer, GKSavedGame[])
GetAccessibilityCustomRotors(NSObject)	Gets the array of UIAccessibilityCustomRotor objects appropriate for this object.
SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])	Sets the array of UIAccessibilityCustomRotor objects appropriate for this object.

See also

• Apple documentation for GKLocalPlayer