Einstieg

Installieren

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

Importieren

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

API Übersicht

areActivitiesSupported

Überprüfen, ob die native Template-Aktivitätsbrücke auf dem aktuellen Gerät ausgeführt werden kann.

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

await CapgoWidgetKit.areActivitiesSupported();

startTemplateActivity

Ein allgemeines SVG-Vorlagenaktivität speichern und die entsprechende native Live-Aktivitätsbrücke starten.

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

await CapgoWidgetKit.startTemplateActivity({} as StartTemplateActivityOptions);

updateTemplateActivity

Teilen Sie einen Teil oder den gesamten gespeicherten Aktivitätsdefinition/Zustand durch.

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

await CapgoWidgetKit.updateTemplateActivity({} as UpdateTemplateActivityOptions);

endTemplateActivity

Beenden Sie eine laufende Aktivität, wobei optional ein letzter Zustands-Snapshot gespeichert wird.

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

await CapgoWidgetKit.endTemplateActivity({} as EndTemplateActivityOptions);

performTemplateAction

Ausführen Sie eine deklarative Aktion und protokollieren Sie das resultierende Ereignis.

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

await CapgoWidgetKit.performTemplateAction({} as PerformTemplateActionOptions);

getTemplateActivity

Lesen Sie eine Aktivität aus dem gemeinsamen Speicher zurück.

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

await CapgoWidgetKit.getTemplateActivity({} as GetTemplateActivityOptions);

listTemplateActivities

Liste aller Aktivitäten, die der Plugin bekannt sind.

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

await CapgoWidgetKit.listTemplateActivities();

listTemplateEvents

Liste aller gespeicherten Aktionsevents, damit die App auf Widget-Interaktionen später reagieren kann.

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

await CapgoWidgetKit.listTemplateEvents();

acknowledgeTemplateEvents

Bereits bearbeitete Events als anerkannt markieren.

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

await CapgoWidgetKit.acknowledgeTemplateEvents({} as AcknowledgeTemplateEventsOptions);

Typenreferenz

ActivitiesSupportedResult

Ergebnis einer Live-Aktivitäten-Fähigkeitsprüfung

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

Optionen für das Starten einer allgemeinen SVG-Vorlagetätigkeit

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

Ergebnis beim Starten einer allgemeinen Vorlagetätigkeit

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

UpdateTemplateActivityOptions

Optionen für das Aktualisieren einer bestehenden Vorlagetätigkeit

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

Ergibt sich bei der Lesung oder Aktualisierung einer einzelnen Aktivität.

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

EndTemplateActivityOptions

Optionen zum Beenden einer Vorlage-Aktivität.

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

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

PerformTemplateActionOptions

Optionen zum Ausführen einer deklarativen Aktion.

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

Ergibt sich nach der Ausführung einer Aktion.

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

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

GetTemplateActivityOptions

Optionen für das Lesen einer gespeicherten Aktivität.

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

ListTemplateActivitiesResult

Ergebnis bei der Auflistung gespeicherter Aktivitäten.

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

ListTemplateEventsOptions

Optionen bei der Auflistung von Aktionsevents.

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

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

ListTemplateEventsResult

Ergebnis bei der Auflistung von Aktionsevents.

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

Quellwahrheit

Diese Seite wird aus dem Plugin generiert. src/definitions.tsRe-run the sync when the public API changes upstream.