元のドキュメント： developer.apple.com/documentation/watchkit/wkinterfacecontroller

クラス

WKInterfaceController

watchOS アプリのインターフェースを管理するためのインフラストラクチャを提供するクラス。

@MainActor
class WKInterfaceController

概観

インターフェイスコントローラは、実際のビューを管理しない点を除けば、UIKit アプリにおける UIViewController オブジェクトと同様の役割を果たします。これは WatchKit 拡張機能内で動作し、Watch アプリのストーリーボードファイル内のインターフェイスコントローラに関連した動作をリモートで管理します。WKInterfaceController をサブクラス化し、そのメソッドを使用してストーリーボードシーンの要素を構成したり、それらの要素に対する操作に応答したりします。

あなたのインターフェイスコントローラのコードはユーザーの Apple Watch 上でローカルに実行されますが、そのコードが管理するインターフェイスとは分離されています。コード内でインターフェイスオブジェクトの値を変更すると、システムは必要な情報をあなたの Watch アプリに転送し、アプリが画面上でそれに応じた変更を行います。

インターフェースコントローラーの初期化

ユーザーがアプリのコンテンツを操作すると、システムはあなたの拡張機能を起動し、適切なインターフェイスコントローラオブジェクトを自動的に作成します。アプリは、通知用とアプリインターフェイスを管理するためにそれぞれ異なるインターフェイスコントローラを使用しますが、WatchKit はアプリのメインストーリーボードファイル内の情報に基づいて、どのインターフェイスコントローラをロードするかを決定します。通知シーンは、システムがそれらを識別できるように特別に構成されています。あなたのアプリの場合、WatchKit は起動時にアプリのメインインターフェイスコントローラを読み込みますが、起動時に初期インターフェイスコントローラに変更することも可能です。

インターフェイスコントローラを作成する際、WatchKit はそのクラスをインスタンス化し、init() メソッドを呼び出します。このメソッドは、変数の初期化やデータのロードには使用できますが、ユーザーインターフェイスの構成には使用しないでください。このメソッドが実行される時点では、コントローラのユーザーインターフェイス要素が適切に初期化されていない可能性があるためです。

次に、システムは awake(withContext:) メソッドを呼び出します。WatchKit が awake(withContext:) メソッドに有効なオブジェクトが渡された場合は、そのオブジェクトの情報を使用して初期化処理をカスタマイズしてください。また、この時点ではコントローラのユーザーインターフェイス要素が利用可能であることが保証されています。つまり、このメソッド内で安全にユーザーインターフェイスを構成できるということです。

willActivate() メソッドは、インターフェイスがアクティブになろうとしているタイミングを通知します。コンテンツの更新確認など、直前に行うべき処理には willActivate() メソッドを使用しますが、主要な初期化処理には使用しないでください。

willActivate() メソッドは、インターフェイスがまだ画面に表示されていないタイミングで呼び出されることがあります。例えば、コンテンツを更新する時間を確保するために、WatchKit が事前にこのメソッドを呼び出す場合があります。WatchKit はインターフェイスが表示状態になったことを、didAppear() メソッドの呼び出しによって通知します。同様に、WatchKit は、インターフェイスが再び画面から消える際には、willDisappear() および didDeactivate() メソッドを呼び出します。

iOS シミュレータでは、Hardware > Lock を選択してシミュレータをロックすると、WatchKit は現在のインターフェイスコントローラの didDeactivate() メソッドを呼び出します。その後シミュレータのロックを解除すると、WatchKit はそのインターフェイスコントローラの willActivate() メソッドを再び呼び出します。この機能を利用して、アクティベーションおよびディアクティベーションのコードをデバッグすることができます。

Interface Builder の構成オプション

Xcode では、ストーリーボードファイル内でインターフェイスコントローラに関する情報を構成できます。以下の表は、ストーリーボード内で構成可能な属性とその意味をまとめたものです。

サブクラス化に関する注意事項

実行時に構成が必要なストーリーボードシーンや、ユーザー操作を処理するシーンがある場合は、WKInterfaceController をサブクラス化します。通常、あなたのアプリが管理する各ストーリーボードシーンごとにカスタムサブクラスを定義して下さい。サブクラスでは、構成が必要なインターフェイスオブジェクトのアウトレットを定義し、ストーリーボードシーンの要素の操作に応答するアクションメソッドを定義します。

アプリで使用するほとんどのカスタムインターフェイスコントローラは、カスタムインターフェイスコントローラのサブクラスを必要とします。一見でさえ、一見の内容を更新するためにインターフェイスコントローラが必要です。カスタムインターフェイスコントローラを使用できない唯一のストーリーボードシーンは、静的通知インターフェイスに関連したシーンです。動的通知インターフェイスのインターフェイスコントローラを実装する場合は、代わりに WKUserNotificationInterfaceController をサブクラス化してください。

インターフェースの構成と表示準備に必要なクラスのメソッドをオーバーライドしてください。ほとんどのインターフェースコントローラは、init() メソッドと awake(withContext:) メソッドをオーバーライドします。必要に応じて、その他のメソッドもオーバーライドしてください。

トピックス

インターフェースコントローラの作成

init()

初期化されたインターフェイスコントローラオブジェクトを返します。

func awake(withContext: Any?)

指定されたコンテキストデータを使用して、インターフェイスコントローラを初期化します。

func setTitle(String?)

インターフェースのタイトルを設定します。

アクティベーションおよび表示イベントへの応答

func willActivate()

システムがビューをアクティブにしようとしていることを、インターフェイスコントローラに通知します。

func didDeactivate()

インターフェイスコントローラに対し、そのビューがもはやアクティブではないことを通知します。

func didAppear()

インターフェイスコントローラに対し、そのビューが画面上に表示されたことを通知します。

func willDisappear()

インターフェイスコントローラに対し、そのビューが画面外になったことを通知します。

ナビゲーションインターフェースの実装

func pushController(withName: String, context: Any?)

新しいインターフェースコントローラを画面上にプッシュします。

func pop()

現在のインターフェースコントローラを画面からポップします。

func popToRootController()

アプリの初期インターフェースコントローラを除く、すべてのインターフェースコントローラをポップします。

func performSegue(forRow:)

指定された行に対してセグエを実行します。

インターフェイスコントローラをモーダルで表示する

func presentController(withName: String, context: Any?)

単一のインターフェースコントローラをモーダルで表示します。

func presentController(withNames: [String], contexts: [Any]?)

ページを基本としたインターフェイスをモーダルで表示します。

func presentController(withNamesAndContexts: [(name: String, context: AnyObject)])

ページを基本としたインターフェイスをモーダルで表示します。

func presentAlert(withTitle: String?, message: String?, preferredStyle: WKAlertControllerStyle, actions: [WKAlertAction])

現在のインターフェースコントローラ上に、アラートまたはアクションシートを表示します。

enum WKAlertControllerStyle

標準システムアラートのスタイルを示す定数。

func dismiss()

現在のインターフェースコントローラを画面から閉じます。

ページを基礎としたインターフェースを操作する

class func reloadRootPageControllers(withNames: [String], contexts: [Any]?, orientation: WKPageOrientation, pageIndex: Int)

指定されたインターフェイスコントローラをロードし、与えられたスクロール方向に合わせてアプリのページを基礎としたインターフェイスを再構築します。

enum WKPageOrientation

ページを基礎としたインターフェースにおけるスクロール方向。

class func reloadRootControllers(withNamesAndContexts: [(name: String, context: AnyObject)])

指定されたインターフェイスコントローラをロードし、アプリのページを基礎としたインターフェイスを再構築します。

func becomeCurrentPage()

ページを基礎としたインターフェイスで、インターフェイスコントローラーを表示します。

セグエによる画面遷移の管理

func contextForSegue(withIdentifier: String) -> Any?

ボタンがタップされたときに、指定されたインターフェイスコントローラに渡すべきコンテキストオブジェクトを返します。

func contextsForSegue(withIdentifier: String) -> [Any]?

ボタンがタップされた際に、ページを基礎としたインターフェースコントローラーのセットへ渡すべきコンテキストオブジェクトを返します。

func contextForSegue(withIdentifier: String, in: WKInterfaceTable, rowIndex: Int) -> Any?

表内の行がタップされた際に、指定されたインターフェイスコントローラに渡すべきコンテキストオブジェクトを返します。

func contextsForSegue(withIdentifier: String, in: WKInterfaceTable, rowIndex: Int) -> [Any]?

表内の行がタップされたときにページを基礎としたインターフェイスコントローラーのセットに渡すべきコンテキストオブジェクトを返します。

スクロールの管理

func scroll(to: WKInterfaceObject, at: WKInterfaceScrollPosition, animated: Bool)

指定されたオブジェクトを、画面上の与えられた位置までスクロールします。

enum WKInterfaceScrollPosition

画面上のスクロール位置。

func interfaceDidScrollToTop()

ユーザーが「トップへスクロール」するジェスチャ（ステータスバーのタップなど）を行い、スクロールのアニメーションが完了したことをインターフェースコントローラに通知します。

func interfaceOffsetDidScrollToTop()

ユーザーがインターフェースの最上部までスクロールし、スクロールのアニメーションが完了したことをインターフェースコントローラーに通知します。

func interfaceOffsetDidScrollToBottom()

ユーザーがインターフェースの最下部までスクロールし、スクロールのアニメーションが完了したことをインターフェースコントローラーに通知します。

var isTableScrollingHapticFeedbackEnabled: Bool

ユーザーが表をスクロールする際、新しい行の表示に合わせて触覚のフィードバックを行うかどうかを決定するブール値。

安全領域とレイアウトの余白を尊重する

var contentSafeAreaInsets: UIEdgeInsets

画面上でコンテンツを安全に表示できる領域を定義する挿入物。

var systemMinimumLayoutMargins: NSDirectionalEdgeInsets

テキスト要素の最小レイアウトの余白を表す、先頭および末尾の挿入物。

var contentFrame: CGRect

アプリのコンテンツを表示するために使用されるフレームの長方形。

インターフェースの変更をアニメーション化する

func animate(withDuration: TimeInterval, animations: () -> Void)

指定された期間にわたり、1 つ以上のインターフェイスオブジェクトの変更をアニメーション化します。

テキスト入力の処理

func presentTextInputController(withSuggestions: [String]?, allowedInputMode: WKTextInputMode, completion: ([Any]?) -> Void)

ユーザーからテキスト入力収集するためのモーダルインターフェースを表示します。

func presentTextInputControllerWithSuggestions(forLanguage: ((String) -> [Any]?)?, allowedInputMode: WKTextInputMode, completion: ([Any]?) -> Void)

ユーザーから言語固有のテキスト入力を収集するためのモーダルインターフェースを表示します。

func dismissTextInputController()

テキストを返さずに、テキスト入力コントローラーを閉じます。

enum WKTextInputMode

テキスト入力コントローラーによってサポートされる入力モード。

映像・音声インターフェースの表示

func presentMediaPlayerController(with: URL, options: [AnyHashable : Any]?, completion: (Bool, TimeInterval, (any Error)?) -> Void)

指定されたメディアファイルを再生するためのモーダルインターフェースを表示します。

メディアプレーヤーのオプション

メディア再生オプションを示すキー。

func dismissMediaPlayerController()

メディアインターフェースコントローラーを閉じます。

func presentAudioRecorderController(withOutputURL: URL, preset: WKAudioRecorderPreset, options: [AnyHashable : Any]?, completion: (Bool, (any Error)?) -> Void)

ユーザーの Apple Watch から音声を録音するための標準インターフェイスを表示します。

enum WKAudioRecorderPreset

音声録音の品質を示す定数。

音声録音オプション

音声を録音する際に指定すべきオプション。

func dismissAudioRecorderController()

音声録音インターフェースコントローラーを閉じます。

表の行の選択処理

func table(WKInterfaceTable, didSelectRowAt: Int)

ユーザーが表内の行を選択したことを通知するために呼び出されます。

ピッカーの管理

func pickerDidFocus(WKInterfacePicker)

指定されたピッカーが、Digital Crown からの入力を受け付けるようになったことを通知するために呼び出されます。

func pickerDidResignFocus(WKInterfacePicker)

指定されたピッカーが、Digital Crown からの入力を受け付けなくなったことを通知するために呼び出されます。

func pickerDidSettle(WKInterfacePicker)

ユーザーがピッカーで値を確定した際に呼び出されます。

crown (竜頭) のシーケンサーの入手

var crownSequencer: WKCrownSequencer

竜頭のイベントを直接追跡する際に使用するオブジェクト。

引き継ぎ業務の調整

func update(NSUserActivity)

現在のユーザーの操作をシステムに登録します。

func invalidateUserActivity()

直近のユーザーアクティビティを無効にします。

PassKit パスの追加

func presentAddPassesController(withPasses: [PKPass], completion: () -> Void)

ユーザーにパスを提示するためのモーダルインターフェイスを表示します。

func dismissAddPassesController()

パス・インターフェース・コントローラーを閉じます。

通知の管理

let WKAccessibilityVoiceOverStatusChanged: String

VoiceOver の状態が変化したことをインターフェイスコントローラに通知します。

廃止されたシンボル

テキスト応答キー

テキスト応答情報を取得するためのキー。

func addMenuItem(withImageNamed: String, title: String, action: Selector)

Watch アプリのバンドルに含まれる既存の画像リソースを使用して、コンテキストメニューにアクションを追加します。

  廃止  

func addMenuItem(with: WKMenuItemIcon, title: String, action: Selector)

システム提供のアイコンを使用して、コンテキストメニューにアクションを追加します。

  廃止  

func addMenuItem(with: UIImage, title: String, action: Selector)

WatchKit 拡張機能が提供する画像を使用して、コンテキストメニューにアクションを追加します。

  廃止  

func beginGlanceUpdates()

Glance（グランス）の更新タスク（長時間に及ぶ可能性があるもの）を開始しようとしていることをシステムに通知します。

  廃止  

func clearAllMenuItems()

コンテキストメニューから、プログラムによって追加されたすべてのアクションを削除します。

  廃止  

func endGlanceUpdates()

Glance コンテンツの更新が完了したことをシステムに通知します。

  廃止  

func handleUserActivity([AnyHashable : Any]?)

Handoff 関連のアクティビティに応答します。

  廃止  

func presentController([(name: String, context: AnyObject)])

ページを基礎としたインターフェイスをモーダル表示します。

  廃止  

class func reloadRootControllers(withNames: [String], contexts: [Any]?)

指定されたインターフェイスコントローラをロードし、アプリのページを基礎としたインターフェイスを再構築します。

  廃止  

func updateUserActivity(String, userInfo: [AnyHashable : Any]?, webpageURL: URL?)

現在のユーザーの操作をシステムに登録します。

  廃止  

enum WKMenuItemIcon

メニューに使用できるテンプレート画像。

  廃止  

関連

以下からの継承

NSObject

以下により継承

WKUserNotificationInterfaceController

以下に準拠

CVarArg

CustomDebugStringConvertible

CustomStringConvertible

Equatable

Hashable

NSObjectProtocol

Sendable

以下も見よ

ユーザーインターフェースの基本

Storyboard を使用した watchOS アプリのインターフェースの構築

class WKInterfaceObject

あなたの watchOS アプリ内のすべてのインターフェイスオブジェクトに共通する情報を提供するオブジェクト。

class WKAlertAction

アラートやアクションシートに表示されるボタンに関する情報をカプセル化するオブジェクト。

class WKAccessibilityImageRegion

支援アプリに対して個別に強調表示したいイメージの一部を定義するオブジェクト。

func WKAccessibilityIsVoiceOverRunning() -> Bool

VoiceOver が実行中かどうかを示すブール値を返します。

func WKAccessibilityIsReduceMotionEnabled() -> Bool

軽減動作が有効になっているかどうかを示すブール値を返します。