WebpushNotification interface

WebpushConfig に含めることができる WebPush 固有の通知オプションを表します。これは、ウェブ通知の仕様 で定義されているほとんどの標準オプションをサポートしています。

署名:

export interface WebpushNotification 

プロパティ

WebpushNotification.actions

通知が表示されたときにユーザーが使用できるアクションを表す通知アクションの配列。

署名:

actions?: Array<{
        action: string;
        icon?: string;
        title: string;
    }>;

WebpushNotification.badge

通知自体を表示するのに十分なスペースがない場合に通知を表すために使用される画像の URL。

署名:

badge?: string;

WebpushNotification.body

通知の本文。

署名:

body?: string;

WebpushNotification.data

通知に関連付ける任意のデータ。任意のデータ型を指定できます。

署名:

data?: any;

WebpushNotification.dir

通知を表示する方向。auto、ltr、rtl のいずれかにする必要があります。

署名:

dir?: 'auto' | 'ltr' | 'rtl';

WebpushNotification.icon

通知アイコンへの URL。

署名:

icon?: string;

WebpushNotification.image

通知に表示する画像の URL。

署名:

image?: string;

WebpushNotification.lang

通知の言語（BCP 47 言語タグ）。

署名:

lang?: string;

WebpushNotification.renotify

新しい通知によって古い通知が置き換えられた後に、ユーザーに通知するかどうかを指定するブール値。デフォルトは false です。

署名:

renotify?: boolean;

WebpushNotification.requireInteraction

通知が自動的に閉じられるのではなく、ユーザーがクリックまたは閉じるまでアクティブな状態を維持する必要があることを示します。デフォルトは false です。

署名:

requireInteraction?: boolean;

WebpushNotification.silent

通知をサイレントにするかどうかを指定するブール値。デフォルトは false です。

署名:

silent?: boolean;

WebpushNotification.tag

通知の識別タグ。

署名:

tag?: string;

WebpushNotification.timestamp

通知のタイムスタンプ。詳しくは、https://developer.mozilla.org/ja/docs/Web/API/notification/timestamp をご覧ください。

署名:

timestamp?: number;

WebpushNotification.title

通知のタイトル テキスト。

署名:

title?: string;

WebpushNotification.vibrate

通知の配信時に発するデバイスのバイブレーション ハードウェアのバイブレーション パターン。

署名:

vibrate?: number | number[];