今回は以下のようなエラーが出力される場合の対応方法をご紹介いたします。
UIKit Consistency error : you are calling a UIKit method that you can only be invoked from the UI thread.
検索するとよく出てくる話なのですが、Xamarinで使用する場合、PCLからiOSのコードを呼び出したりしますが、その際の対応方法についてはどこにも載っていませんので自力で解決しました。
前提条件
・Windows10 Pro 64Bit
・Visual Studio 2015 Community Update3
・Xamarin 4.3.0.784 (NuGet Xamarin.Forms 2.3.4.224)
・macOS Sierra 10.12.4 / Xcode8.3.1 / Xamarin.iOS 10.4.0.123
1.原因について
このエラーは直訳すると 「UIKitのメソッドはUIスレッドからのみ呼び出しが可能」という事です。しかしながら、バックグラウンド処理から呼び出す場合など、主となるアプリのスレッドが存在しない場合があるため、例えばBackGround FetchからUIImageだとか、UILocalNotificationなどのクラスやメソッドを扱うことが基本的にはできないことから起因しています。
2.対応方法
よく検索すると、InvokeOnMainThreadで囲めば良いと書かれていますが、AppDelegate.cs内で使用する分にはその記述方法でOKですが、他のクラス(DependencyService等)で記述する場合はビルドエラーとなります。
なぜなら InvokeOnMainThread は NSObjectのメンバなので、有効なNSObjectを記述する必要があるからです。AppDelegate自体がNSObjectを継承していますので、AppDelegate内に記述する分には AppDelegate.InvokeOnMainThreadと解釈されて実行されていたのでしょう。
そこで、イメージピッカーでも使用していた記述方法なのですが、以下のように記述するとどこのクラスでも(iOSプロジェクト内に限る)正常に動作しました。
iOSプロジェクト内のcsファイル
UIApplication.SharedApplication.InvokeOnMainThread(delegate
{
UILocalNotification notification = new UILocalNotification();
});
InvokeOnMainThreadの前にUIApplication.SharedApplicationを付けるのがミソでした。
3.まとめ
InvokeOnMainThread について次の記事「非同期スレッドからコントロールオブジェクトを操作する方法」でまとめてみましたので、よろしければご参考ください。
当ブログの内容をまとめた Xamarin逆引きメニュー は以下のURLからご覧になれます。
https://itblog.dynaspo.com/blog-entry-81.html
- 関連記事
-