Mode

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

方法

toggle()

模式手动切换

toggle: (name: string) => Promise<boolean>;

• 参数

  • name: 模式名称

• 返回类型

  • Promise<boolean>

• 示例

import Tacos, { Root } from "@tslfe/tacos-sdk";
import type { Mode } from "@tslfe/tacos-sdk";
...
const mode = await root.search<Mode>("/Office/modes/*");
// 手动切换空间工作模式
await mode.toggle("OnWork");

enable()

启用模式

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

• 参数

  • name: 模式名称选传

    • 不传默认启用该空间内的所有模式

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

• 返回类型

  • Promise<boolean>

• 示例

// 启用工作模式
mode.enable("OnWork");

disable()

禁用某种模式

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

• 参数

  • name: 模式名称选传

    • 不传默认禁用该空间内的所有模式

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

• 返回类型

  • Promise<boolean>

• 示例

// 禁用工作模式
mode.disable("OnWork");

remove()

删除模式

remove: () => Promise<boolean>;

• 参数

  • name: 模式名称选传

    • 不传默认删除该空间内的所有模式

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

• 返回类型

  • Promise<boolean>

• 示例

// 删除工作模式
mode.remove("OnWork");

getResourceBy()

基于空间 id 获取该空间下的模式资源列表

getResourceBy: (spaceId: string) => Promise<ResourceOption<ModeMetaData>>;

参考: ResourceOption; ModeMetaData

• 参数

  • spaceId: 空间 id 必传

• 返回类型

  • Promise<ResourceOption<ModeMetaData>>

• 返回值

  • enableList: 启用的空间模式资源列表

  • disableList: 禁用的空间模式资源列表

• 示例

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

create()

创建模式新增配置实例

create: (type: string) => ResourceMode;

• 参数

  • type: 模式名称必传，空间下唯一标识

• 返回类型

  • ResourceMode 实例对象

• 示例

// 创建模式新增实例
mode.create("OnWork");

getById()

通过模式 id 查找可用于编辑的 ResourceMode 实例

getById: (id: string) => ResourceMode;

• 参数

  • id: 模式 id 必传，查找指定模式 id 对应的 ResourceMode

• 返回类型

  • ResourceMode 实例对象

• 示例

// 创建模式更新实例
mode.getById("xxxxxxx");

getByType()

通过模式 type 查找可用于编辑的 ResourceMode 实例数组

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

• 参数

  • type: 模式 type 必传，查找指定模式type 对应的 ResourceMode集合

• 返回类型

  • ResourceMode 实例对象数组

• 示例

// 创建模式更新实例
mode.getByType("OnWork");

实例类

ResourceMode 实例