Getting Started

インストール

AI-Assistedセットアップを使用してプラグインをインストールできます。次のコマンドを使用して、CapgoスキルをAIツールに追加してください:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

次のプロンプトを使用してください:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-live-activities` plugin in my project.

Manualセットアップを使用する場合は、次のコマンドを実行してプラグインをインストールし、以下のプラットフォーム固有の説明を参照してください:

bun add @capgo/capacitor-live-activities
bunx cap sync

iOSセットアップ

プラグインをインストールして同期すると、ネイティブのライブアクティビティUIを作成しません。ActivityKitは、ライブアクティビティの構成を登録するWidget Extensionが必要です。 startActivity ライブアクティビティを表示するには、

要件

• iOS 16.1 以降の両方のアプリターゲットとウィジェット拡張ターゲットで使用してください。
• iOS デバイスまたは互換性のあるシミュレータでテストします。ダイナミック アイランドはサポートされているデバイス モデルでのみ表示されます。 他のデバイスではロック画面のプレゼンテーションが使用されます。
• Apple の 4 KB の制限以下に組み合わせた静的および動的 ActivityKit データを維持してください。

1. ウィジェット拡張を作成する

ネイティブ iOS プロジェクトを開きます：

bunx cap open ios

次に：

1. 選択 ファイル > 新規作成 > ターゲット.
2. を追加する ウィジェット拡張.
3. を有効にする ライブアクティビティを含める.
4. を無効にする 設定の意図を含める アプリも設定可能なウィジェットが必要ない場合は除く
5. 生成された拡張が主なアプリターゲットに埋め込まれていることを確認する

ウィジェット拡張には、 ActivityConfiguration を含まなければならない。アプリはそれを WidgetBundleで登録する必要がある。ウィジェット拡張は、すべての必要なライブアクティビティのプレゼンテーションを提供する必要がある

• ロック画面
• ダイナミック アイランドの拡大
• ダイナミック アイランドのコンパクトな先頭と末尾
• ダイナミック アイランドの最小限

ターゲットを追加するだけでは不十分です。ネイティブアプリまたはプラグインは、ActivityKitのrequest、update、end APIを呼び出す必要があります。拡張機能には、ActivityKitのAPIで使用されるJSON形式をデコードしてレンダリングできるSwiftUI codeが含まれている必要があります。また、ActivityKitのモデルを両方のターゲット（主アプリとウィジェット拡張）に含める必要があります。Xcodeが生成したライブアクティビティのテンプレートは、このプラグインに渡されるJSONレイアウトを自動的にレンダリングしません。拡張機能には、互換性のあるネイティブレイアウトレンダラーも必要です。 ActivityAttributes 2. ライブアクティビティを有効にする

「2. ライブアクティビティを有効にする」セクション

クリップボードにコピー Info.plist:

<key>NSSupportsLiveActivities</key>
<true/>

, Info.plist追加 Live アクティビティをサポートします __CAPGO_KEEP_0__の値がBoolean値の場合 YES 主アプリのカスタムiOSターゲットプロパティの下にあります。

3. 共有イメージ用のApp グループを設定する

App グループは、 saveImage, removeImage, listImages、またはの場合にのみ必要です。 cleanupImagesプラグインは、主アプリのバンドル識別子を使用して、次の形式でApp グループ識別子を導出します:

group.<MAIN_APP_BUNDLE_ID>.liveactivities

バンドル識別子が com.example.delivery のアプリでは、次のように使用する必要があります:

group.com.example.delivery.liveactivities

Xcodeに追加してください。 App Groups 両方のターゲットに同じIDを有効にします。

ライブアクティビティ拡張機能はネットワークにアクセスできません。リモート画像をアプリ内でダウンロードし、共有App Groupに保存してからライブアクティビティから参照してください。バンドル画像の場合、Widget Extensionのターゲットメンバーシップも有効にします。

4. ディープリンクを設定する

「またはタイマーシーケンス」 behavior.widgetUrl URLスキームまたはUniversal Linkを登録するには、 tapUrlカスタムスキームの場合、 myapp://order/12345Info > URL Types 設定 ターゲットの

5. ご利用の場合: Server-Driven Updatesを有効にする

Push Notificationsは、ローカル更新をアプリが開始、更新、または終了する場合に必要ありません。サーバーからLive Activitiesを開始、更新、または終了するには:

• Add the Push Notifications 機能を主なアプリのターゲットに追加します。
• ActivityKitのプッシュトークンを取得し、サーバーに送信します。
• APNsを使用してActivityKitの通知を送信します。 liveactivity push type。
• Add NSSupportsLiveActivitiesFrequentUpdates を主なアプリに追加します。 Info.plist Push Notificationsが頻繁に更新される用途が必要な場合のみ

ActivityKitのプッシュトークンは、標準のユーザー通知デバイストークンとは別です。 Push通知の機能を有効にするだけでは十分ではなく、サーバーから推奨される更新にはネイティブのトークンハンドリングとAPNsバックエンドが必要です。

ネイティブセットアップチェックリスト

呼び出す前に、以下を確認してください: startActivityメインアプリのターゲットで有効になっていることを確認してください。

• NSSupportsLiveActivities ウィジェット拡張機能は埋め込まれていて、
• ネイティブのActivityKit実装とウィジェット拡張機能は同じ ActivityConfiguration.
• タイプを使用しています。 ActivityAttributes アプリとウィジェット拡張機能のデプロイメントターゲットはiOS 16.1以上です。
• iOS設定でアプリにライブアクティビティが有効になっていることを確認してください。
• 共有イメージを使用する場合、両方のターゲットでマッチングのApp Groupが有効になっていることを確認してください。
• __CAPGO_KEEP_0__
• 任意のカスタム URL スキームが使用されている場合、または使用されている場合は登録されます。 widgetUrl または tapUrl インポート

セクション「インポート」

import { CapgoLiveActivities } from '@capgo/capacitor-live-activities';

セクション「API オーバービュー」

areActivitiesSupported

コピー

import { CapgoLiveActivities } from '@capgo/capacitor-live-activities';

const { supported, reason } = await CapgoLiveActivities.areActivitiesSupported();
if (supported) {
  console.log('Live Activities are supported!');
} else {
  console.log('Not supported:', reason);
}

startActivity

指定されたレイアウトとデータで新しいライブアクティビティを開始します。

import { CapgoLiveActivities } from '@capgo/capacitor-live-activities';

const { activityId } = await CapgoLiveActivities.startActivity({
  layout: {
    type: 'container',
    direction: 'horizontal',
    children: [
      { type: 'text', content: 'Order #{{orderNumber}}', fontSize: 16, fontWeight: 'bold' },
      { type: 'text', content: '{{status}}', fontSize: 14, color: '#666666' }
    ]
  },
  dynamicIslandLayout: {
    expanded: {
      leading: { type: 'image', source: 'sfSymbol', value: 'box.truck' },
      trailing: { type: 'text', content: '{{eta}}' },
      center: { type: 'text', content: '{{status}}' },
      bottom: { type: 'progress', value: 'progress' }
    },
    compactLeading: { type: 'image', source: 'sfSymbol', value: 'box.truck' },
    compactTrailing: { type: 'text', content: '{{eta}}' },
    minimal: { type: 'image', source: 'sfSymbol', value: 'box.truck' }
  },
  data: {
    orderNumber: '12345',
    status: 'On the way',
    eta: '10 min',
    progress: 0.6
  }
});
console.log('Started activity:', activityId);

updateActivity

指定されたレイアウトとデータで既存のライブアクティビティを更新します。

import { CapgoLiveActivities } from '@capgo/capacitor-live-activities';

await CapgoLiveActivities.updateActivity({
  activityId: 'abc123',
  data: {
    status: 'Arrived!',
    eta: 'Now',
    progress: 1.0
  },
  alertConfiguration: {
    title: 'Delivery Update',
    body: 'Your order has arrived!'
  }
});

endActivity

ライブアクティビティを終了します。

import { CapgoLiveActivities } from '@capgo/capacitor-live-activities';

await CapgoLiveActivities.endActivity({
  activityId: 'abc123',
  data: { status: 'Delivered' },
  dismissalPolicy: 'after',
  dismissAfter: Date.now() + 3600000 // 1 hour from now
});

getAllActivities

現在アクティブなライブアクティビティをすべて取得します。

import { CapgoLiveActivities } from '@capgo/capacitor-live-activities';

const { activities } = await CapgoLiveActivities.getAllActivities();
activities.forEach(activity => {
  console.log(`Activity ${activity.activityId}: ${activity.state}`);
});

saveImage

__CAPGO_KEEP_0__を共有App Group コンテナに保存して、ライブアクティビティで使用します。 __CAPGO_KEEP_0__は共有コンテナに保存する必要があります。ウィジェット拡張からアクセスできるようにします。

import { CapgoLiveActivities } from '@capgo/capacitor-live-activities';

const { success, imageName } = await CapgoLiveActivities.saveImage({
  imageData: 'base64EncodedImageData...',
  name: 'product-image',
  compressionQuality: 0.8
});
// Use in layout with: { type: 'image', source: 'saved', value: imageName }

removeImage

共有コンテナから保存した__CAPGO_KEEP_0__を削除します。

import { CapgoLiveActivities } from '@capgo/capacitor-live-activities';

const { success } = await CapgoLiveActivities.removeImage({ name: 'product-image' });

listImages

共有コンテナに保存した__CAPGO_KEEP_0__をすべてリストします。

import { CapgoLiveActivities } from '@capgo/capacitor-live-activities';

const { images } = await CapgoLiveActivities.listImages();
console.log('Saved images:', images);

cleanupImages

共有コンテナから保存した__CAPGO_KEEP_0__をすべて削除します。

import { CapgoLiveActivities } from '@capgo/capacitor-live-activities';

await CapgoLiveActivities.cleanupImages();

startTimerSequence

トレーニング/スポーツ用のタイマーシーケンスを開始します。 iOSではLive Activityとダイナミックアイランドに表示されます。 Androidでは、タイマー表示の前景通知として表示されます。

import { CapgoLiveActivities } from '@capgo/capacitor-live-activities';

const { sequenceId } = await CapgoLiveActivities.startTimerSequence({
  title: 'HIIT Workout',
  steps: [
    { duration: 30, title: 'Jumping Jacks', subtitle: 'Warm up', color: '#FF6B00', icon: 'figure.jumprope' },
    { duration: 10, title: 'Rest', color: '#00C853', icon: 'pause.circle' },
    { duration: 45, title: 'Burpees', subtitle: 'High intensity', color: '#FF0000', icon: 'flame.fill' },
    { duration: 15, title: 'Rest', color: '#00C853', icon: 'pause.circle' },
    { duration: 45, title: 'Mountain Climbers', color: '#FF0000', icon: 'figure.run' },
    { duration: 15, title: 'Rest', color: '#00C853', icon: 'pause.circle' },
  ],
  loop: true,
  loopCount: 3,
  soundEnabled: true,
  vibrateEnabled: true,
  countdownBeeps: true,
  tapUrl: 'myapp://workout/hiit'
});

pauseTimerSequence

タイマーシーケンスを一時停止します。

import { CapgoLiveActivities } from '@capgo/capacitor-live-activities';

await CapgoLiveActivities.pauseTimerSequence({ sequenceId: 'abc123' });

resumeTimerSequence

一時停止したタイマーシーケンスを再開します。

import { CapgoLiveActivities } from '@capgo/capacitor-live-activities';

await CapgoLiveActivities.resumeTimerSequence({ sequenceId: 'abc123' });

stopTimerSequence

タイマーシーケンスを終了し、タイマーを閉じます。

import { CapgoLiveActivities } from '@capgo/capacitor-live-activities';

await CapgoLiveActivities.stopTimerSequence({ sequenceId: 'abc123' });

skipTimerStep

Skip to the next step in the sequence.

import { CapgoLiveActivities } from '@capgo/capacitor-live-activities';

await CapgoLiveActivities.skipTimerStep({ sequenceId: 'abc123' });

previousTimerStep

Go back to the previous step in the sequence.

import { CapgoLiveActivities } from '@capgo/capacitor-live-activities';

await CapgoLiveActivities.previousTimerStep({ sequenceId: 'abc123' });

getTimerState

Get the current state of a timer sequence.

import { CapgoLiveActivities } from '@capgo/capacitor-live-activities';

const state = await CapgoLiveActivities.getTimerState({ sequenceId: 'abc123' });
console.log(`Step ${state.currentStepIndex + 1}/${state.totalSteps}: ${state.currentStep.title}`);
console.log(`Time remaining: ${state.remainingSeconds}s`);

Type Reference

AreActivitiesSupportedResult

Result of checking if activities are supported.

export interface AreActivitiesSupportedResult {
  /** Whether Live Activities are supported on this device */
  supported: boolean;
  /** Reason if not supported */
  reason?: string;
}

StartActivityOptions

Live Activityを開始するためのオプション

export interface StartActivityOptions {
  /** Main activity layout (lock screen widget) */
  layout: ActivityLayout;
  /** Dynamic Island layout configuration */
  dynamicIslandLayout: DynamicIslandLayout;
  /** Activity behavior settings */
  behavior?: LiveActivitiesBehavior;
  /** Dynamic data for the activity */
  data: Record<string, unknown>;
  /** Stale date timestamp (activity becomes stale after this) */
  staleDate?: number;
  /** Relevance score for activity ordering (0-100) */
  relevanceScore?: number;
}

StartActivityResult

アクティビティを開始した結果

export interface StartActivityResult {
  /** Unique activity identifier */
  activityId: string;
}

UpdateActivityOptions

Live Activityを更新するためのオプション

export interface UpdateActivityOptions {
  /** Activity ID to update */
  activityId: string;
  /** Updated data */
  data: Record<string, unknown>;
  /** Optional alert to show with update */
  alertConfiguration?: ActivityAlertConfiguration;
  /** Updated stale date */
  staleDate?: number;
  /** Updated relevance score */
  relevanceScore?: number;
}

EndActivityOptions

Live Activityを終了するためのオプション

export interface EndActivityOptions {
  /** Activity ID to end */
  activityId: string;
  /** Final data to display */
  data?: Record<string, unknown>;
  /** Dismissal policy */
  dismissalPolicy?: 'immediate' | 'default' | 'after';
  /** Dismiss after timestamp (when dismissalPolicy is 'after') */
  dismissAfter?: number;
}

GetAllActivitiesResult

getAllActivitiesの結果

export interface GetAllActivitiesResult {
  /** List of activities */
  activities: ActivityInfo[];
}

SaveImageOptions

画像を保存するためのオプション

export interface SaveImageOptions {
  /** Base64 encoded image data */
  imageData: string;
  /** Name to save the image as */
  name: string;
  /** JPEG compression quality (0-1, default 0.8) */
  compressionQuality?: number;
}

SaveImageResult

画像を保存した結果

export interface SaveImageResult {
  /** Whether the save was successful */
  success: boolean;
  /** Saved image name */
  imageName: string;
}

RemoveImageOptions

画像を削除するためのオプション

export interface RemoveImageOptions {
  /** Name of the image to remove */
  name: string;
}

RemoveImageResult

__CAPGO_KEEP_2__

export interface RemoveImageResult {
  /** Whether the removal was successful */
  success: boolean;
}

ListImagesResult

__CAPGO_KEEP_4__

export interface ListImagesResult {
  /** List of saved image names */
  images: string[];
}

TimerSequenceOptions

__CAPGO_KEEP_6__

export interface TimerSequenceOptions {
  /** Array of steps in the sequence */
  steps: TimerStep[];
  /** Overall title for the sequence (e.g., "HIIT Workout", "Tabata") */
  title?: string;
  /** Whether to loop the sequence when complete */
  loop?: boolean;
  /** Number of times to loop (if loop is true, 0 means infinite) */
  loopCount?: number;
  /** Play sound on step change (default: true) */
  soundEnabled?: boolean;
  /** Vibrate on step change (default: true) */
  vibrateEnabled?: boolean;
  /** Play countdown beeps in last 3 seconds (default: true) */
  countdownBeeps?: boolean;
  /** Deep link URL when tapping the notification/activity */
  tapUrl?: string;
  /** Keep screen on during timer (Android only, default: false) */
  keepScreenOn?: boolean;
}

__CAPGO_KEEP_8__

このページはプラグインから生成されました。 src/definitions.ts.再度、上流の公開APIが変更された場合に、再度syncを実行してください。

Getting Startedから続けてください

Capacitorを使用している場合 Getting Started ダッシュボードとAPIの操作を計画するには、接続してください。 Using @capgo/capacitor-live-activities Capacitorのネイティブ機能を使用する場合のUsing @capgo/capacitor-live-activities API Overview APIの実装詳細についてはAPI Overviewを参照してください。 Introduction 導入の実装詳細について API キー API キーについての実装詳細、 デバイス デバイスについての実装詳細。