API
Methods for configuring and managing push notifications from Firebase Cloud Messaging in a ToDesktop application.
This package exposes a number of methods for configuring and managing push notifications from Firebase Cloud Messaging.
| Function | Description |
|---|---|
| start(id, options) | Starts the push notification service. |
Starts the push notification service.
Signature:
Electron Developers import { pushNotifications } from "@todesktop/client-core"
pushNotifications.start(id: string, options?: PushNotificationStartOptions): Promise<void>;
| Parameter | Type | Description |
|---|---|---|
| id | string | Firebase Sender ID |
| options | PushNotificationStartOptions |
Returns:
Promise<void>
| Variable | Description |
|---|---|
| on |
Signature:
on: (event: "*" | PushNotificationsEvent, callback: (...any: any[]) => void) => Promise<() => Promise<void>>
Signature:
export declare type PushNotificationsEvent = "start" | "error" | "tokenUpdate" | "receive";
Signature:
export declare type PushNotificationStartOptions = {
showNotifications?: boolean;
};
| Type Alias | Description |
|---|---|
| PushNotificationsEvent | |
| PushNotificationStartOptions |