メインコンテンツへスキップ
このページは、1つの実在アプリを最初から最後まで追うサンプルアプリ:OneSignalの完全な統合の一部です。アプリはClean Beansという共同生活の家のための掃除当番表アプリで、Expo(React Native)とSupabaseバックエンドで構築されています。 Live Activityは、iOSのロック画面とDynamic Islandに表示される、リアルタイムで更新される小さなビューです。Clean Beansは2つ使っています。ユーザーの掃除時間帯までのカウントダウンと、連続記録が途切れそうなときの警告です。
iOSのロック画面に表示された掃除リマインダーのLive Activity

ロック画面でカウントダウンする掃除リマインダー。

通常、Live Activitiesはアプリが開始します。Clean Beansは、アプリが開いているかどうかに関係なく決まった時刻に表示する必要があるため、バックエンドから開始します。これを可能にするのがOneSignalのpush-to-startです。

アプリを設定する \

クロスプラットフォームアプリでは、Live Activityのライフサイクル管理をOneSignalに任せられます。必要なJavaScriptは、起動時の1回の呼び出しだけです。
app/_layout.tsx
書く必要があるネイティブコードは、SwiftUIでのウィジェットのレイアウトだけです。Clean Beansは小さなExpo設定プラグインでウィジェット拡張をiOSプロジェクトに追加するため、ビルドのたびにプロジェクトをゼロから生成できます。
plugins/withLiveActivityWidget.js

ウィジェットを描画する \

ウィジェットは、自由形式のデータを持つOneSignalのDefaultLiveActivityAttributesを使います。1つのウィジェットがtypeの値を読み取ってレイアウトを選ぶことで、両方のアクティビティに対応します。
plugins/widget/CleanBeansWidgetLiveActivity.swift
各レイアウトは、バックエンドが送ったデータから値を読み取ります。attributesはアクティビティの開始時に固定されます。stateは更新のたびに変わる可能性があります。
plugins/widget/CleanBeansWidgetLiveActivity.swift
カウントダウンはSwiftUIのタイマースタイルで描画され、サーバーからの追加の更新なしにデバイス上で時間が進みます。

連続記録の警告:バックエンドからアクティビティを開始する \

現地時間の午後7時に、連続記録があり今日まだ掃除をしていない人に、深夜0時までのカウントダウンが表示されます。1時間ごとの関数が、プッシュのリマインダーと同じタイムゾーンの照合で対象者を見つけ、それぞれにアクティビティを開始します。
supabase/functions/streak-warning/index.ts
深夜0時までカウントダウンする連続記録警告のLive Activity

深夜0時までカウントダウンする連続記録の警告。

掃除リマインダー:開始、更新、終了 \

掃除リマインダーは3つのフェーズを経ます。それぞれが同じアクティビティに対する個別のリクエストです。 関数は、各ユーザーがどのフェーズにいるべきかを判定します。
supabase/functions/cleaning-activity/index.ts
現在のフェーズはユーザーのプロフィールに保存し、目標とするフェーズが異なる場合にだけリクエストを送ります。これにより、1時間ごとのジョブを繰り返し実行しても安全です。 更新と終了には、開始とは異なるエンドポイントを使います。アクティビティはURLで指定されるため、これらのリクエストにはターゲティングが含まれません。
supabase/functions/cleaning-activity/index.ts
これらのリクエストでpriority: 10を使うのは、それぞれがすぐに表示すべきフェーズの変化であり、1人が受け取るのは1日に数回程度だからです。優先度10は、AppleがデバイスごとにLive Activityの更新に割り当てる予算を消費します。スコアやプログレスバーのように頻繁に更新するものには、5から始めてください。
更新と終了は、開始のエンドポイントではなく/apps/{app_id}/live_activities/{activity_id}/notificationsに送信してください。Clean Beansは当初3つすべてを開始のエンドポイントに送っていたため、更新と終了はすべて「Missing required parameter - event_attributes」で拒否されていました。
アクティビティごとに固有のactivity_idを付け、アクティビティの開始時に保存してください。OneSignalは終了したアクティビティのactivity_idへの更新を受け付けないため、ユーザーごとに固定のIDを使うと2日目以降は機能しなくなります。

クロスプラットフォームのセットアップ

setupDefaultとウィジェット拡張。

Live Activityの開始

push-to-start API。

Live Activityの更新

更新と終了のリクエスト。