【Flutter】AndroidのPush通知使用許諾を表示する方法
どうもこんにちは、Ryo24です。
iOSでは、通知に関する実行権限を設定すると、自動的にユーザーに許可を求めるダイアログ(以後、通知使用許諾と呼称)が表示されます。一方、Androidでは、権限を設定しても自動的に通知使用許諾が表示されないため、起動時に表示するコードを書かなければなりません。
本記事では、Flutterを用いて作成したAndroidアプリで起動時に通知使用許諾を表示する方法について解説します
設定内容のみ知りたい方は、こちらからどうぞ。
(本記事はFlutter Advent Calendar 2023 6日目となります。)
通知設定
POST_NOTIFICATIONS (通知に関する実行権限)はAndroid 13（API レベル 33）以上をサポートしており、ドキュメントにもプロジェクトは13以上で作成することをを推奨しています。
プラットフォームの API を利用して権限をリクエストするには、Android 13 以降をターゲットとするようにアプリを更新することを強くおすすめします。
引用元: Android 12L（API レベル 32）以下をターゲットとするアプリの通知権限
通知使用許諾をリクエスト
通知使用許諾の最小限コード
// Declare the launcher at the top of your Activity/Fragment:
private val requestPermissionLauncher = registerForActivityResult(
ActivityResultContracts.RequestPermission(),
) { isGranted: Boolean ->
if (isGranted) {
// FCM SDK (and your app) can post notifications.
} else {
// TODO: Inform user that that your app will not show notifications.
}
}
private fun askNotificationPermission() {
// This is only necessary for API level >= 33 (TIRAMISU)
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
if (ContextCompat.checkSelfPermission(this, Manifest.permission.POST_NOTIFICATIONS) ==
PackageManager.PERMISSION_GRANTED
) {
// FCM SDK (and your app) can post notifications.
} else if (shouldShowRequestPermissionRationale(Manifest.permission.POST_NOTIFICATIONS)) {
// TODO: display an educational UI explaining to the user the features that will be enabled
// by them granting the POST_NOTIFICATION permission. This UI should provide the user
// "OK" and "No thanks" buttons. If the user selects "OK," directly request the permission.
// If the user selects "No thanks," allow the user to continue without notifications.
} else {
// Directly ask for the permission
requestPermissionLauncher.launch(Manifest.permission.POST_NOTIFICATIONS)
}
}
}
この中でregisterForActivityResult() が登場しており、これが一番のポイントです。
デフォルトのFlutterActivity() は registerForActivityResult() をサポートしていないため、他のclassを継承しなければなりません。
registerForActivityResult() とは？
ComponentActivity または Fragment の Activity Result API には、結果のコールバックを登録するための registerForActivityResult() が用意されています。registerForActivityResult() は ActivityResultContract と ActivityResultCallback を受け取って、他のアクティビティを開始するために使用する ActivityResultLauncher を返します。
引用元: アクティビティの結果に対してコールバックを登録する
より、プロジェクトは
- ComponentActivity
- Fragment
をサポートしていなければなりません。
FlutterFragmentActivity
FlutterFragmentActivityは、ComponentActivity を継承しており、registerForActivityResult() をサポートしているため、MainActivity は FlutterFragmentActivity で書き変えなければなりません。
コード変更点まとめ
通知に関する実行権限の設定
...
+ <uses-permission android:name="android.permission.POST_NOTIFICATIONS"/>
...
ライブラリやモジュールの追加
dependencies {
+ implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.8.20"
+ implementation 'androidx.activity:activity-ktx:1.7.2'
+ implementation 'androidx.fragment:fragment-ktx:1.6.0'
}
MainActivity
まとめ
-
AndroidManifest.xmlに通知に関する実行権限を追加 -
build.gradleに必要なライブラリやモジュールを追加 -
MainActivity.ktのコードを更新
上記の3点を実装することで、Flutterアプリで通知使用許諾を表示することができます。
Dart側でコードを書かず、ネイティブ側で実装する必要があるため、Flutterエンジニアにとってはネイティブの知識が必要になります。
さいごに
flutter_local_notificationsやfirebase_messagingなどPush通知ライブラリのドキュメントに通知使用許諾の表示方法が記載されておらず、実装時に困ったため、本記事を書きました。
本記事が通知使用許諾を表示する方法の参考になれば幸いです。
以上、THE KEBABSのTHE KEBABSを抱きしめてを聴き、大人になっても青春を謳歌したいRyo24でした。
サンプルプロジェクト
参考
Discussion