WebpushNotification interface

代表可納入 WebpushConfig 中的 WebPush 專屬通知選項。可支援大多數標準選項 (如網頁通知規格所述)。

簽名:

export interface WebpushNotification 

屬性

屬性 類型 說明
動作 Array<{ action: string;圖示?:字串;title:字串;}> 通知動作陣列,代表系統顯示通知時可執行的動作。
徽章 字串 當空間不足以顯示通知時,用於表示通知的圖片網址。
內文 字串 通知的內文。
資料 不限 要與通知建立關聯的任意資料。可以是任何資料類型。
dir 「auto」|ltr|rtl 顯示通知的方向。必須是 autoltrrtl 其中之一。
圖示 字串 通知圖示的網址。
圖片 字串 通知中顯示的圖片網址。
語言 字串 通知使用的語言為 BCP 47 語言標記。
通知 布林值 布林值,指定是否要在新通知取代舊通知後通知使用者。預設值為 false。
requireInteraction 布林值 表示通知應保持有效狀態,直到使用者點選或關閉為止,而不是自動關閉。預設值為 false。
靜音 布林值 此佈林值可指定通知是否應為靜音。預設值為 false。
代碼 字串 通知的識別標記。
時間戳記 數字 通知的時間戳記。詳情請參閱 https://developer.mozilla.org/en-US/docs/Web/API/notification/timestamp。
title 字串 通知的標題文字。
震動 數字 |數字 [] 裝置振動硬體在通知啟動時發出的震動模式。

WebpushNotification.actions

通知動作陣列,代表系統顯示通知時可執行的動作。

簽名:

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

WebpushNotification.badge

當空間不足以顯示通知時,用於表示通知的圖片網址。

簽名:

badge?: string;

WebpushNotification.body

通知的內文。

簽名:

body?: string;

WebpushNotification.data

要與通知建立關聯的任意資料。可以是任何資料類型。

簽名:

data?: any;

WebpushNotification.dir

顯示通知的方向。必須是 autoltrrtl 其中之一。

簽名:

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

WebpushNotification.icon

通知圖示的網址。

簽名:

icon?: string;

WebpushNotification.image

通知中顯示的圖片網址。

簽名:

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/en-US/docs/Web/API/notification/timestamp。

簽名:

timestamp?: number;

WebpushNotification.title

通知的標題文字。

簽名:

title?: string;

WebpushNotification.vibrate

裝置振動硬體在通知啟動時發出的震動模式。

簽名:

vibrate?: number | number[];