Skip to main content

Function: usePushNotifications()

usePushNotifications(__namedParameters): object

Defined in: usePushNotifications.ts:203

Subscribes and unsubscribes this browser to Web Push through the registered service worker. Persisting the subscription is the app's, through onSubscribe and onUnsubscribe.

A denied permission is reported by permissionState, never as error.

Parameters​

ParameterType
__namedParametersUsePushNotificationsOptions

Returns​

object

error​

error: Error | null

isLoading​

isLoading: boolean

isSubscribed​

isSubscribed: boolean

isSupported​

isSupported: boolean

permissionState​

permissionState: PushPermissionState

subscribe​

subscribe: () => Promise<void>

Returns​

Promise<void>

unsubscribe​

unsubscribe: () => Promise<void>

Returns​

Promise<void>