For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /reference/sdk/contracts/type-aliases/UiEffect.md.
  • 简体中文
  • Type Alias: UiEffect

    type UiEffect = 
      | {
      effect: "message";
      text: string;
      tone?: UiTone;
    }
      | {
      effect: "navigate";
      to: string;
      params?: {
       [key: string]: UiJsonValue;
      };
    }
      | {
      effect: "replace";
      to: string;
      params?: {
       [key: string]: UiJsonValue;
      };
    }
      | {
      effect: "back";
    }
      | {
      effect: "refresh";
    }
      | {
      effect: "close";
    }
      | {
      effect: "setState";
      values: {
       [key: string]: UiJsonValue;
      };
    };

    Defined in: contracts/ui-document.ts:99

    页面动作完成后由 UI Host 统一执行的效果。