GKTurnBasedMatch GKTurnBasedMatch Class

Definition

A type of game match that uses store-and-forward to share data and allow for asynchronous turn-taking.

[Foundation.Register("GKTurnBasedMatch", true)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.WatchOS, 3, 0, ObjCRuntime.PlatformArchitecture.All, null)]
public class GKTurnBasedMatch : Foundation.NSObject
type GKTurnBasedMatch = class
    inherit NSObject
Inheritance
GKTurnBasedMatchGKTurnBasedMatch
Attributes

Constructors

GKTurnBasedMatch() GKTurnBasedMatch()

Default constructor that initializes a new instance of this class with no parameters.

GKTurnBasedMatch(IntPtr) GKTurnBasedMatch(IntPtr)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

GKTurnBasedMatch(NSObjectFlag) GKTurnBasedMatch(NSObjectFlag)

Constructor to call on derived classes to skip initialization and merely allocate the object.

Properties

ActiveExchanges ActiveExchanges

Gets an array that contains the active exchanges for the local player.

Class Class Inherited from NSObject
ClassHandle ClassHandle

The handle for this class.

CompletedExchanges CompletedExchanges

Gets an array that contains the completed exchanges for the local player.

CreationDate CreationDate

Gets the match creation date.

CurrentParticipant CurrentParticipant

Gets the participant who is currently able to update match data.

DebugDescription DebugDescription

A developer-meaningful description of this object.

(Inherited from NSObject)
DefaultTimeout DefaultTimeout

Represents the value associated with the constant GKTurnTimeoutDefault

Description Description

Description of the object, the Objective-C version of ToString.

(Inherited from NSObject)
ExchangeMaxInitiatedExchangesPerPlayer ExchangeMaxInitiatedExchangesPerPlayer

Gets the maximum number of active exchanges that the player can have initiated.

Exchanges Exchanges

Gets an array that contains the exchanges that are in progress for the match.

ExhangeDataMaximumSize ExhangeDataMaximumSize

Gets the maximum size of exchange data.

Handle Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from NSObject)
IsDirectBinding IsDirectBinding Inherited from NSObject
IsProxy IsProxy Inherited from NSObject
MatchData MatchData

Gets the match data.

MatchDataMaximumSize MatchDataMaximumSize

Gets the match data maximum size.

MatchID MatchID

Gets the identifer for the match.

Message Message

Gets or sets a message that is displayed to all the players in the match.

NoTimeout NoTimeout

Represents the value associated with the constant GKTurnTimeoutNone

Participants Participants

Gets the list of participants in the match.

RetainCount RetainCount

Returns the current Objective-C retain count for the object.

(Inherited from NSObject)
Self Self Inherited from NSObject
Status Status

The current match status.

Superclass Superclass Inherited from NSObject
SuperHandle SuperHandle

Handle used to represent the methods in the base class for this NSObject.

(Inherited from NSObject)
Zone Zone Inherited from NSObject

Methods

AcceptInvite(Action<GKTurnBasedMatch,NSError>) AcceptInvite(Action<GKTurnBasedMatch,NSError>)

Accepts an invitation to a match and then passes a new match object to completionHandler, along with an error object that is null if no error occurred.

AcceptInviteAsync() AcceptInviteAsync()

Accepts an invitation to a match and then passes a new match object to completionHandler, along with an error object that is null if no error occurred.

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr) 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) 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>) AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>) AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)

Registers an object for being observed externally using an arbitrary method.

(Inherited from NSObject)
AwakeFromNib() AwakeFromNib()

Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib().

(Inherited from NSObject)
BeginInvokeOnMainThread(Action) BeginInvokeOnMainThread(Action) Inherited from NSObject
BeginInvokeOnMainThread(Selector, NSObject) BeginInvokeOnMainThread(Selector, NSObject)

Invokes asynchrously the specified code on the main UI thread.

(Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary) Bind(NSString, NSObject, String, NSDictionary) Inherited from NSObject
Bind(String, NSObject, String, NSDictionary) Bind(String, NSObject, String, NSDictionary) Inherited from NSObject
BindingInfo(String) BindingInfo(String) Inherited from NSObject
BindingOptionDescriptions(String) BindingOptionDescriptions(String) Inherited from NSObject
BindingValueClass(String) BindingValueClass(String) Inherited from NSObject
CommitEditing() CommitEditing() Inherited from NSObject
CommitEditing(NSObject, Selector, IntPtr) CommitEditing(NSObject, Selector, IntPtr) Inherited from NSObject
ConformsToProtocol(IntPtr) ConformsToProtocol(IntPtr)

Invoked to determine if this object implements the specified protocol.

(Inherited from NSObject)
Copy() Copy()

Performs a copy of the underlying Objective-C object.

(Inherited from NSObject)
DangerousAutorelease() DangerousAutorelease() Inherited from NSObject
DangerousRelease() DangerousRelease() Inherited from NSObject
DangerousRetain() DangerousRetain() Inherited from NSObject
DeclineInvite(Action<GKTurnBasedMatch,NSError>) DeclineInvite(Action<GKTurnBasedMatch,NSError>)

Declines an invitation to a match and then passes a new match object to completionHandler, along with an error object that is null if no error occurred.

DeclineInviteAsync() DeclineInviteAsync()

Declines an invitation to a match and then passes a new match object to completionHandler, along with an error object that is null if no error occurred.

DidChange(NSKeyValueChange, NSIndexSet, NSString) DidChange(NSKeyValueChange, NSIndexSet, NSString)

Indicates a change occurred to the indexes for a to-many relationship.

(Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet) DidChange(NSString, NSKeyValueSetMutationKind, NSSet) Inherited from NSObject
DidChangeValue(String) DidChangeValue(String)

Indicates that a change occurred on the specified key.

(Inherited from NSObject)
Dispose() Dispose()

Releases the resources used by the NSObject object.

(Inherited from NSObject)
Dispose(Boolean) Dispose(Boolean)

Releases the resources used by the NSObject object.

(Inherited from NSObject)
DoesNotRecognizeSelector(Selector) DoesNotRecognizeSelector(Selector)

Indicates that this object does not recognize the specified selector.

(Inherited from NSObject)
EndMatchInTurn(NSData, Action<NSError>) EndMatchInTurn(NSData, Action<NSError>)

Ends the match with the end state matchData and passes an error object that is null if no error occurred to completionHandler.

EndMatchInTurn(NSData, GKScore[], GKAchievement[], Action<NSError>) EndMatchInTurn(NSData, GKScore[], GKAchievement[], Action<NSError>)

Ends the match with the specified end state, scores, and achievements, and passes an error object that is null if no error occurred to completionHandler.

EndMatchInTurnAsync(NSData) EndMatchInTurnAsync(NSData)

Ends the match with the specified end state, scores, and achievements, and passes an error object that is null if no error occurred to completionHandler.

EndMatchInTurnAsync(NSData, GKScore[], GKAchievement[]) EndMatchInTurnAsync(NSData, GKScore[], GKAchievement[])

Asynchronously the specified end state, scores, and achievements.

EndTurn(GKTurnBasedParticipant[], Double, NSData, Action<NSError>) EndTurn(GKTurnBasedParticipant[], Double, NSData, Action<NSError>)

Ends the turn and passes an error object that is null if no error occurred to completionHandler.

EndTurnAsync(GKTurnBasedParticipant[], Double, NSData) EndTurnAsync(GKTurnBasedParticipant[], Double, NSData)

Ends the turn and passes an error object that is null if no error occurred to completionHandler.

EndTurnWithNextParticipant(GKTurnBasedParticipant, NSData, Action<NSError>) EndTurnWithNextParticipant(GKTurnBasedParticipant, NSData, Action<NSError>)

Developers should not use this deprecated method. Developers should use 'EndTurn' instead.

EndTurnWithNextParticipantAsync(GKTurnBasedParticipant, NSData) EndTurnWithNextParticipantAsync(GKTurnBasedParticipant, NSData)

Developers should not use this deprecated method. Developers should use 'EndTurn' instead.

Equals(NSObject) Equals(NSObject) Inherited from NSObject
Equals(Object) Equals(Object) Inherited from NSObject
ExposedBindings() ExposedBindings() Inherited from NSObject
FindMatch(GKMatchRequest, GKTurnBasedMatchRequest) FindMatch(GKMatchRequest, GKTurnBasedMatchRequest)

Searches for and returns a match to join, and passes the match (which is null if an error occurs) and an error object (whic is null if there is no error) to onCompletion.

FindMatchAsync(GKMatchRequest) FindMatchAsync(GKMatchRequest)

Searches for and returns a match to join, and passes the match (which is null if an error occurs) and an error object (whic is null if there is no error) to onCompletion.

GetBindingInfo(NSString) GetBindingInfo(NSString) Inherited from NSObject
GetBindingOptionDescriptions(NSString) GetBindingOptionDescriptions(NSString) Inherited from NSObject
GetBindingValueClass(NSString) GetBindingValueClass(NSString) Inherited from NSObject
GetDictionaryOfValuesFromKeys(NSString[]) GetDictionaryOfValuesFromKeys(NSString[])

Retrieves the values of the specified keys.

(Inherited from NSObject)
GetHashCode() GetHashCode()

Generates a hash code for the current instance.

(Inherited from NSObject)
GetMethodForSelector(Selector) GetMethodForSelector(Selector) Inherited from NSObject
GetNativeField(String) GetNativeField(String) Inherited from NSObject
GetNativeHash() GetNativeHash() Inherited from NSObject
Init() Init() Inherited from NSObject
InitializeHandle(IntPtr) InitializeHandle(IntPtr) Inherited from NSObject
InitializeHandle(IntPtr, String) InitializeHandle(IntPtr, String) Inherited from NSObject
Invoke(Action, Double) Invoke(Action, Double) Inherited from NSObject
Invoke(Action, TimeSpan) Invoke(Action, TimeSpan) Inherited from NSObject
InvokeOnMainThread(Action) InvokeOnMainThread(Action) Inherited from NSObject
InvokeOnMainThread(Selector, NSObject) InvokeOnMainThread(Selector, NSObject)

Invokes synchrously the specified code on the main UI thread.

(Inherited from NSObject)
IsEqual(NSObject) IsEqual(NSObject) Inherited from NSObject
IsKindOfClass(Class) IsKindOfClass(Class) Inherited from NSObject
IsMemberOfClass(Class) IsMemberOfClass(Class) Inherited from NSObject
LoadMatch(String, Action<GKTurnBasedMatch,NSError>) LoadMatch(String, Action<GKTurnBasedMatch,NSError>)

Loads the match that is identified by matchId and passes the match (which is null if an error occurs) and an error object (whic is null if there is no error) to onCompletion.

LoadMatchAsync(String) LoadMatchAsync(String)

Loads the match that is identified by matchId and passes the match (which is null if an error occurs) and an error object (whic is null if there is no error) to onCompletion.

LoadMatchData(GKTurnBasedMatchData) LoadMatchData(GKTurnBasedMatchData)

Loads the match data and passes it, along with an error object, to onCompletion.

LoadMatchDataAsync() LoadMatchDataAsync()

Loads the match data and passes it, along with an error object, to onCompletion.

LoadMatches(GKTurnBasedMatchesRequest) LoadMatches(GKTurnBasedMatchesRequest)

Loads all the matches for the current player and passes them, along with an error object, to onCompletion..

LoadMatchesAsync() LoadMatchesAsync()

Loads all the matches for the current player and passes them, along with an error object, to onCompletion..

MarkDirty() MarkDirty()

Promotes a regular peer object (IsDirectBinding is true) into a toggleref object.

(Inherited from NSObject)
MutableCopy() MutableCopy()

Creates a mutable copy of the specified NSObject.

(Inherited from NSObject)
ObjectDidEndEditing(NSObject) ObjectDidEndEditing(NSObject) Inherited from NSObject
ObserveValue(NSString, NSObject, NSDictionary, IntPtr) ObserveValue(NSString, NSObject, NSDictionary, IntPtr)

Indicates that the value at the specified keyPath relative to this object has changed.

(Inherited from NSObject)
ParticipantQuitInTurn(GKTurnBasedMatchOutcome, GKTurnBasedParticipant, NSData, Action<NSError>) ParticipantQuitInTurn(GKTurnBasedMatchOutcome, GKTurnBasedParticipant, NSData, Action<NSError>)

Deprecated.

ParticipantQuitInTurn(GKTurnBasedMatchOutcome, GKTurnBasedParticipant[], Double, NSData, Action<NSError>) ParticipantQuitInTurn(GKTurnBasedMatchOutcome, GKTurnBasedParticipant[], Double, NSData, Action<NSError>)

Resigns the current player from the match and runs completionHandler.

ParticipantQuitInTurnAsync(GKTurnBasedMatchOutcome, GKTurnBasedParticipant, NSData) ParticipantQuitInTurnAsync(GKTurnBasedMatchOutcome, GKTurnBasedParticipant, NSData)

Deprecated.

ParticipantQuitInTurnAsync(GKTurnBasedMatchOutcome, GKTurnBasedParticipant[], Double, NSData) ParticipantQuitInTurnAsync(GKTurnBasedMatchOutcome, GKTurnBasedParticipant[], Double, NSData)

Resigns the current player from the match and runs completionHandler.

ParticipantQuitOutOfTurn(GKTurnBasedMatchOutcome, Action<NSError>) ParticipantQuitOutOfTurn(GKTurnBasedMatchOutcome, Action<NSError>)

Resigns the player from the match out of turn and runs onCompletion.

ParticipantQuitOutOfTurnAsync(GKTurnBasedMatchOutcome) ParticipantQuitOutOfTurnAsync(GKTurnBasedMatchOutcome)

Resigns the player from the match out of turn and runs onCompletion.

PerformSelector(Selector) PerformSelector(Selector) Inherited from NSObject
PerformSelector(Selector, NSObject) PerformSelector(Selector, NSObject) Inherited from NSObject
PerformSelector(Selector, NSObject, Double) 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, Double, NSString[]) PerformSelector(Selector, NSObject, Double, NSString[]) Inherited from NSObject
PerformSelector(Selector, NSObject, NSObject) PerformSelector(Selector, NSObject, NSObject) Inherited from NSObject
PerformSelector(Selector, NSThread, NSObject, Boolean) PerformSelector(Selector, NSThread, NSObject, Boolean) Inherited from NSObject
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) Inherited from NSObject
PrepareForInterfaceBuilder() PrepareForInterfaceBuilder() Inherited from NSObject
Rematch(Action<GKTurnBasedMatch,NSError>) Rematch(Action<GKTurnBasedMatch,NSError>)

Creates a new match with the same list of participants as the current match, and runs completionHanler.

RematchAsync() RematchAsync()

Creates a new match with the same list of participants as the current match, and runs completionHanler.

Remove(Action<NSError>) Remove(Action<NSError>)

Removes the match from the Game Center and runs oncCompletion.

RemoveAsync() RemoveAsync()

Removes the match from the Game Center and runs oncCompletion.

RemoveObserver(NSObject, NSString) RemoveObserver(NSObject, NSString)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, NSString, IntPtr) 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, String) RemoveObserver(NSObject, String)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath.

(Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr) RemoveObserver(NSObject, String, IntPtr)

Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context.

(Inherited from NSObject)
RespondsToSelector(Selector) RespondsToSelector(Selector)

Whether this object recognizes the specified selector.

(Inherited from NSObject)
SaveCurrentTurn(NSData, Action<NSError>) SaveCurrentTurn(NSData, Action<NSError>)

Saves the current turn, does not advance to the next player, and runs oncCompletion.

SaveCurrentTurnAsync(NSData) SaveCurrentTurnAsync(NSData)

Saves the current turn, does not advance to the next player, and runs oncCompletion.

SaveMergedMatchData(NSData, GKTurnBasedExchange[], Action<NSError>) SaveMergedMatchData(NSData, GKTurnBasedExchange[], Action<NSError>)

Saves merged match data without advancing play, and runs completionHandler when finished.

SaveMergedMatchDataAsync(NSData, GKTurnBasedExchange[]) SaveMergedMatchDataAsync(NSData, GKTurnBasedExchange[])

Saves merged match data without advancing play, and runs completionHandler when finished.

SendExchange(GKTurnBasedParticipant[], NSData, String, NSObject[], Double, Action<GKTurnBasedExchange,NSError>) SendExchange(GKTurnBasedParticipant[], NSData, String, NSObject[], Double, Action<GKTurnBasedExchange,NSError>)

Sends exchange requests to the players who are listed in participants.

SendExchangeAsync(GKTurnBasedParticipant[], NSData, String, NSObject[], Double) SendExchangeAsync(GKTurnBasedParticipant[], NSData, String, NSObject[], Double)

Sends exchange requests to the players who are listed in participants.

SendReminder(GKTurnBasedParticipant[], String, NSObject[], Action<NSError>) SendReminder(GKTurnBasedParticipant[], String, NSObject[], Action<NSError>)

Sends a reminder to the players who are listed in participants.

SendReminderAsync(GKTurnBasedParticipant[], String, NSObject[]) SendReminderAsync(GKTurnBasedParticipant[], String, NSObject[])

Sends a reminder to the players who are listed in participants.

SetMessage(String, NSObject[]) SetMessage(String, NSObject[])

Sets a localizable message that will be displayed at the end of the match.

SetNativeField(String, NSObject) SetNativeField(String, NSObject) Inherited from NSObject
SetNilValueForKey(NSString) SetNilValueForKey(NSString)

Sets the value of the specified key to null.

(Inherited from NSObject)
SetValueForKey(NSObject, NSString) SetValueForKey(NSObject, NSString)

Sets the value of the property specified by the key to the specified value.

(Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString) SetValueForKeyPath(IntPtr, NSString)

A constructor used when creating managed representations of unmanaged objects; Called by the runtime.

(Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString) SetValueForKeyPath(NSObject, NSString)

Sets the value of a property that can be reached using a keypath.

(Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString) 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) SetValuesForKeysWithDictionary(NSDictionary)

Sets the values of this NSObject to those in the specified dictionary.

(Inherited from NSObject)
ToString() ToString()

Returns a string representation of the value of the current instance.

(Inherited from NSObject)
Unbind(NSString) Unbind(NSString) Inherited from NSObject
Unbind(String) Unbind(String) Inherited from NSObject
ValueForKey(NSString) ValueForKey(NSString)

Returns the value of the property associated with the specified key.

(Inherited from NSObject)
ValueForKeyPath(NSString) ValueForKeyPath(NSString)

Returns the value of a property that can be reached using a keypath.

(Inherited from NSObject)
ValueForUndefinedKey(NSString) 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) 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) WillChange(NSString, NSKeyValueSetMutationKind, NSSet) Inherited from NSObject
WillChangeValue(String) WillChangeValue(String)

Indicates that the value of the specified key is about to change.

(Inherited from NSObject)

Extension Methods

ObjectDidBeginEditing(NSObject, INSEditor) ObjectDidBeginEditing(NSObject, INSEditor)
ObjectDidEndEditing(NSObject, INSEditor) ObjectDidEndEditing(NSObject, INSEditor)
GetValidModes(NSObject, NSFontPanel) GetValidModes(NSObject, NSFontPanel)
ValidateToolbarItem(NSObject, NSToolbarItem) ValidateToolbarItem(NSObject, NSToolbarItem)
GetDebugDescription(INSObjectProtocol) GetDebugDescription(INSObjectProtocol)
AcceptsPreviewPanelControl(NSObject, QLPreviewPanel) AcceptsPreviewPanelControl(NSObject, QLPreviewPanel)
BeginPreviewPanelControl(NSObject, QLPreviewPanel) BeginPreviewPanelControl(NSObject, QLPreviewPanel)
EndPreviewPanelControl(NSObject, QLPreviewPanel) EndPreviewPanelControl(NSObject, QLPreviewPanel)
GetAccessibilityCustomRotors(NSObject) GetAccessibilityCustomRotors(NSObject)

Gets the array of UIAccessibilityCustomRotor objects appropriate for this object.

SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[]) SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])

Sets the array of UIAccessibilityCustomRotor objects appropriate for this object.

Applies to

See also