简介

idt-workbench-sdk 为外部工作台提供基于 i 大通的角色切换功能，其内部调用流程如下：

快速开始

包管理器

1.安装

注意

idt-kit 发布在公司私有 npm，安装时需要指定大通 npm 源

npm i idt-workbench-sdk -S --registry=https://dev-cv.saicmotor.com/nexus3/repository/npm/
# or
yarn add idt-workbench-sdk -S --registry=https://dev-cv.saicmotor.com/nexus3/repository/npm/

推荐 npm 或 yarn 管理项目依赖，CDN 稳定性差且不支持 ESM。

2.使用

import WorkBench from 'idt-workbench-sdk'

// 1.实例化 sdk
const workBench = new WorkBench({ env: 'dev', platform: 'mobile' })
// 2.启动 sdk
workBench.init('用户token')

CDN

1.引入

<script src="https://cdn3.maxuscloud.com/oaapp/static/idt-workbench-sdk/1.0.0/workbench.min.js"></script>

通过 <script> 标签加载 js 脚本后会向 window 注入一个全局变量 WORKBENCH，访问该变量可使用 idt-workbench-sdk 全部功能。

2.使用

// 1.实例化 sdk
const workBench = new WORKBENCH.WorkBench({ env: 'dev', platform: 'mobile' })
// 2.启动 sdk
workBench.init('用户token')

API

constructor

实例化 SDK，提供初始配置信息

new WorkBench(options?: WorkBenchOptions)

参数	说明	参数类型	默认值
env	运行环境，需要根据你项目所处环境配置	dev、prod	dev
platform	运行平台，一般情况下为 mobile	mobile、pc	mobile

init

启动 SDK，获取当前用户对应的角色数据并显示 UI

public async init(token?: string): Promise<void>

参数	说明	参数类型	默认值
token	用户令牌，应获取 token 后调用该方法	string	无

destory

关闭 SDK 所有功能及 UI

public destory(): void