AndroidConfig に含めることができる Android 固有の通知オプションを表します。
署名:
export interface AndroidNotification
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| body | 文字列 | Android 通知の本文。指定すると、admin.messaging.Notification で設定された本文がオーバーライドされます。 |
| bodyLocArgs | string[] | bodyLocKey でフォーマット指定子の代わりに使用されるリソースキーの配列。 |
| bodyLocKey | 文字列 | 本文テキストのローカライズに使用する、アプリの文字列リソース内の本文文字列のキー。 |
| channelId | 文字列 | Android 通知チャンネル ID（Android O の新機能）。このチャンネル ID を持つ通知を受信するには、アプリでこのチャンネル ID のチャンネルを作成する必要があります。リクエストでこのチャンネル ID を送信しない場合、または提供されたチャンネル ID がアプリによってまだ作成されていない場合、FCM はアプリ マニフェストで指定されたチャンネル ID を使用します。 |
| clickAction | 文字列 | 通知をクリックするユーザーに関連付けられたアクション。指定すると、ユーザーが通知をクリックしたときに、一致するインテント フィルタを持つアクティビティが起動されます。 |
| 色 | 文字列 | 通知アイコンの色（#rrggbb 形式）。 |
| defaultLightSettings | ブール値 | true に設定した場合、通知に Android フレームワークのデフォルトの LED ライト設定が使用されます。デフォルト値は config.xml で指定します。default_light_settings が true に設定され、light_settings も設定されている場合は、デフォルト値の代わりにユーザー指定の light_settings が使用されます。 |
| defaultSound | ブール値 | true に設定した場合、通知に Android フレームワークのデフォルトの音が使用されます。デフォルト値は config.xml で指定します。 |
| defaultVibrateTimings | ブール値 | true に設定した場合、通知に Android フレームワークのデフォルトのバイブレーション パターンが使用されます。デフォルト値は config.xml で指定します。default_vibrate_timings が true に設定され、vibrate_timings も設定されている場合は、ユーザー指定の vibrate_timings の代わりにデフォルト値が使用されます。 |
| eventTimestamp | 日付 | 絶対時間参照を使用してイベントについてユーザーに通知する通知の場合は、通知のイベントが発生した時刻を設定します。パネル内の通知は、この時間順に並べ替えられます。 |
| アイコン | 文字列 | Android の通知のアイコン リソース。 |
| imageUrl | 文字列 | 通知に表示する画像の URL。 |
| lightSettings | ライトの設定 | LED が使用可能なデバイスであれば、通知の LED の点滅速度と色を制御する設定です。点滅の合計時間は OS によって制御されます。 |
| localOnly | ブール値 | この通知が現在のデバイスにのみ関連するかどうかを設定します。一部の通知は、Wear OS スマートウォッチなど、他のデバイスにブリッジしてリモート表示することができます。このヒントを設定すると、この通知がブリッジされないよう推奨できます。Wear OS ガイドをご覧ください。 |
| notificationCount | 数値 | この通知が表すアイテム数を設定します。バッジ機能に対応しているランチャーでは、バッジ数として表示できます。NotificationBadge をご覧ください。たとえば、複数の新着メッセージを表示するために 1 つの通知のみを使用しているものの、ここでのカウントで新着メッセージの合計数を表す場合、これは便利です。値が 0 または指定されていない場合、バッジをサポートするシステムではデフォルトの値が使用されます。つまり、新しい通知が届くたびに、長押しメニューに表示される数字が増加します。 |
| 優先度 | ('min' | 'low' | 'default' | 'high' | 'max') | この通知の相対的な優先度を設定します。優先度の低い通知は、特定の状況でユーザーに表示されない場合があります。この優先度は AndroidMessagePriority とは異なります。この優先度は、メッセージの配信後にクライアントによって処理されます。一方、AndroidMessagePriority はメッセージの配信のタイミングを制御する FCM のコンセプトです。 |
| サウンド | 文字列 | デバイスが通知を受信したときに再生される音のファイル名。 |
| 固定 | ブール値 | false に設定するか未設定のままにした場合、ユーザーがパネルで通知をクリックすると、通知は自動的に閉じます。true に設定すると、ユーザーがクリックしても通知は表示されます。 |
| タグ | 文字列 | 通知タグ。これは、通知ドロワー内の既存の通知を置き換えるために使用される識別子です。指定しない場合、リクエストごとに新しい通知が作成されます。 |
| ティッカー | 文字列 | 「ティッカー」を設定します。テキストがユーザー補助サービスに送信されます。API レベル 21（Lollipop）より前では、通知が最初に到着したときにステータスバーに表示されるテキストを設定します。 |
| title | 文字列 | Android 通知のタイトル。指定すると、admin.messaging.Notification で設定されたタイトルがオーバーライドされます。 |
| titleLocArgs | string[] | titleLocKey でフォーマット指定子の代わりに使用されるリソースキーの配列。 |
| titleLocKey | 文字列 | タイトル テキストのローカライズに使用する、アプリの文字列リソース内のタイトル文字列のキー。 |
| vibrateTimingsMillis | 数値 [] | 使用するバイブレーション パターンを設定します。バイブレーションのオンとオフを切り替えるには、ミリ秒の配列を渡します。1 つ目の値は、バイブレーションをオンにするまでの待機時間を示します。次の値はバイブレータをオンのままにする時間を示します。これ以降、バイブレータをオフにする持続時間とバイブレータをオンにする持続時間が交互に切り替わります。vibrate_timings が設定され、default_vibrate_timings が true に設定されている場合、ユーザー指定の vibrate_timings の代わりにデフォルト値が使用されます。 |
| 可視性 | ('private' | 'public' | 'secret') | 通知の表示設定を設定します。private、public、secret のいずれかにする必要があります。指定しない場合のデフォルトは private です。 |
AndroidNotification.body
Android 通知の本文。指定すると、admin.messaging.Notification で設定された本文がオーバーライドされます。
署名:
body?: string;
AndroidNotification.bodyLocArgs
bodyLocKey でフォーマット指定子の代わりに使用されるリソースキーの配列。
署名:
bodyLocArgs?: string[];
AndroidNotification.bodyLocKey
本文テキストのローカライズに使用する、アプリの文字列リソース内の本文文字列のキー。
署名:
bodyLocKey?: string;
AndroidNotification.channelId
Android 通知チャンネル ID（Android O の新機能）。このチャンネル ID を持つ通知を受信するには、アプリでこのチャンネル ID のチャンネルを作成する必要があります。リクエストでこのチャンネル ID を送信しない場合、または提供されたチャンネル ID がアプリによってまだ作成されていない場合、FCM はアプリ マニフェストで指定されたチャンネル ID を使用します。
署名:
channelId?: string;
AndroidNotification.clickAction
通知をクリックするユーザーに関連付けられたアクション。指定すると、ユーザーが通知をクリックしたときに、一致するインテント フィルタを持つアクティビティが起動されます。
署名:
clickAction?: string;
AndroidNotification.color
通知アイコンの色（#rrggbb 形式）。
署名:
color?: string;
AndroidNotification.defaultLightSettings
true に設定した場合、通知に Android フレームワークのデフォルトの LED ライト設定が使用されます。デフォルト値は config.xml で指定します。default_light_settings が true に設定され、light_settings も設定されている場合は、デフォルト値の代わりにユーザー指定の light_settings が使用されます。
署名:
defaultLightSettings?: boolean;
AndroidNotification.defaultSound
true に設定した場合、通知に Android フレームワークのデフォルトの音が使用されます。デフォルト値は config.xml で指定します。
署名:
defaultSound?: boolean;
AndroidNotification.defaultVibrateTimings
true に設定した場合、通知に Android フレームワークのデフォルトのバイブレーション パターンが使用されます。デフォルト値は config.xml で指定します。default_vibrate_timings が true に設定され、vibrate_timings も設定されている場合は、ユーザー指定の vibrate_timings の代わりにデフォルト値が使用されます。
署名:
defaultVibrateTimings?: boolean;
AndroidNotification.eventTimestamp
絶対時間参照を使用してイベントについてユーザーに通知する通知の場合は、通知のイベントが発生した時刻を設定します。パネル内の通知は、この時間順に並べ替えられます。
署名:
eventTimestamp?: Date;
AndroidNotification.icon
Android の通知のアイコン リソース。
署名:
icon?: string;
AndroidNotification.imageUrl
通知に表示する画像の URL。
署名:
imageUrl?: string;
AndroidNotification.lightSettings
LED が使用可能なデバイスであれば、通知の LED の点滅速度と色を制御する設定です。点滅の合計時間は OS によって制御されます。
署名:
lightSettings?: LightSettings;
AndroidNotification.localOnly
この通知が現在のデバイスにのみ関連するかどうかを設定します。一部の通知は、Wear OS スマートウォッチなど、他のデバイスにブリッジしてリモート表示することができます。このヒントを設定すると、この通知がブリッジされないよう推奨できます。Wear OS ガイドをご覧ください。
署名:
localOnly?: boolean;
AndroidNotification.notificationCount
この通知が表すアイテム数を設定します。バッジ機能に対応しているランチャーでは、バッジ数として表示できます。NotificationBadge をご覧ください。たとえば、複数の新着メッセージを表示するために 1 つの通知のみを使用しているものの、ここでのカウントで新着メッセージの合計数を表す場合、これは便利です。値が 0 または指定されていない場合、バッジをサポートするシステムではデフォルトの値が使用されます。つまり、新しい通知が届くたびに、長押しメニューに表示される数字が増加します。
署名:
notificationCount?: number;
AndroidNotification.Priority
この通知の相対的な優先度を設定します。優先度の低い通知は、特定の状況でユーザーに表示されない場合があります。この優先度は AndroidMessagePriority とは異なります。この優先度は、メッセージの配信後にクライアントによって処理されます。一方、AndroidMessagePriority はメッセージの配信のタイミングを制御する FCM のコンセプトです。
署名:
priority?: ('min' | 'low' | 'default' | 'high' | 'max');
AndroidNotification.sound
デバイスが通知を受信したときに再生される音のファイル名。
署名:
sound?: string;
AndroidNotification.スティッキー
false に設定するか未設定のままにした場合、ユーザーがパネルで通知をクリックすると、通知は自動的に閉じます。true に設定すると、ユーザーがクリックしても通知は表示されます。
署名:
sticky?: boolean;
AndroidNotification.tag
通知タグ。これは、通知ドロワー内の既存の通知を置き換えるために使用される識別子です。指定しない場合、リクエストごとに新しい通知が作成されます。
署名:
tag?: string;
AndroidNotification.ticker
「ティッカー」を設定します。テキストがユーザー補助サービスに送信されます。API レベル 21（Lollipop）より前では、通知が最初に到着したときにステータスバーに表示されるテキストを設定します。
署名:
ticker?: string;
AndroidNotification.title
Android 通知のタイトル。指定すると、admin.messaging.Notification で設定されたタイトルがオーバーライドされます。
署名:
title?: string;
AndroidNotification.titleLocArgs
titleLocKey でフォーマット指定子の代わりに使用されるリソースキーの配列。
署名:
titleLocArgs?: string[];
AndroidNotification.titleLocKey
タイトル テキストのローカライズに使用する、アプリの文字列リソース内のタイトル文字列のキー。
署名:
titleLocKey?: string;
AndroidNotification.vibrateTimingsMillis
使用するバイブレーション パターンを設定します。バイブレーションのオンとオフを切り替えるには、ミリ秒の配列を渡します。1 つ目の値は、バイブレーションをオンにするまでの待機時間を示します。次の値はバイブレータをオンのままにする時間を示します。これ以降、バイブレータをオフにする持続時間とバイブレータをオンにする持続時間が交互に切り替わります。vibrate_timings が設定され、default_vibrate_timings が true に設定されている場合、ユーザー指定の vibrate_timings の代わりにデフォルト値が使用されます。
署名:
vibrateTimingsMillis?: number[];
AndroidNotification.visibility
通知の表示設定を設定します。private、public、secret のいずれかを指定します。指定しない場合のデフォルトは private です。
署名:
visibility?: ('private' | 'public' | 'secret');