Iniciando

Instalar

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

Importar

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

API Resumen

areActivitiesSupported

Comprobar si el puente de actividad de plantilla nativa puede ejecutarse en el dispositivo actual.

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

await CapgoWidgetKit.areActivitiesSupported();

startTemplateActivity

Almacena un modelo de actividad SVG genérico y inicia el puente de actividad nativa correspondiente.

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

await CapgoWidgetKit.startTemplateActivity({} as StartTemplateActivityOptions);

updateTemplateActivity

Reemplazar parte o toda la definición/estado de la actividad almacenada.

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

await CapgoWidgetKit.updateTemplateActivity({} as UpdateTemplateActivityOptions);

endTemplateActivity

Finalizar una actividad en ejecución mientras se persiste opcionalmente una instantánea de estado final.

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

await CapgoWidgetKit.endTemplateActivity({} as EndTemplateActivityOptions);

performTemplateAction

Ejecutar una acción declarativa y registrar el evento resultante.

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

await CapgoWidgetKit.performTemplateAction({} as PerformTemplateActionOptions);

getTemplateActivity

Lee una actividad desde el almacén compartido.

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

await CapgoWidgetKit.getTemplateActivity({} as GetTemplateActivityOptions);

listTemplateActivities

Listar todas las actividades conocidas actualmente por el plugin.

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

await CapgoWidgetKit.listTemplateActivities();

listTemplateEvents

Listar eventos de acciones almacenados para que la aplicación pueda reaccionar a las interacciones del widget más tarde.

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

await CapgoWidgetKit.listTemplateEvents();

acknowledgeTemplateEvents

Marcar eventos procesados previamente como reconocidos.

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

await CapgoWidgetKit.acknowledgeTemplateEvents({} as AcknowledgeTemplateEventsOptions);

Referencia de tipos

ActivitiesSupportedResult

Resultado de una comprobación de capacidad de actividades en vivo.

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

Opciones para iniciar una plantilla de actividad SVG genérica.

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

Resultado al iniciar una plantilla de actividad genérica.

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

UpdateTemplateActivityOptions

Opciones para actualizar una actividad de plantilla existente.

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

Resultado al leer o actualizar una actividad individual.

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

EndTemplateActivityOptions

Opciones para finalizar una actividad de plantilla.

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

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

PerformTemplateActionOptions

Opciones para ejecutar una acción declarativa.

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

Resultado después de ejecutar una acción.

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

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

GetTemplateActivityOptions

Opciones para leer una actividad almacenada.

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

ListTemplateActivitiesResult

Resultado cuando se listan actividades almacenadas.

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

ListTemplateEventsOptions

Opciones cuando se listan eventos de acción.

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

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

ListTemplateEventsResult

Resultado cuando se listan eventos de acción.

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

Fuente de Verdad

Esta página se genera desde el plugin’s src/definitions.tsRe-ejecutar la sincronización cuando el público API cambia en la fuente.