入门指南

安装

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

导入

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

API概述

areActivitiesSupported

检查本地模板活动桥是否可以在当前设备上运行。

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

await CapgoWidgetKit.areActivitiesSupported();

startTemplateActivity

保存一个通用 SVG 模板活动并启动匹配的本机 Live 活动桥接。

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

await CapgoWidgetKit.startTemplateActivity({} as StartTemplateActivityOptions);

updateTemplateActivity

替换存储的活动定义/状态的一部分或全部。

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

await CapgoWidgetKit.updateTemplateActivity({} as UpdateTemplateActivityOptions);

endTemplateActivity

在可选地保留最后一个状态快照的情况下结束正在运行的活动。

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

await CapgoWidgetKit.endTemplateActivity({} as EndTemplateActivityOptions);

performTemplateAction

执行一条声明性动作并记录结果事件。

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

await CapgoWidgetKit.performTemplateAction({} as PerformTemplateActionOptions);

getTemplateActivity

从共享存储中读取一项活动。

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

await CapgoWidgetKit.getTemplateActivity({} as GetTemplateActivityOptions);

listTemplateActivities

列出插件当前知道的每一项活动。

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

await CapgoWidgetKit.listTemplateActivities();

listTemplateEvents

列出存储的动作事件，以便应用程序可以在widget交互时反应。

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

await CapgoWidgetKit.listTemplateEvents();

acknowledgeTemplateEvents

标记之前处理的事件。

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

await CapgoWidgetKit.acknowledgeTemplateEvents({} as AcknowledgeTemplateEventsOptions);

类型参考

ActivitiesSupportedResult

活动能力检查结果

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

开始模板活动的通用 SVG 模板选项

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

开始模板活动的结果

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

UpdateTemplateActivityOptions

更新现有模板活动的选项

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

活动读取或更新时的结果。

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

EndTemplateActivityOptions

活动模板结束选项。

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

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

PerformTemplateActionOptions

执行声明性动作的选项。

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

执行动作后的结果。

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

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

GetTemplateActivityOptions

读取存储活动的选项

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

ListTemplateActivitiesResult

列出存储活动的结果

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

ListTemplateEventsOptions

列出动作事件的选项

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

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

ListTemplateEventsResult

列出动作事件的结果

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

真实来源

此页面由插件生成 src/definitions.ts当公共API上游发生变化时，请重新运行同步。