Mulai Belajar

Pasang

bun add @capgo/capacitor-widget-kit
bunx cap sync

Impor

import { CapgoWidgetKit } from '@capgo/capacitor-widget-kit';

API Ringkasan

areActivitiesSupported

Periksa apakah jembatan aktivitas template asli dapat dijalankan pada perangkat saat ini.

import { CapgoWidgetKit } from '@capgo/capacitor-widget-kit';

await CapgoWidgetKit.areActivitiesSupported();

startTemplateActivity

Simpan template SVG umum dan mulai jembatan Aktivitas Live asli yang sesuai.

import { CapgoWidgetKit } from '@capgo/capacitor-widget-kit';

await CapgoWidgetKit.startTemplateActivity({} as StartTemplateActivityOptions);

updateTemplateActivity

Ganti bagian atau seluruh definisi/keadaan aktivitas yang disimpan.

import { CapgoWidgetKit } from '@capgo/capacitor-widget-kit';

await CapgoWidgetKit.updateTemplateActivity({} as UpdateTemplateActivityOptions);

endTemplateActivity

Akhirkan aktivitas yang berjalan sambil memilih untuk menyimpan snapshot keadaan terakhir.

import { CapgoWidgetKit } from '@capgo/capacitor-widget-kit';

await CapgoWidgetKit.endTemplateActivity({} as EndTemplateActivityOptions);

performTemplateAction

Laksanakan satu aksi deklaratif dan catat peristiwa hasilnya.

import { CapgoWidgetKit } from '@capgo/capacitor-widget-kit';

await CapgoWidgetKit.performTemplateAction({} as PerformTemplateActionOptions);

getTemplateActivity

Baca satu aktivitas dari penyimpanan bersama.

import { CapgoWidgetKit } from '@capgo/capacitor-widget-kit';

await CapgoWidgetKit.getTemplateActivity({} as GetTemplateActivityOptions);

listTemplateActivities

Daftar semua aktivitas yang diketahui oleh plugin saat ini.

import { CapgoWidgetKit } from '@capgo/capacitor-widget-kit';

await CapgoWidgetKit.listTemplateActivities();

listTemplateEvents

Daftar acara tindakan yang disimpan sehingga aplikasi dapat bereaksi terhadap interaksi widget kemudian.

import { CapgoWidgetKit } from '@capgo/capacitor-widget-kit';

await CapgoWidgetKit.listTemplateEvents();

acknowledgeTemplateEvents

Tandai acara yang telah diproses sebelumnya sebagai diakui.

import { CapgoWidgetKit } from '@capgo/capacitor-widget-kit';

await CapgoWidgetKit.acknowledgeTemplateEvents({} as AcknowledgeTemplateEventsOptions);

Referensi Tipe

ActivitiesSupportedResult

Hasil Periksa Kemampuan Aktivitas Langsung

export interface ActivitiesSupportedResult {
  /**
   * Whether the current device and runtime can run the native template activity bridge.
   */
  supported: boolean;

  /**
   * Human-readable reason when support is unavailable.
   */
  reason?: string;
}

StartTemplateActivityOptions

Salin ke Papan Klip

export interface StartTemplateActivityOptions {
  /**
   * Optional explicit activity identifier. When omitted, the native runtime creates one.
   */
  activityId?: string;

  /**
   * Generic SVG template definition.
   */
  definition: SvgTemplateDefinition;

  /**
   * Initial JSON state exposed under `state.*`.
   */
  state: SvgTemplateState;

  /**
   * Optional deep link used when the widget body is tapped.
   */
  openUrl?: string;
}

StartTemplateActivityResult

Opsi untuk Mengupdate Aktivitas Template yang Ada

export interface StartTemplateActivityResult {
  /**
   * Stored activity snapshot.
   */
  activity: SvgTemplateActivityRecord;
}

UpdateTemplateActivityOptions

__CAPGO_KEEP_0__

export interface UpdateTemplateActivityOptions {
  /**
   * Activity identifier returned by `startTemplateActivity`.
   */
  activityId: string;

  /**
   * Optional replacement definition.
   */
  definition?: SvgTemplateDefinition;

  /**
   * Optional replacement state.
   */
  state?: SvgTemplateState;

  /**
   * Optional replacement deep link.
   */
  openUrl?: string;
}

TemplateActivityResult

Hasil membaca atau memperbarui aktivitas tunggal.

export interface TemplateActivityResult {
  /**
   * Stored activity snapshot, or `null` when not found.
   */
  activity: SvgTemplateActivityRecord | null;
}

EndTemplateActivityOptions

Opsi untuk mengakhiri aktivitas template.

export interface EndTemplateActivityOptions {
  /**
   * Activity identifier returned by `startTemplateActivity`.
   */
  activityId: string;

  /**
   * Optional final state persisted before ending.
   */
  state?: SvgTemplateState;
}

PerformTemplateActionOptions

Opsi untuk menjalankan aksi deklaratif.

export interface PerformTemplateActionOptions {
  /**
   * Activity identifier returned by `startTemplateActivity`.
   */
  activityId: string;

  /**
   * Action identifier declared in the template definition.
   */
  actionId: string;

  /**
   * Optional source identifier, typically the hotspot id that triggered the action.
   */
  sourceId?: string;

  /**
   * Optional payload stored with the emitted event and exposed to declarative patches under `{{action.payload.*}}`.
   */
  payload?: JsonObject;
}

PerformTemplateActionResult

Hasil setelah menjalankan aksi.

export interface PerformTemplateActionResult {
  /**
   * Updated activity snapshot.
   */
  activity: SvgTemplateActivityRecord;

  /**
   * Action event emitted by the runtime.
   */
  event: SvgTemplateActionEvent;
}

GetTemplateActivityOptions

Opsi untuk membaca satu kegiatan yang disimpan.

export interface GetTemplateActivityOptions {
  /**
   * Activity identifier to load.
   */
  activityId: string;
}

ListTemplateActivitiesResult

Hasil ketika menampilkan kegiatan yang disimpan.

export interface ListTemplateActivitiesResult {
  /**
   * Stored activity snapshots.
   */
  activities: SvgTemplateActivityRecord[];
}

ListTemplateEventsOptions

Opsi ketika menampilkan acara aksi.

export interface ListTemplateEventsOptions {
  /**
   * Optional activity filter.
   */
  activityId?: string;

  /**
   * When true, only unacknowledged events are returned.
   */
  unacknowledgedOnly?: boolean;
}

ListTemplateEventsResult

Hasil ketika menampilkan acara aksi.

export interface ListTemplateEventsResult {
  /**
   * Matching action events.
   */
  events: SvgTemplateActionEvent[];
}

Sumber Kebenaran

Halaman ini dihasilkan dari plugin’s src/definitions.tsRe-run sinkronisasi ketika publik API berubah di upstream.