跳到主要内容

推送通知

client.push API 管理 Web Push 订阅。它遵循 Web Push 协议，允许应用在后台接收通知。

订阅​

通过提供推送端点和 VAPID 密钥，创建新的 Web Push 订阅：

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); // 用于验证收到的推送消息

通知类型​

MastodonPushAlertSettings 接受以下字段的任意组合。值为 null 的字段会从请求中省略。创建订阅时，省略的字段使用服务器默认值；更新订阅时，整个设置对象会按下文所述被替换。

字段说明
mention在帖子中被提及
quote帖子被引用
status所关注用户发布了新帖子
reblog帖子被转嘟
follow新关注者
followRequest新的关注请求
favourite帖子被收藏
poll参与或创建的投票已结束
update互动过的帖子被编辑
quotedUpdate被引用的帖子被编辑
adminSignUp新用户注册（仅管理员）
adminReport新举报（仅管理员）

策略值​

值说明
all接收所有用户的通知
followed仅接收所关注用户的通知
follower仅接收关注者的通知
none禁用所有推送通知

获取当前订阅​

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

更新通知设置​

使用 update 替换订阅的 data 部分（通知类型和策略），无需重新创建订阅。这不是局部更新：省略的每种通知类型都会被禁用，省略 policy 会将其重置为 all。请指定所有需要保持启用的通知类型。如果同时省略 alerts 和 policy，则会在发送 HTTP 请求前抛出 ArgumentError。

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

如需明确禁用所有通知并将策略重置为 all，请发送一个空的通知设置对象：

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

取消订阅​

await client.push.delete();

删除当前 Web Push 订阅。之后调用 fetch 将抛出 MastodonNotFoundException。

MastodonWebPushSubscription 模型​

字段类型说明
idString订阅 ID
endpointString推送端点 URL
serverKeyString用于验证推送消息的服务器公钥
alertsMastodonPushAlerts已启用的通知设置
policyString通知策略
standardbool?订阅是否符合标准化 Web Push 规范（Mastodon 4.4+）