Interface WebPushSubscriptionResource

interface WebPushSubscriptionResource {
    create(
        params: CreateWebPushSubscriptionParams,
        meta?: HttpMetaParams<"json">,
    ): Promise<WebPushSubscription>;
    fetch(meta?: HttpMetaParams<"none">): Promise<WebPushSubscription>;
    remove(meta?: HttpMetaParams<"none">): Promise<void>;
    update(
        params: UpdateWebPushSubscriptionParams,
        meta?: HttpMetaParams<"json">,
    ): Promise<WebPushSubscription>;
}

Index

Methods

create fetch remove update

Methods

create

create(
params: CreateWebPushSubscriptionParams,
meta?: HttpMetaParams<"json">,
): Promise<WebPushSubscription>
Add a Web Push API subscription to receive notifications. Each access token can have one push subscription. If you create a new subscription, the old subscription is deleted.
Parameters
- params: CreateWebPushSubscriptionParams
  Parameters
- Optionalmeta: HttpMetaParams<"json">
Returns Promise<WebPushSubscription>
Returns Push Subscription

See
https://docs.joinmastodon.org/methods/push
- Defined in src/mastodon/rest/v1/push/subscription.ts:40

fetch

fetch(meta?: HttpMetaParams<"none">): Promise<WebPushSubscription>
View the PushSubscription currently associated with this access token.
Parameters
- Optionalmeta: HttpMetaParams<"none">
Returns Promise<WebPushSubscription>
PushSubscription

See
https://docs.joinmastodon.org/methods/push/#get
- Defined in src/mastodon/rest/v1/push/subscription.ts:50

remove

remove(meta?: HttpMetaParams<"none">): Promise<void>
Removes the current Web Push API subscription.
Parameters
- Optionalmeta: HttpMetaParams<"none">
Returns Promise<void>
N/A

See
https://docs.joinmastodon.org/methods/push/#delete
- Defined in src/mastodon/rest/v1/push/subscription.ts:68

update

update(
params: UpdateWebPushSubscriptionParams,
meta?: HttpMetaParams<"json">,
): Promise<WebPushSubscription>
Updates the current push subscription. Only the data part can be updated. To change fundamentals, a new subscription must be created instead.
Parameters
- params: UpdateWebPushSubscriptionParams
  Parameters
- Optionalmeta: HttpMetaParams<"json">
Returns Promise<WebPushSubscription>
PushSubscription

See
https://docs.joinmastodon.org/methods/push/#update
- Defined in src/mastodon/rest/v1/push/subscription.ts:58