WebpushNotification interface

表示可包含在 WebpushConfig 中的 WebPush 专用通知选项。它支持网络通知规范中定义的大多数标准选项。

签名

export interface WebpushNotification 

属性

属性 类型 说明
操作 Array<{ action: string;icon?: 字符串;title: 字符串;}> 一组通知操作,表示显示通知时用户可以执行的操作。
徽章 字符串 当没有足够的空间来显示通知本身时,用于表示通知的图片的网址。
正文 字符串 通知的正文。
数据 任意 要与通知关联的任意数据。这可以是任何数据类型。
dir “auto”|“ltr”|“rtl” 显示通知的方向。必须是 autoltrrtl 中的一个。
图标 字符串 指向通知图标的网址。
图片 字符串 要在通知中显示的图片的网址。
语言 字符串 通知的语言,采用 BCP 47 语言标记表示。
重新通知 布尔值 一个布尔值,用于指定在新通知替换旧通知后是否应通知用户。默认值为 false。
requireInteraction 布尔值 指示通知应保持有效状态,直到用户点击或关闭它,而不是自动关闭。默认值为 false。
静音 布尔值 一个布尔值,用于指定通知是否应静音。默认值为 false。
代码 字符串 通知的标识标记。
时间戳 数字 通知的时间戳。如需了解详情,请参阅 https://developer.mozilla.org/zh-CN/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/zh-CN/docs/Web/API/notification/timestamp。

签名

timestamp?: number;

WebpushNotification.title

通知的标题文本。

签名

title?: string;

WebpushNotification.vibrate

设备的振动硬件在通知触发时发出的振动模式。

签名

vibrate?: number | number[];