Inizia

Installa

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

Importa

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

API Panoramica

areActivitiesSupported

Verifica se il ponte di attività di template nativo può eseguire il codice sul dispositivo corrente.

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

await CapgoWidgetKit.areActivitiesSupported();

startTemplateActivity

Conserva un modello SVG generico di attività e avvia il ponte di attività nativa di sincronizzazione in tempo reale corrispondente.

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

await CapgoWidgetKit.startTemplateActivity({} as StartTemplateActivityOptions);

updateTemplateActivity

Sostituisci parte o tutta la definizione/stato dell'attività memorizzato.

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

await CapgoWidgetKit.updateTemplateActivity({} as UpdateTemplateActivityOptions);

endTemplateActivity

Termina un'attività in esecuzione mentre si conserva optionalmente un ultimo snapshot di stato.

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

await CapgoWidgetKit.endTemplateActivity({} as EndTemplateActivityOptions);

performTemplateAction

Esegui un'azione dichiarativa e registra l'evento risultante.

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

await CapgoWidgetKit.performTemplateAction({} as PerformTemplateActionOptions);

getTemplateActivity

Leggi un'attività dallo store condiviso.

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

await CapgoWidgetKit.getTemplateActivity({} as GetTemplateActivityOptions);

listTemplateActivities

Elenco di tutte le attività conosciute dal plugin.

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

await CapgoWidgetKit.listTemplateActivities();

listTemplateEvents

Elenco degli eventi di azione memorizzati per reagire alle interazioni del widget in seguito.

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

await CapgoWidgetKit.listTemplateEvents();

acknowledgeTemplateEvents

Segna come riconosciuti gli eventi precedentemente elaborati.

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

await CapgoWidgetKit.acknowledgeTemplateEvents({} as AcknowledgeTemplateEventsOptions);

Tipo di riferimento

ActivitiesSupportedResult

Risultato di un controllo della capacità delle attività in tempo reale.

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

Opzioni per l’avvio di un modello SVG generico.

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

Risultato dell’avvio di un modello generico.

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

UpdateTemplateActivityOptions

Opzioni per l’aggiornamento di un modello esistente.

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

Risultato alla lettura o aggiornamento di un'attività.

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

EndTemplateActivityOptions

Opzioni per interrompere un'attività di template.

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

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

PerformTemplateActionOptions

Opzioni per eseguire un'azione dichiarativa.

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

Risultato dopo l'esecuzione di un'azione.

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

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

GetTemplateActivityOptions

Opzioni per la lettura di un'attività archiviata.

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

ListTemplateActivitiesResult

Risultato quando si elencano le attività archiviate.

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

ListTemplateEventsOptions

Opzioni quando si elencano gli eventi di azione.

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

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

ListTemplateEventsResult

Risultato quando si elencano gli eventi di azione.

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

Fonte di verità

Questa pagina è generata dal plugin src/definitions.tsRiepilogo: . Riepilogo quando le modifiche pubbliche API sono state apportate in fase di sincronizzazione.