Notifications push

L'API client.push gère les abonnements Web Push. Elle suit le protocole Web Push et permet à votre application de recevoir des notifications en arrière-plan.

S'abonner

Créez un nouvel abonnement Web Push en fournissant votre endpoint push et vos clés VAPID :

final subscription = await client.push.create(
  MastodonPushSubscriptionRequest(
    endpoint: 'https://push.example.com/subscription/abc123',
    p256dh: '<Base64url-encoded P-256 ECDH public key>',
    auth: '<Base64url-encoded authentication secret>',
    standard: true,
    alerts: MastodonPushAlertSettings(
      mention: true,
      follow: true,
      reblog: true,
      favourite: true,
      poll: true,
    ),
    policy: 'followed', // all | followed | follower | none
  ),
);

print(subscription.id);
print(subscription.serverKey); // use to verify incoming pushes

Types d'alertes

MastodonPushAlertSettings accepte toute combinaison des champs suivants. Les champs définis à null sont omis de la requête. Lors de la création, les champs omis utilisent les valeurs par défaut du serveur. Lors d'une mise à jour, l'ensemble des paramètres est remplacé comme décrit ci-dessous.

Champ	Description
mention	Mentionné dans un statut
quote	Statut cité
status	Nouvelle publication d'un utilisateur suivi
reblog	Statut boosté
follow	Nouvel abonné
followRequest	Nouvelle demande d'abonnement
favourite	Statut ajouté aux favoris
poll	Un sondage auquel vous avez voté ou créé s'est terminé
update	Un statut avec lequel vous avez interagi a été modifié
quotedUpdate	Un statut cité a été modifié
adminSignUp	Nouvelle inscription d'utilisateur (admin uniquement)
adminReport	Nouveau signalement (admin uniquement)

Valeurs de politique

Valeur	Description
all	Recevoir des notifications de tous les utilisateurs
followed	Recevoir uniquement les notifications des utilisateurs que vous suivez
follower	Recevoir uniquement les notifications de vos abonnés
none	Désactiver toutes les notifications push

Récupérer l'abonnement actuel

final subscription = await client.push.fetch();
print(subscription.endpoint);
print(subscription.alerts.mention);
print(subscription.policy);

Mettre à jour les paramètres d'alerte

Utilisez update pour remplacer la partie data (alertes et politique) sans recréer l'abonnement. Il ne s'agit pas d'une mise à jour partielle : chaque type d'alerte omis est désactivé et l'omission de policy la réinitialise à all. Indiquez chaque type d'alerte qui doit rester activé. Si alerts et policy sont tous deux omis, une ArgumentError est levée avant l'envoi d'une requête HTTP.

final updated = await client.push.update(
  MastodonPushSubscriptionUpdateRequest(
    alerts: MastodonPushAlertSettings(
      mention: true,
      follow: false,
      reblog: true,
      favourite: true,
      poll: true,
    ),
    policy: 'all',
  ),
);

Pour désactiver explicitement toutes les alertes et réinitialiser la politique à all, envoyez un objet de paramètres d'alerte vide :

await client.push.update(
  const MastodonPushSubscriptionUpdateRequest(
    alerts: MastodonPushAlertSettings(),
  ),
);

Se désabonner

await client.push.delete();

Supprime l'abonnement Web Push actuel. Les appels suivants à fetch lèveront une MastodonNotFoundException.

Le modèle MastodonWebPushSubscription

Champ	Type	Description
id	String	ID d'abonnement
endpoint	String	URL de l'endpoint push
serverKey	String	Clé publique du serveur pour vérifier les messages push
alerts	MastodonPushAlerts	Paramètres d'alerte actifs
policy	String	Politique de notification
standard	bool?	Indique si l'abonnement est conforme à la spec Web Push standardisée (Mastodon 4.4+)