WKInterfaceController Class

Definition

Base class for controller objects in Watch Extension projects.

[Foundation.Register("WKInterfaceController", true)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.iOS, 8, 2, ObjCRuntime.PlatformArchitecture.All, null)]
public abstract class WKInterfaceController : Foundation.NSObject
type WKInterfaceController = class
    inherit NSObject
Inheritance
WKInterfaceController
Derived
Attributes

Remarks

Watch Kit Extensions extend WKInterfaceController to access the Watch App lifecycle.

When associated with a Watch App storyboard (the most common way in which a WKInterfaceController is instantiated), the C:WatchKit.WKInterfaceController.ctor(IntPtr) constructor is used. Application developers should use this and the Awake(NSObject) method to do the bulk of their initialization work.

Shortly before the Watch App's user interface appears to the user, the system calls the WillActivate() method. This method is also called if the app has been deactivated but not terminated. Developers should use this method for last-minute initialization and to, for instance, begin animations or other interface-related processes.

After the Watch App has been dismissed by the user, the system calls the DidDeactivate() method. After this method exits, the Watch Extension may perform no further processing. Pending asynchronous methods will not run. Watch Extension's may not use background processing modes. App devs who need to process data while the Watch Extension is deactivated must use the parent app to do so, communicating, as necessary, by using the OpenParentApplication(NSDictionary, Action<NSDictionary,NSError>) and HandleWatchKitExtensionRequest(UIApplication, NSDictionary, Action<NSDictionary>) methods.

Constructors

WKInterfaceController()

Default constructor, initializes a new instance of this class.

WKInterfaceController(IntPtr)

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

WKInterfaceController(NSObjectFlag)

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

Properties

Class (Inherited from NSObject)
ClassHandle

The handle for this class.

ContentFrame

The rectangle in which content is displayed. Measured in points.

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)
ErrorDomain

Defines the Watch Kit error domain.

Handle

Handle (pointer) to the unmanaged object representation.

(Inherited from NSObject)
IsDirectBinding (Inherited from NSObject)
IsProxy (Inherited from NSObject)
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

AddMenuItem(String, String, Action)

Adds an action to the context menu with the provide values.

AddMenuItem(String, String, Selector)

Adds an action to the context menu with the provide values.

AddMenuItem(UIImage, String, Action)

Adds an action to the context menu with the provide values.

AddMenuItem(UIImage, String, Selector)

Adds an action to the context menu with the provide values.

AddMenuItem(WKMenuItemIcon, String, Action)

Adds an action to the context menu with the provide values.

AddMenuItem(WKMenuItemIcon, String, Selector)

Adds an action to the context menu with the provide values.

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)
Awake(NSObject)

Main initialization method.

AwakeFromNib()

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

(Inherited from NSObject)
BecomeCurrentPage()

In a page-based UI, makes this the active controller.

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)
ClearAllMenuItems()

Removes programmatically-added items from the context menu.

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)
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)
DidDeactivate()

Called after the Watch App has been dismissed by the user.

DidSelectRow(WKInterfaceTable, nint)

Called when the user has selected a row in the table.

DismissController()

Dismisses a modally-presented WKInterfaceController.

DismissTextInputController()

Cancels text input and dismisses the text input controller.

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)
Equals(NSObject) (Inherited from NSObject)
Equals(Object) (Inherited from NSObject)
ExposedBindings() (Inherited from NSObject)
GetBindingInfo(NSString) (Inherited from NSObject)
GetBindingOptionDescriptions(NSString) (Inherited from NSObject)
GetBindingValueClass(NSString) (Inherited from NSObject)
GetContextForSegue(String)

Returns the context object to pass when the user taps a row in a table.

GetContextForSegue(String, WKInterfaceTable, nint)

Returns the context object to pass when the user taps a row in a table.

GetContextsForSegue(String)

Returns the context objects to pass when the user taps a row in a table.

GetContextsForSegue(String, WKInterfaceTable, nint)

Returns the context objects to pass when the user taps a row in a table.

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) (Inherited from NSObject)
GetNativeHash() (Inherited from NSObject)
HandleAction(String, UNNotification)

Method that is called to deliver notification payloads and actions to the interface controller.

HandleLocalNotificationAction(String, UILocalNotification)

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

HandleRemoteNotificationAction(String, NSDictionary)

Called on the Watch App's initial WKInterfaceController when the user reacts to a remote notification.

HandleUserActivity(NSDictionary)

Indicates that the Watch App was launched as a result of a Handoff action.

Init() (Inherited from NSObject)
InitializeHandle(IntPtr) (Inherited from NSObject)
InitializeHandle(IntPtr, String) (Inherited from NSObject)
InvalidateUserActivity()

Invalidates the most recent user activity.

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)
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)
OpenParentApplication(NSDictionary, Action<NSDictionary,NSError>)

Sends the provided data to the iOS application for the extension and passes the reply to the reply handler, if provided.

PerformSelector(Selector) (Inherited from NSObject)
PerformSelector(Selector, NSObject) (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, Double, NSString[]) (Inherited from NSObject)
PerformSelector(Selector, NSObject, NSObject) (Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean) (Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[]) (Inherited from NSObject)
PopController()

In a navigation interface, pops the current WKInterfaceController.

PopToRootController()

In a navigation interface, pops all WKInterfaceController except the root.

PrepareForInterfaceBuilder() (Inherited from NSObject)
PresentController(String, NSObject)

Modally presents a WKInterfaceController.

PresentController(String, String)

Modally presents a WKInterfaceController.

PresentController(String[], NSObject[])

Modally presents a page-based UI with the specified WKInterfaceControllers.

PresentController(String[], String[])

Modally presents a page-based UI with the specified WKInterfaceControllers.

PresentTextInputController(Func<NSString,NSArray>, WKTextInputMode, Action<NSArray>)

Presents a modal text input interface to the user, and runs a handler when the operation completes.

PresentTextInputController(String[], WKTextInputMode, Action<NSArray>)

Presents a modal text input interface to the user, and runs a handler when the operation completes.

PresentTextInputControllerAsync(Func<NSString,NSArray>, WKTextInputMode)

Presents a modal text input interface to the user, and runs a handler when the operation completes.

PresentTextInputControllerAsync(String[], WKTextInputMode)

Presents a modal text input interface to the user, and runs a handler when the operation completes.

PushController(String, NSObject)

In a navigation interface, initializes and displays a new WKInterfaceController.

PushController(String, String)

In a navigation interface, initializes and displays a new WKInterfaceController.

ReloadRootControllers(String[], NSObject[])

In a page-based UI, reloads the set of WKInterfaceControllers displayed.

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)

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)
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)

Whether this object recognizes the specified selector.

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

Sets the value of the specified key to null.

(Inherited from NSObject)
SetTitle(String)

Sets the title for the interface.

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)
UpdateUserActivity(String, NSDictionary, NSUrl)

Publishes information about the current activity for Handoff. At least one of userInfo or webpageURL must be set.

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)
WillActivate()

Called shortly before the WKInterfaceController appears to the user.

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)
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.

Applies to

See also