For AI agents: the complete documentation index is available at /en/llms.txt, the full documentation bundle is available at /en/llms-full.txt, and this page is available as Markdown at /en/reference/sdk/contracts/index.md.
SFMC
  • English

      • contracts

      Functions

      FunctionDescription
      nativeLevelFromBdsPermissionBDS permissions.json 中的权限字符串 → 原生等级数值。 使用场景：db-server 读取 BDS 根目录 permissions.json（{ xuid, permission }）时转换；未知值返回 undefined。
      effectivePermissionLevel计算有效等级：configs/permissions.json 的覆盖值优先；否则映射原生等级；都没有时视为成员。
      isRetiredPlatformModule-

      Interfaces

      InterfaceDescription
      ModuleEntryPath模块 SAPI 入口描述（
      ModuleCatalogEntry模块目录（catalog）中单条模块元数据。
      ModuleCatalog本地已安装模块目录快照
      ModuleRuntimeState单个模块的运行时启停状态（module-lock.json 单项）。
      ModuleLock模块启停锁文件数据结构（映射 modules/module-lock.json）。
      UiServiceCall声明式 service 调用。input 中的字符串允许使用 {{path}} 绑定。
      UiConfirmDefinition操作前的标准确认步骤。
      UiActionDefinition调用业务 service 的命名动作。
      UiNodeBase所有组件共有字段。节点 id 用于可视化编辑、稳定 diff 与诊断定位。
      UiHeaderNode所有组件共有字段。节点 id 用于可视化编辑、稳定 diff 与诊断定位。
      UiTextNode所有组件共有字段。节点 id 用于可视化编辑、稳定 diff 与诊断定位。
      UiInfoNode所有组件共有字段。节点 id 用于可视化编辑、稳定 diff 与诊断定位。
      UiImageNode所有组件共有字段。节点 id 用于可视化编辑、稳定 diff 与诊断定位。
      UiDividerNode所有组件共有字段。节点 id 用于可视化编辑、稳定 diff 与诊断定位。
      UiSpacerNode所有组件共有字段。节点 id 用于可视化编辑、稳定 diff 与诊断定位。
      UiButtonNode所有组件共有字段。节点 id 用于可视化编辑、稳定 diff 与诊断定位。
      UiTextFieldNode所有组件共有字段。节点 id 用于可视化编辑、稳定 diff 与诊断定位。
      UiToggleNode所有组件共有字段。节点 id 用于可视化编辑、稳定 diff 与诊断定位。
      UiDropdownOption-
      UiDropdownNode所有组件共有字段。节点 id 用于可视化编辑、稳定 diff 与诊断定位。
      UiSliderNode所有组件共有字段。节点 id 用于可视化编辑、稳定 diff 与诊断定位。
      UiWhenNode条件组件组。
      UiEachNode动态列表。source 为数组路径，item 仅在 template/empty 作用域中可见。
      UiScreenDocument单个声明式页面文档。
      UiEntryDefinition主菜单或管理员界面的页面入口。
      UiScreenReferencefeature 中的页面文件引用。
      UiFeatureDocument一个模块交给 UI Studio 打开的项目入口。
      UiProject已解析并通过跨文件语义校验的 UI 工程。

      Type Aliases

      Type AliasDescription
      UiPresentationUI 页面底层呈现策略。
      UiTone由主题映射为客户端可用颜色、图标或原生样式的语义色。
      UiJsonValue可存入 UI 文档的数据值。
      UiReferenceRoot表达式可引用的运行时数据根。
      UiExpressionOperator白名单表达式操作符；运行时禁止执行任意脚本。
      UiExpression安全表达式：常量、路径引用或白名单操作。
      UiParamDefinition页面路由参数声明。
      UiStateDefinition每玩家、每会话、每页面隔离的输入状态声明。
      UiDataSource页面打开时加载的数据源。
      UiEffect页面动作完成后由 UI Host 统一执行的效果。
      UiTrigger按钮触发器。
      UiNodeUI 文档支持的完整节点联合。

      Variables

      VariableDescription
      PERMISSION_LEVELSFMC 权限等级数值（与 Minecraft 原生 PlayerPermissionLevel 数值对齐）
      RETIRED_PLATFORM_MODULES已收编至平台的模块及其兼容服务名称。旧配置、包目录和历史表保留。
      PLATFORM_MONITORING_SERVICES-
      PLATFORM_SERVICE_OWNER平台宿主身份：提供监控服务，并可作为可选跨模块服务调用方（如 QQ 账号快照）。
      UI_DOCUMENT_FORMAT_VERSIONUI 文档格式版本。