Plan

计划 SDK 类，可以提供读取计划资源的相关操作能力

方法

enable()

启用计划

enable: (name?: string) => Promise<boolean>;

• 参数

  • name: 计划名称选传

    • 不传默认启用该空间内的所有计划

    • 支持传多个名称，中间以逗号隔开，eg：name1,name2,name3

• 返回类型

  • Promise<boolean>

• 示例

import Tacos, { Root } from "@tslfe/tacos-sdk";
import type { Plan } from "@tslfe/tacos-sdk";
...
const plan = await root.search<Plan>("/Office/plans/*");
// 启用计划
await plan.enable("XXX");

disable()

禁用某个计划

disable: (name?: string) => Promise<boolean>;

• 参数

  • name: 计划名称选传

    • 不传默认禁用该空间内的所有计划

    • 支持传多个名称，中间以逗号隔开，eg：name1,name2,name3

• 返回类型

  • Promise<boolean>

• 示例

// 禁用计划
plan.disable("XXX");

remove()

删除计划

remove: (name? string) => Promise<boolean>;

• 参数

  • name: 计划名称选传

    • 不传默认清空该空间内的所有计划

    • 支持传多个名称，中间以逗号隔开，eg：name1,name2,name3

• 返回类型

  • Promise<boolean>

• 示例

// 删除计划
plan.remove("XXX");

getResourceBy()

基于空间 id 获取该空间下的计划资源列表

getResourceBy: (spaceId: string) => Promise<ResourceOption<PlanMetaData>>

参考: ResourceOption; PlanMetaData

• 参数

  • spaceId: 空间 id 必传

• 返回类型

  • Promise<ResourceOption<PlanMetaData>>

• 示例

const resourceOption = await plan.getResourceBy("0192234");

create()

创建计划新增配置实例

create: (type: string) => ResourcePlan;

• 参数

  • type: 计划名称必传，空间下唯一标识

• 返回类型

  • ResourcePlan 实例对象

• 示例

// 创建计划新增实例
plan.create("OnWork");

getById()

通过计划 id 查找可用于编辑的 ResourcePlan 实例

getById: (id: string) => ResourcePlan;

• 参数

  • id: 计划 id 必传，查找指定计划 id 对应的 ResourcePlan

• 返回类型

  • ResourcePlan 实例对象

• 示例

// 创建计划更新实例
plan.getById("xxxxxxx");

getByType()

通过计划 type 查找可用于编辑的 ResourcePlan 实例数组

getByType: (type: string) => ResourcePlan[];

• 参数

  • type: 计划 type 必传，查找指定计划type 对应的 ResourcePlan集合

• 返回类型

  • ResourcePlan 实例对象数组

• 示例

// 创建计划更新实例
plan.getByType("OnWork");

实例类

ResourcePlan 实例