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