实验性项目　WorkFly 完全由 AI 生成，可能存在缺陷或错误，仅供内部测试，非用友官方产品，不代表公司立场。
WorkFly·dev
一键安装安装
开发者中心MTL API

MTL API

面向友空间移动代码迁移的同名兼容层。每个方法都明确标注可用、待实现或桌面不支持，避免把目录存在误认为能力可用。

迁移层，不是第二套新标准

已有友空间移动代码可以继续调用全局 mtl.*。新应用优先使用 WF API；迁移时先按状态筛出可用方法，再逐个核对参数。

机器可读 JSON
可用 可用
45 个方法已连接真实宿主能力。
待实现 待实现
180 个方法只用于迁移盘点。
不支持 不支持
70 个移动能力不适用于桌面。

调用约定

可用的异步接口接受友空间同名参数，并支持 success / fail / complete 与 Promise 双模。兼容层服从 WorkFly 的权限门控，不会暴露宿主 Token，也不会绕过用户确认。

const result = await mtl.getUserInfo({}) // 或保留原有 success / fail / complete 回调

建议的迁移顺序

  1. 先搜索方法名确认每个调用在当前版本的兼容状态。
  2. 先替换可用接口保留原签名，验证权限与桌面交互。
  3. 处理缺口待实现方法暂缓发布；不支持方法改用 WF 能力或重做流程。
MTL/私有版配置

mtl.initMobileService 待实现

用于初始化移动基础服务。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.initMobileService({ url?: string })

参数

参数类型说明
url?string获取数据的后台 domain Url，注意带服务编码。https://bip-daily.yyuap.com/iuap-yonbuilder-mobile

调用示例

const result = await mtl.initMobileService({ url: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/选人组件

mtl.chooseAllContacts 可用

用于调用移动端原生跨租户选人组件。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.chooseAllContacts({ multiple?: boolean; selectedList?: array.< string >; navTitle?: string })

参数

参数类型说明
multiple?boolean是否多选
selectedList?array.< string >已选用户数组
navTitle?string导航标题

调用示例

const result = await mtl.chooseAllContacts({ multiple: /* boolean */, selectedList: /* array.< string > */, navTitle: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/选人组件

mtl.chooseContacts 可用

用于调用移动端原生选人组件。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.chooseContacts({ multiple?: boolean; selectedList?: array.< string >; maxCount?: number; navTitle?: string; navColor?: string; qzId?: string; canDelete?: boolean; canSelectDept?: boolean; needYhtUserId?: number })

参数

参数类型说明
multiple?boolean是否多选
selectedList?array.< string >已选用户数组
maxCount?number最大选择人数
navTitle?string导航标题
navColor?string导航颜色值
qzId?string需要选择的空间id
canDelete?boolean是否可以删除已选人员(IOS 已弃用)
canSelectDept?boolean是否可以点部门选择（仅多选时有效）(true:可通过部门选择 false:不可以通过部门选择)
needYhtUserId?number是否需要友户通ID(1:需要友户通ID 0:不需要友户通ID)

调用示例

const result = await mtl.chooseContacts({ multiple: /* boolean */, selectedList: /* array.< string > */, maxCount: /* number */, navTitle: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/选人组件

mtl.init 可用

用于初始化选人组件。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.init({ baseUrl?: string; isExclusivity?: bool; tenantId?: string; serviceCode?: string; debug?: bool; url?: string; urls?: array })

参数

参数类型说明
baseUrl?string获取数据的后台 domain Url。https://bip-daily.yonyoucloud.com
isExclusivity?bool是否是专属化环境。true 专属化，false 公有云，不传及默认都是友空间H5选人组件。
tenantId?string跨租户场景下，获取目标租户的domainUrl，不传默认用baseUrl。
serviceCode?string根据 tenantId+serviceCode的方式获取多数据中心环境的 domainUrl。
debug?bool开启调试模式。调试模式默认加载daily环境地址。
url?stringmobile.contacts老选人组件。注意：不填默认取多数据中心地址，file://协议下走c2地址。
urls?array友空间选人组件。注意：不填默认取社会化地址，file://协议下走c2地址。

调用示例

const result = await mtl.init({ baseUrl: /* string */, isExclusivity: /* bool */, tenantId: /* string */, serviceCode: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/选人组件

mtl.selectContacts 可用

用于选人、选员工。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.selectContacts({ baseUrl?: string; isExclusivity?: bool; yhtToken?: string; isNative?: bool; includeEsn?: int; orgType?: int; maskClosable?: bool; appearanceModel?: string; navTitle?: string; tenantId?: string; tenantName?: string; wbAt?: string; isemployee?: string; maxCount?: int; lang?: string; hiddenNav?: bool; selectUserNumber?: int; selectUserList?: array; selectDeptList?: array; multiple?: bool; filterList?: array; tabKeys?: array; customTabs?: array; cancel?: function })

参数

参数类型说明
baseUrl?string获取数据的后台 domain Url。https://bip-daily.yonyoucloud.com
isExclusivity?bool是否是专属化。 默认 false
yhtToken?string友户通token。不传默认去cookie。
isNative?bool是否是友空间原生选人，useYYH5==true会阻断
includeEsn?int是否需要协同属性。0不需要，1需要
orgType?int显示组织或部门。0: 显示组织+部门,1: 仅显示组织,2: 仅显示部门
maskClosable?bool点击背景遮罩是否可关闭
appearanceModel?string深色模式。auto根据系统，light正常，dark暗黑
navTitle?string导航标题
tenantId?string租户id。跨租户场景使用。
tenantName?string租户名称
wbAt?stringwb_at
isemployee?string选择员工还是人员。不传递或者传递""的时候，调用人员页面；传递 isemployee: "isemployee"，调用员工页面
maxCount?int最大选人数
lang?string多语言
hiddenNav?bool隐藏导航栏
selectUserNumber?int已选择的人员个数
selectUserList?array已选择的人员列表
selectDeptList?array已选择的部门及人员列表
multiple?bool单选/多选；默认多选
filterList?array根据范围选择人员
tabKeys?array维度选人页。dept：组织架构；deptMember：组织成员；group：内部群；groupMember：内部群成员；team：分组（内含人员）；out：外部；outMember：外部成员。
customTabs?array自定义标签。默认会 生成 "范围选人" 标签，自行传入会覆盖。
cancel?function点击下箭头及遮罩背景关闭事件回调

调用示例

const result = await mtl.selectContacts({ baseUrl: /* string */, isExclusivity: /* bool */, yhtToken: /* string */, isNative: /* bool */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/悬浮体桥接 API 文档

mtl.changeFloatAgent 待实现

友空间兼容方法。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.changeFloatAgent({ method: string; staffId: string; portraitImageUrl: string; name: string; serviceCode: string })

参数

参数类型说明
methodstring桥接方法名称，固定为"changeFloatAgent"。
staffIdstring智能体 staffId
portraitImageUrlstring智能体头像 URL
namestring智能体名称
serviceCodestring服务编码

调用示例

const result = await mtl.changeFloatAgent({ method: /* string */, staffId: /* string */, portraitImageUrl: /* string */, name: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/悬浮体桥接 API 文档

mtl.closeFloatAgent 待实现

友空间兼容方法。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.closeFloatAgent({ method: string })

参数

参数类型说明
methodstring桥接方法名称，固定为"closeFloatAgent"。

调用示例

const result = await mtl.closeFloatAgent({ method: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/悬浮体桥接 API 文档

mtl.getFloatAgentStatus 待实现

友空间兼容方法。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.getFloatAgentStatus({ method: string })

参数

参数类型说明
methodstring桥接方法名称，固定为"getFloatAgentStatus"。

调用示例

const result = await mtl.getFloatAgentStatus({ method: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/悬浮体桥接 API 文档

mtl.openFloatAgent 待实现

友空间兼容方法。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.openFloatAgent({ method: string })

参数

参数类型说明
methodstring桥接方法名称，固定为"openFloatAgent"。

调用示例

const result = await mtl.openFloatAgent({ method: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/悬浮体桥接 API 文档

mtl.registerBusinessForFloatAgent 待实现

友空间兼容方法。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.registerBusinessForFloatAgent({ method: string; serviceCode: string; callback: function })

参数

参数类型说明
methodstring桥接方法名称，固定为"registerBusinessForFloatAgent"。
serviceCodestring业务标识码，用于标识业务类型
callbackfunction回调函数。

调用示例

const result = await mtl.registerBusinessForFloatAgent({ method: /* string */, serviceCode: /* string */, callback: /* function */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/悬浮体桥接 API 文档

mtl.registerFloatAgentForBusiness 待实现

友空间兼容方法。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.registerFloatAgentForBusiness({ method: string; serviceCode: string; callback: function })

参数

参数类型说明
methodstring桥接方法名称，固定为"registerBusinessForFloatAgent"。
serviceCodestring业务标识码，用于标识业务类型
callbackfunction回调函数。

调用示例

const result = await mtl.registerFloatAgentForBusiness({ method: /* string */, serviceCode: /* string */, callback: /* function */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/悬浮体桥接 API 文档

mtl.resetDefaultFloatAgent 待实现

友空间兼容方法。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.resetDefaultFloatAgent({ method: string })

参数

参数类型说明
methodstring桥接方法名称，固定为"resetDefaultFloatAgent"。

调用示例

const result = await mtl.resetDefaultFloatAgent({ method: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/悬浮体桥接 API 文档

mtl.sendMessageToBusiness 待实现

友空间兼容方法。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.sendMessageToBusiness({ method: string; serviceCode: string; instanceId?: string; action: string; data?: object })

参数

参数类型说明
methodstring桥接方法名称，固定为"sendMessageToBusiness"。
serviceCodestring目标业务标识码
instanceId?string目标实例 ID，不指定则发送给该 serviceCode 下的所有实例
actionstring消息动作类型，用于标识消息用途
data?object消息数据，自定义 JSON 对象

调用示例

const result = await mtl.sendMessageToBusiness({ method: /* string */, serviceCode: /* string */, instanceId: /* string */, action: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/悬浮体桥接 API 文档

mtl.sendMessageToFloatAgent 待实现

友空间兼容方法。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.sendMessageToFloatAgent({ method: string; serviceCode: string; data?: object })

参数

参数类型说明
methodstring桥接方法名称，固定为"sendMessageToFloatAgent"。
serviceCodestring当前服务的serviceCode，与registerBusinessForFloatAgent保持一致。
data?object消息数据，自定义 JSON 对象

调用示例

const result = await mtl.sendMessageToFloatAgent({ method: /* string */, serviceCode: /* string */, data: /* object */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/悬浮体桥接 API 文档

mtl.setFloatAgentStatus 待实现

友空间兼容方法。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.setFloatAgentStatus({ method: string; height?: number })

参数

参数类型说明
methodstring桥接方法名称，固定为"setFloatAgentStatus"。
height?number高度比例（01）。0 = 悬浮球；**01** = 半屏；>=1 = 全屏。

调用示例

const result = await mtl.setFloatAgentStatus({ method: /* string */, height: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/日志

mtl.readLocationLog 待实现

用于读取日志数据。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.readLocationLog({ fileName: string })

参数

参数类型说明
fileNamestring文件路径，支持绝对路径和文件路径协议如fs://、widget://等

调用示例

const result = await mtl.readLocationLog({ fileName: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/日志

mtl.writeLocationLog 待实现

用于写日志数据。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.writeLocationLog({ fileName: string; showDate?: bool; parameterDic?: object })

参数

参数类型说明
fileNamestring文件路径，支持绝对路径和文件路径协议如fs://、widget://等
showDate?bool是否需要显示时间
parameterDic?object日志数据

调用示例

const result = await mtl.writeLocationLog({ fileName: /* string */, showDate: /* bool */, parameterDic: /* object */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/登录&绑定

mtl.autoLogin 待实现

用于自动登录。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.autoLogin({ url: string; lang?: string; requestType?: string; tenantId: string })

参数

参数类型说明
urlstring当前环境的 url 域名。域名 + 服务编码，'https://xx.xxx.com/iuap-yonbuilder-mobile'。
lang?string多语参数
requestType?string请求类型。默认是 axios 请求，如果需要走移动端请求可传 'yy'。
tenantIdstring租户ID

调用示例

const result = await mtl.autoLogin({ url: /* string */, lang: /* string */, requestType: /* string */, tenantId: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/登录&绑定

mtl.autoLoginNew 待实现

用于自动登录。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.autoLoginNew({ url: string; lang?: string; requestType?: string; tenantId: string })

参数

参数类型说明
urlstring当前环境的 url 域名。域名 + 服务编码，'https://xx.xxx.com/iuap-yonbuilder-mobile'。
lang?string多语参数
requestType?string请求类型。默认是 axios 请求，如果需要走移动端请求可传 'yy'。
tenantIdstring租户ID

调用示例

const result = await mtl.autoLoginNew({ url: /* string */, lang: /* string */, requestType: /* string */, tenantId: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/登录&绑定

mtl.login 待实现

用于账号密码登录。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.login({ url: string; lang?: string; requestType: string; tenantId: string })

参数

参数类型说明
urlstring当前环境的 url 域名。域名 + 服务编码，'https://xx.xxx.com/iuap-yonbuilder-mobile'。
lang?string多语参数
requestTypestring请求类型。默认是 axios 请求，如果需要走移动端请求可传 'yy'。
tenantIdstring租户ID

调用示例

const result = await mtl.login({ url: /* string */, lang: /* string */, requestType: /* string */, tenantId: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/登录&绑定

mtl.loginNew 待实现

用于账号密码登录。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.loginNew({ url: string; lang?: string; requestType: string; tenantId: string })

参数

参数类型说明
urlstring当前环境的 url 域名。域名 + 服务编码，'https://xx.xxx.com/iuap-yonbuilder-mobile'。
lang?string多语参数
requestTypestring请求类型。默认是 axios 请求，如果需要走移动端请求可传 'yy'。
tenantIdstring租户ID

调用示例

const result = await mtl.loginNew({ url: /* string */, lang: /* string */, requestType: /* string */, tenantId: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/登录&绑定

mtl.logout 待实现

用于退出登录。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.logout({ url: string; openUrl?: string; yhtToken: string; wbAt: string; lang?: string })

参数

参数类型说明
urlstring当前环境的 url 域名。域名 + 服务编码，'https://xx.xxx.com/iuap-yonbuilder-mobile'。
openUrl?string退出登录后，自动打开的地址。
yhtTokenstringyht_access_token，。
wbAtstringwb_at
lang?string多语

调用示例

const result = await mtl.logout({ url: /* string */, openUrl: /* string */, yhtToken: /* string */, wbAt: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/登录&绑定

mtl.sendValidateCode 待实现

用于账号密码登录。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.sendValidateCode({ url: string; lang?: string; requestType: string; mobile: string })

参数

参数类型说明
urlstring当前环境的 url 域名。域名 + 服务编码，'https://xx.xxx.com/iuap-yonbuilder-mobile'。
lang?string多语参数
requestTypestring请求类型。默认是 axios 请求，如果需要走移动端请求可传 'yy'。
mobilestring手机号

调用示例

const result = await mtl.sendValidateCode({ url: /* string */, lang: /* string */, requestType: /* string */, mobile: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/登录&绑定

mtl.sendValidateCodeNew 待实现

用于账号密码登录。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.sendValidateCodeNew({ url: string; lang?: string; requestType: string; mobile: string })

参数

参数类型说明
urlstring当前环境的 url 域名。域名 + 服务编码，'https://xx.xxx.com/iuap-yonbuilder-mobile'。
lang?string多语参数
requestTypestring请求类型。默认是 axios 请求，如果需要走移动端请求可传 'yy'。
mobilestring手机号

调用示例

const result = await mtl.sendValidateCodeNew({ url: /* string */, lang: /* string */, requestType: /* string */, mobile: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/登录&绑定

mtl.unitifyLogin 待实现

友空间兼容方法。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.unitifyLogin({ domain: string })

参数

参数类型说明
domainstring接口请求域名(携带微服务域名)

调用示例

const result = await mtl.unitifyLogin({ domain: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/登录&绑定

mtl.validateCodeLogin 待实现

用于手机号验证码登录。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.validateCodeLogin({ url: string; lang?: string; requestType: string; tenantId: string })

参数

参数类型说明
urlstring当前环境的 url 域名。域名 + 服务编码，'https://xx.xxx.com/iuap-yonbuilder-mobile'。
lang?string多语参数
requestTypestring请求类型。默认是 axios 请求，如果需要走移动端请求可传 'yy'。
tenantIdstring租户ID

调用示例

const result = await mtl.validateCodeLogin({ url: /* string */, lang: /* string */, requestType: /* string */, tenantId: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/登录&绑定

mtl.validateCodeLoginNew 待实现

用于手机号验证码登录。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.validateCodeLoginNew({ url: string; lang?: string; requestType: string; tenantId: string })

参数

参数类型说明
urlstring当前环境的 url 域名。域名 + 服务编码，'https://xx.xxx.com/iuap-yonbuilder-mobile'。
lang?string多语参数
requestTypestring请求类型。默认是 axios 请求，如果需要走移动端请求可传 'yy'。
tenantIdstring租户ID

调用示例

const result = await mtl.validateCodeLoginNew({ url: /* string */, lang: /* string */, requestType: /* string */, tenantId: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/登录&绑定

mtl.verifyLoginPassword 待实现

用于弹出密码验证对话框，验证用户身份。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.verifyLoginPassword({ title?: string })

参数

参数类型说明
title?string弹窗标题，若不传，显示默认的文案：为了确保数据安全，需要验证您的登录密码

调用示例

const result = await mtl.verifyLoginPassword({ title: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/分享

mtl.doShare 待实现

友空间兼容方法。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.doShare({ type: number; title: string; desc: string; imgUrl: string; link: string })

参数

参数类型说明
typenumber分享的平台 ID(ios、安卓不支持0和1类型)，详见下方说明。
titlestring文本标题
descstring文本内容
imgUrlstring分享图标
linkstring分享链接

调用示例

const result = await mtl.doShare({ type: /* number */, title: /* string */, desc: /* string */, imgUrl: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/分享

mtl.openShare 待实现

友空间兼容方法。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.openShare({ type?: number; title: string; desc: string; imgUrl: string; link: string; pageUrl: string })

参数

参数类型说明
type?numbermenu 中展示的可分享到的平台。详见下方说明。
titlestring文本标题
descstring文本内容
imgUrlstring分享图标
linkstring分享链接
pageUrlstring分享链接。android 平台需要单独传。

调用示例

const result = await mtl.openShare({ type: /* number */, title: /* string */, desc: /* string */, imgUrl: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/单点鉴权code

mtl.getEsnCode 不支持

用于获取协同云 EsnCode。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.getEsnCode({ url: string; lang?: string; requestType?: string; wb_at: string; yht_access_token: string; tenantId: string })

参数

参数类型说明
urlstring当前环境的 url 域名。域名 + 服务编码，'https://xx.xxx.com/iuap-yonbuilder-mobile'。
lang?string多语参数
requestType?string请求类型。默认是 axios 请求，如果需要走移动端请求可传 'yy'。
wb_atstringwb_at
yht_access_tokenstring友户通 token
tenantIdstring租户ID

调用示例

const result = await mtl.getEsnCode({ url: /* string */, lang: /* string */, requestType: /* string */, wb_at: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/单点鉴权code

mtl.getEsnCodeNew 不支持

用于获取协同云 EsnCode。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.getEsnCodeNew({ url: string; lang?: string; requestType?: string; wb_at: string; yht_access_token: string; tenantId: string })

参数

参数类型说明
urlstring当前环境的 url 域名。域名 + 服务编码，'https://xx.xxx.com/iuap-yonbuilder-mobile'。
lang?string多语参数
requestType?string请求类型。默认是 axios 请求，如果需要走移动端请求可传 'yy'。
wb_atstringwb_at
yht_access_tokenstring友户通 token
tenantIdstring租户ID

调用示例

const result = await mtl.getEsnCodeNew({ url: /* string */, lang: /* string */, requestType: /* string */, wb_at: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/单点鉴权code

mtl.getExclusiveCode 可用

用于通过调用接口获取认证code。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.getExclusiveCode()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.getExclusiveCode()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/单点鉴权code

mtl.getToken 不支持

用于通过调用接口获取轻应用code。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.getToken()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.getToken()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/单点鉴权code

mtl.getYhtTokenWithCode 不支持

用于获取YhtToken。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.getYhtTokenWithCode({ url: string; lang?: string; requestType: string; code: string })

参数

参数类型说明
urlstring当前环境的 url 域名。域名 + 服务编码，'https://xx.xxx.com/iuap-yonbuilder-mobile'。
lang?string多语参数
requestTypestring请求类型。默认是 axios 请求，如果需要走移动端请求可传 'yy'。
codestringyhtcode

调用示例

const result = await mtl.getYhtTokenWithCode({ url: /* string */, lang: /* string */, requestType: /* string */, code: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/单点鉴权code

mtl.getYhtTokenWithCodeNew 不支持

用于获取YhtToken。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.getYhtTokenWithCodeNew({ url: string; lang?: string; requestType: string; code: string })

参数

参数类型说明
urlstring当前环境的 url 域名。域名 + 服务编码，'https://xx.xxx.com/iuap-yonbuilder-mobile'。
lang?string多语参数
requestTypestring请求类型。默认是 axios 请求，如果需要走移动端请求可传 'yy'。
codestringyhtcode

调用示例

const result = await mtl.getYhtTokenWithCodeNew({ url: /* string */, lang: /* string */, requestType: /* string */, code: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/用户数据

mtl.chooseUserOrGroupFromChat 待实现

用于空间member_id和友户通user_id相互转换。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.chooseUserOrGroupFromChat()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.chooseUserOrGroupFromChat()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/用户数据

mtl.convertMemberIDs 待实现

用于空间member_id和友户通user_id相互转换。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.convertMemberIDs({ type: string; idArray: array[string] })

参数

参数类型说明
typestring转换类型。 0：空间ID换友互通ID； 1：友互通ID换空间ID
idArrayarray[string]需要转换的数组

调用示例

const result = await mtl.convertMemberIDs({ type: /* string */, idArray: /* array[string] */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/用户数据

mtl.gainUserInfo 可用

用于获取个人信息。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.gainUserInfo()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.gainUserInfo()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/用户数据

mtl.getBaseUserInfo 可用

用于匿名情况下获取用户基本信息。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.getBaseUserInfo({ url: string; tenantId: string; requestType?: string })

参数

参数类型说明
urlstring当前服务环境domain。”https://bip-daily.yonyoucloud.com/iuap-yonbuilder-mobile“
tenantIdstring租户id
requestType?string请求类型。不传或传空时使用 axios 发起请求；传任意字符串使用 mtl.request 函数发起请求，注意：可能会走原生请求。

调用示例

const result = await mtl.getBaseUserInfo({ url: /* string */, tenantId: /* string */, requestType: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/用户数据

mtl.getUserInfo 可用

用于获取当前用户USER_ID，与saveExclusiveUserInfo函数配对使用。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.getUserInfo()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.getUserInfo()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/用户数据

mtl.getUserYHTInfo 可用

用于获取个人友户通信息，与 setUserYHTInfo函数配对使用。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.getUserYHTInfo({ isEncrypt: Bool })

参数

参数类型说明
isEncryptBool是否对token加密，默认是加密的

调用示例

const result = await mtl.getUserYHTInfo({ isEncrypt: /* Bool */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/用户数据

mtl.saveExclusiveUserInfo 可用

用于存储当前用户基本信息，与getUserInfo函数配对使用。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.saveExclusiveUserInfo({ xxx?: 任意 })

参数

参数类型说明
xxx?任意任意需要存储的数据

调用示例

const result = await mtl.saveExclusiveUserInfo({ xxx: /* 任意 */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/用户数据

mtl.saveExclusiveYhtInfo 可用

用于存储当前用户yht信息。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.saveExclusiveYhtInfo({ yht_access_token: string; wb_at: string; xxx?: 任意 })

参数

参数类型说明
yht_access_tokenstringyht token
wb_atstringwb_at
xxx?任意任意需要存储的数据

调用示例

const result = await mtl.saveExclusiveYhtInfo({ yht_access_token: /* string */, wb_at: /* string */, xxx: /* 任意 */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/用户数据

mtl.setUserYHTInfo 可用

用于设置友户通用户信息，与 getUserYHTInfo函数配对使用。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.setUserYHTInfo({ xxx?: 任意 })

参数

参数类型说明
xxx?任意任意需要存储到localstorage中的数据。key固定位mtl$setUserYHTInfoKey。

调用示例

const result = await mtl.setUserYHTInfo({ xxx: /* 任意 */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/工作台

mtl.changeTenant 待实现

用于【私有版】切换租户。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.changeTenant({ url: string; requestType?: string; lang?: string; authToken: string; userId?: bool; tenantId?: string; headers?: object })

参数

参数类型说明
urlstring获取数据的后台 domain Url，注意带服务编码。https://bip-daily.yyuap.com
requestType?string请求类型。不传或传空时使用 axios 发起请求；传任意字符串使用 mtl.request 函数发起请求，注意：可能会走原生请求。
lang?string多语数据
authTokenstring友户通token
userId?bool友户通用户id
tenantId?string租户id
headers?object请求头信息

调用示例

const result = await mtl.changeTenant({ url: /* string */, requestType: /* string */, lang: /* string */, authToken: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/工作台

mtl.changeTenantNew 待实现

用于【私有版】切换租户。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.changeTenantNew({ url: string; requestType?: string; lang?: string; authToken: string; userId?: bool; tenantId?: string; headers?: object })

参数

参数类型说明
urlstring获取数据的后台 domain Url，注意带服务编码。https://bip-daily.yyuap.com/iuap-yonbuilder-mobile
requestType?string请求类型。不传或传空时使用 axios 发起请求；传任意字符串使用 mtl.request 函数发起请求，注意：可能会走原生请求。
lang?string多语数据
authTokenstring友户通token
userId?bool友户通用户id
tenantId?string租户id
headers?object请求头信息

调用示例

const result = await mtl.changeTenantNew({ url: /* string */, requestType: /* string */, lang: /* string */, authToken: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/工作台

mtl.getAppletShareParams 待实现

用于获取小程序分享的参数。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.getAppletShareParams()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.getAppletShareParams()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/工作台

mtl.getBannerList 待实现

用于【私有版】获取私有版banner列表。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.getBannerList({ url: string; requestType?: string; category?: string; headers?: object })

参数

参数类型说明
urlstring获取数据的后台 domain Url。https://bip-daily.yyuap.com
requestType?string请求类型。不传或传空时使用 axios 发起请求；传任意字符串使用 mtl.request 函数发起请求，注意：可能会走原生请求。
category?string应用id
headers?object请求头信息

调用示例

const result = await mtl.getBannerList({ url: /* string */, requestType: /* string */, category: /* string */, headers: /* object */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/工作台

mtl.getBannerListNew 待实现

用于【私有版】获取私有版banner列表。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.getBannerListNew({ url: string; requestType?: string; category?: string; headers?: object })

参数

参数类型说明
urlstring获取数据的后台 domain Url，注意带服务编码。https://bip-daily.yyuap.com/iuap-yonbuilder-mobile
requestType?string请求类型。不传或传空时使用 axios 发起请求；传任意字符串使用 mtl.request 函数发起请求，注意：可能会走原生请求。
category?string分类信息
headers?object请求头信息

调用示例

const result = await mtl.getBannerListNew({ url: /* string */, requestType: /* string */, category: /* string */, headers: /* object */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/工作台

mtl.getExclusiveAppH5LocationPath 待实现

用于【私有版】获取工作台应用加载本地H5路径。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.getExclusiveAppH5LocationPath({ url: string; requestType?: string; lang?: string; authToken: string })

参数

参数类型说明
urlstring获取数据的后台 domain Url，注意带服务编码。https://bip-daily.yyuap.com/iuap-yonbuilder-mobile
requestType?string请求类型。不传或传空时使用 axios 发起请求；传任意字符串使用 mtl.request 函数发起请求，注意：可能会走原生请求。
lang?string多语数据
authTokenstring友户通token

调用示例

const result = await mtl.getExclusiveAppH5LocationPath({ url: /* string */, requestType: /* string */, lang: /* string */, authToken: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/工作台

mtl.getIndependenceAppList 待实现

用于【私有版】获取独立app应用列表。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.getIndependenceAppList({ url: string; requestType?: string; lang?: string; appId: string; includeApproveCenter?: bool; headers?: object })

参数

参数类型说明
urlstring获取数据的后台 domain Url，注意带服务编码。https://bip-daily.yyuap.com/iuap-yonbuilder-mobile
requestType?string请求类型。不传或传空时使用 axios 发起请求；传任意字符串使用 mtl.request 函数发起请求，注意：可能会走原生请求。
lang?string多语数据
appIdstring独立引用appID
includeApproveCenter?bool是否包含审批中心应用
headers?object请求头信息

调用示例

const result = await mtl.getIndependenceAppList({ url: /* string */, requestType: /* string */, lang: /* string */, appId: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/工作台

mtl.isExclusivePreloadMDF 待实现

用于预加载MDF应用。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.isExclusivePreloadMDF({ mdfUrl: string; isPreload?: bool })

参数

参数类型说明
mdfUrlstringmdf应用地址。
isPreload?bool是否开启预加载模式。

调用示例

const result = await mtl.isExclusivePreloadMDF({ mdfUrl: /* string */, isPreload: /* bool */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/工作台

mtl.mdfIsLoad 待实现

用于 MDF 在线 H5 调用，预加载完成后打开 MDF 应用时使用预加载。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.mdfIsLoad({ mdfUrl: string; isPreload?: bool })

参数

参数类型说明
mdfUrlstringmdf应用地址。
isPreload?bool是否开启预加载模式。

调用示例

const result = await mtl.mdfIsLoad({ mdfUrl: /* string */, isPreload: /* bool */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/工作台

mtl.openAppWithParams 待实现

友空间兼容方法。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.openAppWithParams({ app_id: string; currentDay?: string; member_id?: number })

参数

参数类型说明
app_idstring应用id
currentDay?string日程当前时间(20201112)
member_id?number用户id(从哪个进入的，从共享人进行，就是共享人的id)

调用示例

const result = await mtl.openAppWithParams({ app_id: /* string */, currentDay: /* string */, member_id: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/工作台

mtl.openExclusiveApp 待实现

用于开启新窗口的方式打开应用。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.openExclusiveApp({ appletExtId?: string; app_type?: string; serviceName?: string; tenantId?: string; serviceId?: string; appUrl?: string; appletPackageType?: string; packageType?: string; navShow?: bool; titleColor?: string; isbrowser?: bool })

参数

参数类型说明
appletExtId?string小程序Id
app_type?string应用类型
serviceName?string服务名称
tenantId?string租户id
serviceId?string服务id
appUrl?string应用地址
appletPackageType?string小程序包类型
packageType?string序包类型
navShow?bool是否显示导航
titleColor?string导航栏标题
isbrowser?bool是否是用浏览器方式打开

调用示例

const result = await mtl.openExclusiveApp({ appletExtId: /* string */, app_type: /* string */, serviceName: /* string */, tenantId: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/工作台

mtl.saveExclusiveDomain 待实现

用于保存接口域名信息---保存到本地。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.saveExclusiveDomain({ domain: string })

参数

参数类型说明
domainstring获取数据的后台 domain Url，注意带服务编码。https://bip-daily.yyuap.com/iuap-yonbuilder-mobile

调用示例

const result = await mtl.saveExclusiveDomain({ domain: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/智能套件-语音

mtl.startSpeechSyn 不支持

用于开始语音播报。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.startSpeechSyn({ text: string })

参数

参数类型说明
textstring合成内容

调用示例

const result = await mtl.startSpeechSyn({ text: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/智能套件-语音

mtl.stopSpeechSyn 不支持

用于停止语音播报。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.stopSpeechSyn()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.stopSpeechSyn()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/智能套件-语音

mtl.translateVoice 不支持

用于语音文件转文字。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.translateVoice({ localId: string; isShowProgressTips?: number })

参数

参数类型说明
localIdstring需要播放的音频的字符串，由 stopRecord 接口获得
isShowProgressTips?number默认1。1显示加载框，0 不显示加载框。

调用示例

const result = await mtl.translateVoice({ localId: /* string */, isShowProgressTips: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/智能套件-语音

mtl.voiceToText 不支持

用于语音转文字，带录音UI。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.voiceToText()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.voiceToText()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/蓝牙打印机

mtl.blueToothConnect 不支持

用于连接蓝牙打印机。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.blueToothConnect({ deviceIndentify: string; deviceName: string })

参数

参数类型说明
deviceIndentifystring需要连接的设备标识
deviceNamestring需要连接的蓝牙设备名字

调用示例

const result = await mtl.blueToothConnect({ deviceIndentify: /* string */, deviceName: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/蓝牙打印机

mtl.blueToothConnectState 不支持

用于获得当前蓝牙连接状态。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.blueToothConnectState()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.blueToothConnectState()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/蓝牙打印机

mtl.blueToothDisConnect 不支持

用于断开当前连接的蓝牙打印机。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.blueToothDisConnect()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.blueToothDisConnect()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/蓝牙打印机

mtl.blueToothPrint 不支持

用于断开当前连接的蓝牙打印机。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.blueToothPrint({ printNum: number; content: object [] })

参数

参数类型说明
printNumnumber打印的页数
contentobject []打印的内容列表

调用示例

const result = await mtl.blueToothPrint({ printNum: /* number */, content: /* object [] */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/蓝牙打印机

mtl.blueToothScan 不支持

用于获得当前蓝牙连接状态，如果当前有连接蓝牙打印机则返回连接的蓝牙打印机信息。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.blueToothScan({ registerFunc?: function })

参数

参数类型说明
registerFunc?function持续获取蓝牙扫描信息的回调函数

调用示例

const result = await mtl.blueToothScan({ registerFunc: /* function */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/蓝牙打印机

mtl.blueToothStopScan 不支持

用于停止扫描蓝牙打印机。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.blueToothStopScan()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.blueToothStopScan()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/蓝牙打印机

mtl.getBlueToothState 不支持

用于获取蓝牙打开状态。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.getBlueToothState()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.getBlueToothState()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/创建桌面快捷方式

mtl.createShortcut 待实现

用于创建桌面快捷方式。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.createShortcut({ url: string; name: string; icon: string; title?: string })

参数

参数类型说明
urlstring快捷方式的对应页面的 url
namestring快捷方式名称
iconstring快捷方式图标
title?string快捷方式的对应页面的标题

调用示例

const result = await mtl.createShortcut({ url: /* string */, name: /* string */, icon: /* string */, title: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/打电话

mtl.dail 可用

用于拨打电话。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.dail({ number: string })

参数

参数类型说明
numberstring电话号码

调用示例

const result = await mtl.dail({ number: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/手势

mtl.switchLongPress 不支持

用于长按手势。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.switchLongPress({ enabled: int })

参数

参数类型说明
enabledint0：禁用长按事件、1：启用长按事件

调用示例

const result = await mtl.switchLongPress({ enabled: /* int */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/应用信息

mtl.getAppInformation 可用

用于获取友空间客户端bundleID。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.getAppInformation()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.getAppInformation()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/网络状态

mtl.getNetworkType 可用

用于获取网络状态。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.getNetworkType()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.getNetworkType()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/网络状态

mtl.onNetworkStatusChange 待实现

用于监听网络状态变化。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.onNetworkStatusChange({ callback: function })

参数

参数类型说明
callbackfunction网络变化时的回调函数

调用示例

const result = await mtl.onNetworkStatusChange({ callback: /* function */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/恩普特

mtl.bindSensor 不支持

用于恩普特绑定设备。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.bindSensor({ address: string })

参数

参数类型说明
addressstring要绑定设备的mac地址

调用示例

const result = await mtl.bindSensor({ address: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/恩普特

mtl.collectRev 不支持

用于恩普特转速采集。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.collectRev({ callback: function })

参数

参数类型说明
callbackfunction采集到转速时回调的函数

调用示例

const result = await mtl.collectRev({ callback: /* function */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/恩普特

mtl.collectTmp 不支持

用于恩普特温度采集。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.collectTmp({ emissivity: string; callback: function })

参数

参数类型说明
emissivitystring发射率（0~1）
callbackfunction采集到温度时回调的函数

调用示例

const result = await mtl.collectTmp({ emissivity: /* string */, callback: /* function */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/恩普特

mtl.collectVib 不支持

用于恩普特测振采集。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.collectVib({ collectionType: string; savewave?: boolean; callback: function })

参数

参数类型说明
collectionTypestring采集类型。ACC:加速度；SPEED: 速度；DIS: 位移
savewave?boolean是否采集波值
callbackfunction采集到测振时回调的函数

调用示例

const result = await mtl.collectVib({ collectionType: /* string */, savewave: /* boolean */, callback: /* function */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/恩普特

mtl.connectBle 不支持

用于恩普特连接设备。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.connectBle({ address: string })

参数

参数类型说明
addressstring需要连接的设备 mac 地址

调用示例

const result = await mtl.connectBle({ address: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/恩普特

mtl.disconnectBle 不支持

用于恩普特断开连接。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.disconnectBle()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.disconnectBle()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/恩普特

mtl.getBindedSensor 不支持

用于恩普特获取绑定设备的 macAddress。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.getBindedSensor()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.getBindedSensor()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/恩普特

mtl.getConnectStatus 不支持

用于恩普特获取连接状态。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.getConnectStatus()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.getConnectStatus()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/恩普特

mtl.registerConnectStatusListener 不支持

用于恩普特连接状态监听。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.registerConnectStatusListener({ callback: function })

参数

参数类型说明
callbackfunction当前绑定的传感器连接状态变化时的回调函数

调用示例

const result = await mtl.registerConnectStatusListener({ callback: /* function */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/恩普特

mtl.release 不支持

用于恩普特释放资源。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.release()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.release()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/恩普特

mtl.searchBleClient 不支持

用于恩普特搜索蓝牙设备。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.searchBleClient({ searchTime: number; searchCount: number; callback: function })

参数

参数类型说明
searchTimenumber每次扫描的时长，单位毫秒
searchCountnumber扫描 BLE 设备的次数
callbackfunction搜索到蓝牙设备时的回调函数

调用示例

const result = await mtl.searchBleClient({ searchTime: /* number */, searchCount: /* number */, callback: /* function */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/恩普特

mtl.stopCollect 不支持

用于恩普特停止采集。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.stopCollect()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.stopCollect()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/智能套件-ORC

mtl.recognizeBankCard 不支持

用于配合图像接口使用，直接识别已选择(或下载)的图片。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.recognizeBankCard({ appCode: string; image: string })

参数

参数类型说明
appCodestringapiLink申请的 appcode
imagestring图片，支持 localId/base64

调用示例

const result = await mtl.recognizeBankCard({ appCode: /* string */, image: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/智能套件-ORC

mtl.recognizeIDCard 不支持

用于配合图像接口使用，直接识别已选择(或下载)的图片。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.recognizeIDCard({ appCode: string; side: string; image: string })

参数

参数类型说明
appCodestringapiLink申请的 appcode
sidestring身份证正反面；face/back
imagestring图片，支持 localId/base64

调用示例

const result = await mtl.recognizeIDCard({ appCode: /* string */, side: /* string */, image: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/智能套件-ORC

mtl.recognizeInvoice 不支持

用于配合图像接口使用，直接识别已选择(或下载)的图片。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.recognizeInvoice({ appCode: string; image: string })

参数

参数类型说明
appCodestringapiLink申请的 appcode
imagestring图片，支持 localId/base64

调用示例

const result = await mtl.recognizeInvoice({ appCode: /* string */, image: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/智能套件-ORC

mtl.scanBankCard 不支持

用于打开相机扫描银行卡并返回识别结果 （APILINK所选择服务名称：银行卡识别OCRV2）。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.scanBankCard({ appCode: string })

参数

参数类型说明
appCodestringapiLink申请的 appcode

调用示例

const result = await mtl.scanBankCard({ appCode: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/智能套件-ORC

mtl.scanIDCard 不支持

用于打开相机扫描身份证并返回识别结果 （APILINK所选择服务名称：身份证OCRV2）。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.scanIDCard({ appCode: string; side: string })

参数

参数类型说明
appCodestringapiLink申请的 appcode
sidestring身份证正反面；face/back

调用示例

const result = await mtl.scanIDCard({ appCode: /* string */, side: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/智能套件-ORC

mtl.scanInvoice 不支持

用于打开相机拍摄发票并返回识别结果（APILINK所选择服务名称：增值税发票识别OCRV2）。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.scanInvoice({ appCode: string })

参数

参数类型说明
appCodestringapiLink申请的 appcode

调用示例

const result = await mtl.scanInvoice({ appCode: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/PDA

mtl.startPDAScan 不支持

用于 pda 开启扫描监听。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.startPDAScan({ callback: string })

参数

参数类型说明
callbackstring监听事件回调名称

调用示例

const result = await mtl.startPDAScan({ callback: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/PDA

mtl.stopPDAScan 不支持

用于 pda 停止扫描监听。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.stopPDAScan()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.stopPDAScan()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/设备隐私权限

mtl.getAuthorizationStatus 待实现

用于相册、相机等设备使用权限查询。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.getAuthorizationStatus({ type: number })

参数

参数类型说明
typenumber授权类型。0相册权限开关；1相机权限开关；2麦克风权限开关；3位置权限开关；4通讯录权限开关

调用示例

const result = await mtl.getAuthorizationStatus({ type: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/设备隐私权限

mtl.requestPermission 待实现

用于向友空间app申请相册、相机等设备隐私权限。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.requestPermission({ list: array })

参数

参数类型说明
listarray需要申请权限数组

调用示例

const result = await mtl.requestPermission({ list: /* array */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/生成二维码

mtl.changeCustomScanMode 待实现

用于对扫描页面进行页面级扫描模式切换。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.changeCustomScanMode({ type?: number })

参数

参数类型说明
type?number切换当前页面扫描方式，0: 单次 1: 连续

调用示例

const result = await mtl.changeCustomScanMode({ type: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/生成二维码

mtl.changeFlashLightStatus 待实现

用于改变 mdf 悬浮扫描页面的闪光灯状态，可动态设置为开启/关闭。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.changeFlashLightStatus({ type?: number })

参数

参数类型说明
type?number自定义扫描页面的闪光灯状态。0: 关闭 1: 开启

调用示例

const result = await mtl.changeFlashLightStatus({ type: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/生成二维码

mtl.customScanQRCode 待实现

用于调用扫一扫功能，对二维码或者条码进行扫描。(友空间5.18.0及以上版本)。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.customScanQRCode({ type?: number; url: string; callback: string; customNavi?: number; leftItems?: object []; rightItems?: object []; centerItems?: object [] })

参数

参数类型说明
type?number扫描方式。 0: 单次，扫描出结果后自动关闭页面 1: 连续，扫描出结果后不自动关闭页面
urlstring扫码页面内部扫描结果浏览器的网址
callbackstring扫描完成后的回调方法名
customNavi?number1: 自定义导航 0: 默认导航
leftItems?object []导航栏左边的菜单项 (点击默认关闭页面)
rightItems?object []导航栏右边的菜单项
centerItems?object []导航栏中间的菜单项

调用示例

const result = await mtl.customScanQRCode({ type: /* number */, url: /* string */, callback: /* string */, customNavi: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/生成二维码

mtl.generateQRCode 待实现

用于生成二维码。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.generateQRCode({ str: string; size?: number })

参数

参数类型说明
strstring用于生成二维码的字符串
size?number生成图片大小，默认 100 * 100

调用示例

const result = await mtl.generateQRCode({ str: /* string */, size: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/生成二维码

mtl.mdfChangeCustomScanMode 待实现

用于【MDF专用】悬浮扫描页面进行页面级扫描模式切换，可动态设置为单次扫描/连续扫描。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.mdfChangeCustomScanMode({ type?: number })

参数

参数类型说明
type?number切换当前页面扫描方式。0: 单次 1: 连续

调用示例

const result = await mtl.mdfChangeCustomScanMode({ type: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/生成二维码

mtl.mdfChangeFlashLightStatus 待实现

用于【MDF专用】改变 mdf 悬浮扫描页面的闪光灯状态，可动态设置为开启/关闭。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.mdfChangeFlashLightStatus({ type?: number })

参数

参数类型说明
type?number自定义扫描页面的闪光灯状态。0: 关闭 1: 开启

调用示例

const result = await mtl.mdfChangeFlashLightStatus({ type: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/生成二维码

mtl.mdfCustomScanQRCode 待实现

用于【MDF专用】调用扫一扫功能，对二维码或者条码进行扫描，可定制扫描框的位置和大小。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.mdfCustomScanQRCode()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.mdfCustomScanQRCode()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/生成二维码

mtl.relayoutCustomWebview 待实现

用于自定义扫描展开或收起。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.relayoutCustomWebview({ type?: number })

参数

参数类型说明
type?number刷新界面。0: 收起；1: 展开。

调用示例

const result = await mtl.relayoutCustomWebview({ type: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/生成二维码

mtl.scanQRCode 待实现

用于调起扫一扫。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.scanQRCode({ onlySignalScanner?: bool; formatType?: string; needResult?: number })

参数

参数类型说明
onlySignalScanner?bool是否使用单码扫描模式，默认false。
formatType?string指定码类型，当前仅onlySignalScanner = true时支持。 ALL：扫描所有条码类型，默认类型。 UPC_E：UPC-E条码类型。 UPC_A：UPC-A条码类型。 QR_CODE：QR code二维码类型。 QR_CODEQR_CODE：PDF417二维码类型。 ITF：ITF-14条码类型。 EAN_13：EAN-13条码类型。 EAN_8：EAN-8条码类型。 DATA_MATRIX：Data Matrix二维码类型。 CODE_128：Code 128条码类型。 CODE_93：Code 93条码类型。 CODE_39：Code 39条码类型。 CODABAR：Code Bar条码类型。 AZTEC：AZTEC二维码类型。
needResult?number默认为0，扫描结果由端上处理，1则直接返回扫描结果。

调用示例

const result = await mtl.scanQRCode({ onlySignalScanner: /* bool */, formatType: /* string */, needResult: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/生成二维码

mtl.suspendScanQRCode 待实现

用于调用扫一扫功能，对二维码或者条码进行扫描，可定制扫描框的位置和大小。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.suspendScanQRCode({ type?: number; hide?: number; callback: function; scanLeftRatio?: number; scanTopRatio?: number; scanWidthRatio?: number; scanHeightRatio?: number })

参数

参数类型说明
type?number扫描方式 0: 单次，扫描出结果后自动关闭页面 1: 连续，扫描出结果后不自动关闭页面
hide?number是否隐藏悬浮扫描框 0:显示 1:隐藏
callbackfunction扫描结果的回调方法
scanLeftRatio?number扫描框左边与屏幕左边的间距占屏幕宽度的比例，范围[0,1]
scanTopRatio?number扫描框顶部与屏幕顶部的间距占屏幕高度的比例，范围[0,1]
scanWidthRatio?number扫描框宽度占屏幕宽度的比例，范围[0, 1]
scanHeightRatio?number扫描框高度占屏幕高度的比例，范围[0, 1]

调用示例

const result = await mtl.suspendScanQRCode({ type: /* number */, hide: /* number */, callback: /* function */, scanLeftRatio: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/生成二维码

mtl.toggleCamera 待实现

用于自定义扫描页面开关摄像头。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.toggleCamera({ type?: number })

参数

参数类型说明
type?number设置摄像头状态。0: 关闭 1: 开启

调用示例

const result = await mtl.toggleCamera({ type: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/截屏

mtl.onUserCaptureScreen 待实现

用于监听用户主动截屏事件，用户使用系统截屏按键截屏时触发。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.onUserCaptureScreen({ callback: function })

参数

参数类型说明
callbackfunction用户截屏时的回调函数

调用示例

const result = await mtl.onUserCaptureScreen({ callback: /* function */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/截屏

mtl.screenShot 待实现

用于长按手势。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.screenShot({ type?: number; resultType?: number })

参数

参数类型说明
type?number0 只截取当前webview的图像；1 截取整个友空间APP的图像（包含导航条）
resultType?number0 返回截图的base字符串；1 返回截图的存储路径

调用示例

const result = await mtl.screenShot({ type: /* number */, resultType: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/摇一摇

mtl.onShake 不支持

用于监听摇一摇。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.onShake({ callback: function })

参数

参数类型说明
callbackfunction回调函数

调用示例

const result = await mtl.onShake({ callback: /* function */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/系统信息

mtl.getSystemInfo 可用

用于获取系统信息。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.getSystemInfo()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.getSystemInfo()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/系统信息

mtl.getUniqueId 可用

用于获取设备唯一标识。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.getUniqueId()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.getUniqueId()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/震动

mtl.vibrateLong 不支持

用于使手机发生较长时间的震动。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.vibrateLong()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.vibrateLong()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/震动

mtl.vibrateOnce 不支持

用于使手机发生一次短暂震动。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.vibrateOnce()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.vibrateOnce()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/斑马打印机

mtl.rfidConnect 不支持

用于连接RFID设备，并监听标签数据。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.rfidConnect({ callback: function })

参数

参数类型说明
callbackfunction监听事件回调

调用示例

const result = await mtl.rfidConnect({ callback: /* function */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/斑马打印机

mtl.rfidDisconnect 不支持

用于断开连接RFID设备，并监听标签数据。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.rfidDisconnect()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.rfidDisconnect()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/斑马打印机

mtl.zebraPrinterList 不支持

用于斑马蓝牙打印机扫描设备。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.zebraPrinterList()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.zebraPrinterList()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/斑马打印机

mtl.zebraPrintImage 不支持

用于斑马蓝牙打印图片。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.zebraPrintImage({ images: string; serialNumber: string })

参数

参数类型说明
imagesstring图片数据base64编码后的数组字符串
serialNumberstring打印设备mac地址

调用示例

const result = await mtl.zebraPrintImage({ images: /* string */, serialNumber: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/文件服务

mtl.fileSystemInit 待实现

友空间兼容方法。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.fileSystemInit({ environment?: string; jsUrl?: string })

参数

参数类型说明
environment?string环境参数。 u8c_test：测试环境 u8c_daily：日常环境 ys_pre || pre：预发环境 online：线上环境
jsUrl?string协作套件地址

调用示例

const result = await mtl.fileSystemInit({ environment: /* string */, jsUrl: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/文件服务

mtl.fileSystemRender 待实现

友空间兼容方法。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.fileSystemRender({ environment?: string; jsUrl?: string })

参数

参数类型说明
environment?string环境参数。 u8c_test：测试环境 u8c_daily：日常环境 ys_pre || pre：预发环境 online：线上环境
jsUrl?string协作套件地址

调用示例

const result = await mtl.fileSystemRender({ environment: /* string */, jsUrl: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/选择文件

mtl.chooseFile 待实现

用于选择文件。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.chooseFile({ url: string; fileType: string; fileName?: string; autoPreview?: number; header?: object; formBody?: object; jsonBody?: string })

参数

参数类型说明
urlstring需要下载资源的url
fileTypestring文件格式jpg, txt, pdf等
fileName?string文件名 如abc.jpg等（仅友空间、私有版支持）
autoPreview?number是否自动打开预览界面，0不打开，1打开，默认0（仅友空间、私有版支持）
header?objecthttp请求头部参数（仅友空间、私有版支持）
formBody?objecthttp请求额外body参数-表单形式。参数非空为post请求，否则为get请求。（仅友空间、私有版支持）
jsonBody?stringhttp请求额外参数-json形式（仅友空间、私有版支持）

调用示例

const result = await mtl.chooseFile({ url: /* string */, fileType: /* string */, fileName: /* string */, autoPreview: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/选择文件

mtl.chooseFileFromLibrary 待实现

用于文库和文件传输列表中选择文件。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.chooseFileFromLibrary({ type?: number })

参数

参数类型说明
type?number选择类型，0 从文库列表和传输列表选择，1 从文库列表选择，2 从传输列表选择

调用示例

const result = await mtl.chooseFileFromLibrary({ type: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/选择文件

mtl.chooseLocalFiles 待实现

用于选择本地文件。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.chooseLocalFiles({ maxNumber?: number })

参数

参数类型说明
maxNumber?number可以选择文件的最大数量默认是5，不能超过5或者小于等于0，这种情况默认是5个。 独立包安卓可以多选，其他单选。

调用示例

const result = await mtl.chooseLocalFiles({ maxNumber: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/选择文件

mtl.chooseLocalFileToServer 待实现

友空间兼容方法。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.chooseLocalFileToServer()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.chooseLocalFileToServer()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/选择文件

mtl.openLibraryFiles 待实现

用于打开文库内文件。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.openLibraryFiles({ firstCatalog?: number; secondCatalog?: number; thirdCatalog?: number })

参数

参数类型说明
firstCatalog?number一级目录(企业文档：1；内部群文档：2；我的文档：3；项目文档：4)
secondCatalog?number二级目录(企业文档：0；我的文档：0；我的文档(TA人共享)：-4；内部群文档：内部群ID；项目文档：项目ID；)
thirdCatalog?number三级目录(文件夹id)

调用示例

const result = await mtl.openLibraryFiles({ firstCatalog: /* number */, secondCatalog: /* number */, thirdCatalog: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/选择文件

mtl.openLocalFile 待实现

用于打开本地文件。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.openLocalFile({ filePath: string; fileType: string; openInOtherApp?: string })

参数

参数类型说明
filePathstring文件的本地地址（通过下载文件获取的本地路径）
fileTypestring文件格式jpeg，txt，pdf等
openInOtherApp?string是否调用其他应用打开【该参数仅对iOS生效，android本身该功能就是用系统应用打开，无需解析】

调用示例

const result = await mtl.openLocalFile({ filePath: /* string */, fileType: /* string */, openInOtherApp: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/下载

mtl.downloadFile 待实现

用于文件下载。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.downloadFile({ url: string; fileType: string; fileName?: string; autoPreview?: number; header?: object; formBody?: object; jsonBody?: string; joinTransferList?: string; jumpToDowndloadList?: string })

参数

参数类型说明
urlstring需要下载资源的url
fileTypestring文件格式jpg, txt, pdf等
fileName?string文件名 如abc.jpg等（仅友空间、私有版支持）
autoPreview?number是否自动打开预览界面，0不打开，1打开，默认0（仅友空间、私有版支持）
header?objecthttp请求头部参数（仅友空间、私有版支持）
formBody?objecthttp请求额外body参数-表单形式。参数非空为post请求，否则为get请求。（仅友空间、私有版支持）
jsonBody?stringhttp请求额外参数-json形式（仅友空间、私有版支持）
joinTransferList?string是否显示在我的下载；0 不显示 1显示。
jumpToDowndloadList?string是否直接跳转到我的下载界面；0不显示，1显示。

调用示例

const result = await mtl.downloadFile({ url: /* string */, fileType: /* string */, fileName: /* string */, autoPreview: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/预览

mtl.previewDoc 待实现

用于提供文件下载url或者文件fid，实现文件的预览，界面可包含下载等功能。(友空间5.18.0及以上版本)。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.previewDoc({ fileId: string; fromType?: number; serviceCode?: string })

参数

参数类型说明
fileIdstring文件ID
fromType?number文件来源
serviceCode?string服务编码。 h5必传参数

调用示例

const result = await mtl.previewDoc({ fileId: /* string */, fromType: /* number */, serviceCode: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/预览

mtl.previewFile 待实现

用于预览文件。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.previewFile({ fid: string; from_type: number; file_type?: number; filename?: string; need_download?: number; serviceCode?: string })

参数

参数类型说明
fidstring文件ID或下载url（下载url预览from_type传入5）
from_typenumber0来自文库（废弃），1IM，2web，3项目，4旧IM，5下载地址预览，6公告附件，7.新NC预览，8任务预览，9金格编辑
file_type?number1.企业文档，2.团队文档，3.我的文档，4.项目文档
filename?string文件名（fid为下载url的预览,即from_type=5的时候，文件名必须传且必须带后缀名）
need_download?number是否需要下载按钮（0不需要，1需要，对from_type = 5有效）
serviceCode?string服务编码。 h5必传参数

调用示例

const result = await mtl.previewFile({ fid: /* string */, from_type: /* number */, file_type: /* number */, filename: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/预览

mtl.wpsPreview 待实现

用于WPS文件预览。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.wpsPreview({ fileUrl: string; fileId: string; fileName: string; fileExt: string; appId: string; serviceCode?: string })

参数

参数类型说明
fileUrlstring文件地址，使用 url 方式时必传
fileIdstring文件 id，使用文件 fid 方式时必传
fileNamestring文件名称
fileExtstring文件扩展名
appIdstring文件来源，具体应用调用需要传入自己的 appId 才生效
serviceCode?string服务编码。 h5必传参数

调用示例

const result = await mtl.wpsPreview({ fileUrl: /* string */, fileId: /* string */, fileName: /* string */, fileExt: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/工具

mtl.isFileExist 待实现

用于获取本地文件是否存在。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.isFileExist({ filePath: string })

参数

参数类型说明
filePathstring文件本地URL路径

调用示例

const result = await mtl.isFileExist({ filePath: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/工具

mtl.moveFileToDisk 待实现

用于移动文件到沙盒目录。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.moveFileToDisk({ filePath: string })

参数

参数类型说明
filePathstring文件本地URL路径

调用示例

const result = await mtl.moveFileToDisk({ filePath: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/上传

mtl.uploadFile 待实现

用于文件上传，将本地文件上传到指定服务器。客户端发起一个 HTTPS POST 请求，其中 content-type 为 multipart/form-data。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.uploadFile({ url: string; filePath: string; header?: object; formData?: object })

参数

参数类型说明
urlstring指定服务器地址
filePathstring文件路径
header?objectHTTP 请求 Header
formData?objectHTTP 请求中其他额外的 form data

调用示例

const result = await mtl.uploadFile({ url: /* string */, filePath: /* string */, header: /* object */, formData: /* object */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/上传

mtl.uploadToFileService 待实现

用于文件上传，将本地文件上传到文件服务的服务器或指定服务器。客户端发起一个 HTTPS POST 请求，其中 content-type 为 multipart/form-data。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.uploadToFileService({ url?: string; domain?: string; filePath: string || File; fileName?: string; name?: string; unifiedSession?: bool; header?: object; formData?: object })

参数

参数类型说明
url?string服务器地址
domain?string文件服务的 api 域名
filePathstring || File文件路径 || 文件对象 || base64数据
fileName?stringfilePath为base64时，推荐自行传递
name?string文件对象对应的上传 key
unifiedSession?bool友空间 || 友空间私有版中，需要屏蔽header时可传递
header?objectHTTP 请求 Header
formData?objectHTTP 请求中其他额外的 form data

调用示例

const result = await mtl.uploadToFileService({ url: /* string */, domain: /* string */, filePath: /* string || File */, fileName: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/定位

mtl.getLocation 待实现

用于获取位置信息。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.getLocation({ type?: string; jsKey?: string; jsCode?: string; exParameters?: object })

参数

参数类型说明
type?string默认为 'wgs84' 的gps坐标，如果要返回直接给openLocation用的火星坐标，可传入 'gcj02'。
jsKey?string支持自行传入高德地图api调用key
jsCode?string支持自行传入高德地图api调用安全密钥
exParameters?object2.0版本GeolocationOptions 参数扩展

调用示例

const result = await mtl.getLocation({ type: /* string */, jsKey: /* string */, jsCode: /* string */, exParameters: /* object */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/定位

mtl.openMap 待实现

用于打开地图。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.openMap({ latitude: number; longitude: number; searchRaidus?: number; name?: string; address?: string; scale?: number; exParameters?: object })

参数

参数类型说明
latitudenumber纬度，浮点数，范围为90 ~ -90
longitudenumber经度，浮点数，范围为180 ~ -180。
searchRaidus?number查询半径（单位：米），小于0时不限制(微信、飞书、钉钉不支持)
name?string位置名，如 "用友软件园"，缺省时显示 "[位置]"（微信、飞书、钉钉支持）
address?string地址详情说明（微信、飞书支持）
scale?number地图缩放级别,整形值。（微信：范围从1 ~ 28；飞书：范围从5 ~ 18）
exParameters?object2.0版本GeolocationOptions 参数扩展。默认{}

调用示例

const result = await mtl.openMap({ latitude: /* number */, longitude: /* number */, searchRaidus: /* number */, name: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/地图

mtl.getContinuousLocation 待实现

用于获取持续定位信息。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.getContinuousLocation()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.getContinuousLocation()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/地图

mtl.mapLocationExtend 待实现

用于地图定位扩展。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.mapLocationExtend({ latitude: string; longitude: string; targetDistance?: number })

参数

参数类型说明
latitudestring纬度
longitudestring经度
targetDistance?number目标距离，单位米

调用示例

const result = await mtl.mapLocationExtend({ latitude: /* string */, longitude: /* string */, targetDistance: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/地图

mtl.markAndNavigationDestination 待实现

用于在地图中展示目标点以及跳转第三方地图进行导航。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.markAndNavigationDestination({ address?: string; subAddress?: string; latitude: string; longitude: string; userInfo?: object; infomation?: string; navigation?: Boolean })

参数

参数类型说明
address?string目标地区地址
subAddress?string目标地区详细地址
latitudestring目标地区纬度
longitudestring目标地区经度
userInfo?object用户信息
infomation?string客户信息
navigation?Boolean是否需要导航

调用示例

const result = await mtl.markAndNavigationDestination({ address: /* string */, subAddress: /* string */, latitude: /* string */, longitude: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/地图

mtl.NAVITYPE 待实现

用于获取地图标识。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.NAVITYPE()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.NAVITYPE()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/地图

mtl.startContinuousLocation 待实现

用于开启持续定位。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.startContinuousLocation()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.startContinuousLocation()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/地图

mtl.stopContinuousLocation 待实现

用于停止持续定位。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.stopContinuousLocation()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.stopContinuousLocation()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/音频

mtl.onVoicePlayEnd 待实现

用于监听录音播放完毕。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.onVoicePlayEnd()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.onVoicePlayEnd()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/音频

mtl.onVoiceRecordEnd 待实现

用于监听录音自动停止，录音时间超过一分钟没有停止的时候会执行 complete 回调。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.onVoiceRecordEnd()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.onVoiceRecordEnd()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/音频

mtl.pauseVoice 待实现

用于暂停播放录音，继续播放需要调用 playVoice方法。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.pauseVoice({ localId: String })

参数

参数类型说明
localIdString需要暂停的音频的本地ID，由 stopRecord 接口获得

调用示例

const result = await mtl.pauseVoice({ localId: /* String */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/音频

mtl.playVoice 待实现

用于监听录音自动停止，录音时间超过一分钟没有停止的时候会执行 complete 回调。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.playVoice({ localId: String; url?: String })

参数

参数类型说明
localIdString需要播放的音频的本地ID，由 stopRecord 接口获得
url?String播放线上路径(mtl 6.1.4支持)。 私有版支持

调用示例

const result = await mtl.playVoice({ localId: /* String */, url: /* String */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/音频

mtl.recordAudio 待实现

用于提供录音界面以及功能，支持最长60s录音，返回经过BASE64加密处理后的音频数据字符串。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.recordAudio()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.recordAudio()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/音频

mtl.showRecordAudio 待实现

用于提供录音界面以及功能，支持最长60s录音，返回经过BASE64加密处理后的音频数据字符串。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.showRecordAudio()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.showRecordAudio()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/音频

mtl.startRecord 待实现

用于开始录音。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.startRecord()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.startRecord()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/音频

mtl.stopRecord 待实现

用于结束录音。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.stopRecord()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.stopRecord()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/音频

mtl.stopVoice 待实现

用于结束播放录音。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.stopVoice({ localId: String })

参数

参数类型说明
localIdString需要暂停的音频的本地ID，由 stopRecord 接口获得

调用示例

const result = await mtl.stopVoice({ localId: /* String */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/图片

mtl.addImageWaterMark 待实现

友空间兼容方法。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.addImageWaterMark({ image: String; watermark: Object })

参数

参数类型说明
imageString图片路径 (h5是base64数据, wx可以是base64数据)
watermarkObject照片添加水印

调用示例

const result = await mtl.addImageWaterMark({ image: /* String */, watermark: /* Object */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/图片

mtl.chooseImage 待实现

用于从系统相册中选择图片，或使用相机拍摄图片。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.chooseImage({ count?: number; sourceType?: string []; watermark?: object; returnThumbnail?: bool; sizeType?: string []; position?: string; isSaveToAlbum?: string; secret?: bool })

参数

参数类型说明
count?number最多可以选择的图片张数。 飞书最大支持选择20张。 钉钉在 sourceType 参数内只有camera时，参数只能传1。
sourceType?string []选择图片的来源
watermark?object照片添加水印，只有拍照功能下生效（钉钉不支持）
returnThumbnail?bool是否需要返回缩略图（钉钉不支持）
sizeType?string []可以指定是原图还是压缩图，默认二者都有（仅微信、飞书支持） ["original"]：选择原图。 ["compressed"]：强制对图片质量进行压缩。
position?string相机拍照使用的摄像头： front：前置摄像头。 back：后置摄像头。 （仅钉钉、飞书支持；钉钉仅安卓支持；飞书仅在 sourceType 为 camera 时生效）
isSaveToAlbum?string是否需要存储到相册。 "0"：不保存。 "1"：保存。 （仅飞书支持，在 sourceType 为 camera 时生效）
secret?bool相机拍照生成的图片，是否存储到私有目录。（仅钉钉支持）

调用示例

const result = await mtl.chooseImage({ count: /* number */, sourceType: /* string [] */, watermark: /* object */, returnThumbnail: /* bool */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/图片

mtl.chooseImages 待实现

用于从系统相册中选择图片，或使用系统相机拍摄图片，MTL 6.3.0 版本开始支持。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.chooseImages({ sourceType?: string []; count?: int; returnThumbnail?: boolen; watermark?: object; shootMode?: int; mirror?: boolen; recordSecond?: int; isEditImage?: boolen; isSaveToAlbum?: boolen; isSaveOriginal?: boolen })

参数

参数类型说明
sourceType?string []选择图片的来源。
count?int最多可以选择的图片张数，仅从相册选择时有效，相机拍照只会返回一张
returnThumbnail?boolen是否需要返回缩略图，watermark生效时，此参数无效，只返回带水印的路径
watermark?object图片水印字符串，不传则不显示水印,仅图片支持水印设置
shootMode?int拍摄模式，友空间内支持！。 0：拍照片+拍视频 1：拍照片 2：拍视频
mirror?boolen是否关闭自拍镜像，前置摄像头拍照时生效，友空间内支持！
recordSecond?int拍摄视频时的视频时长，友空间内支持！
isEditImage?boolen拍照完成后是否显示画笔按钮，仅拍照模式下支持，友空间内支持！
isSaveToAlbum?boolen拍照完成后保存相册照片是否带水印，仅拍照模式下支持，友空间内支持！
isSaveOriginal?boolen拍照或录制视频后是否保存到系统相册目录，友空间内支持！

调用示例

const result = await mtl.chooseImages({ sourceType: /* string [] */, count: /* int */, returnThumbnail: /* boolen */, watermark: /* object */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/图片

mtl.chooseImageToServer 待实现

用于 从本地相册选择图片或使用相机拍照，并把文件上传到友空间服务器，返回视频链接地址和信息。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.chooseImageToServer({ count?: number; sourceType?: String Array; watermark?: object })

参数

参数类型说明
count?number最多可以选择的图片张数
sourceType?String Array选择图片的来源
watermark?object照片添加水印，只有拍照功能下生效(wx不支持)

调用示例

const result = await mtl.chooseImageToServer({ count: /* number */, sourceType: /* String Array */, watermark: /* object */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/图片

mtl.compressLocalImage 待实现

用于图片压缩。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.compressLocalImage({ type?: Number; level?: Number; imgData: String })

参数

参数类型说明
type?Number图片数据类型（0 或 1） 0: 图片 base64 数据； 1: 图片路径
level?Number压缩的级别，支持 0 ~ 3 的整数 0:不压缩；1: 低质量； 2:中质量； 3:高质量
imgDataString图片地址或 base64 数据

调用示例

const result = await mtl.compressLocalImage({ type: /* Number */, level: /* Number */, imgData: /* String */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/图片

mtl.continuousShooting 待实现

友空间兼容方法。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.continuousShooting({ count?: number })

参数

参数类型说明
count?number最多可以连拍的图片张数，最多支持 9

调用示例

const result = await mtl.continuousShooting({ count: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/图片

mtl.continuousShootingLocal 待实现

友空间兼容方法。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.continuousShootingLocal({ count?: number })

参数

参数类型说明
count?number最多可以连拍的图片张数，最多支持 9

调用示例

const result = await mtl.continuousShootingLocal({ count: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/图片

mtl.deleteBase64Image 待实现

友空间兼容方法。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.deleteBase64Image({ name: string })

参数

参数类型说明
namestring图片的名称

调用示例

const result = await mtl.deleteBase64Image({ name: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/图片

mtl.getBase64Image 待实现

友空间兼容方法。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.getBase64Image({ name: String })

参数

参数类型说明
nameString图片的名称

调用示例

const result = await mtl.getBase64Image({ name: /* String */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/图片

mtl.getLocalImgData 待实现

友空间兼容方法。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.getLocalImgData({ localId: String })

参数

参数类型说明
localIdString图片的localID

调用示例

const result = await mtl.getLocalImgData({ localId: /* String */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/图片

mtl.previewImage 待实现

用于预览一组图片。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.previewImage({ current?: string; urls: string []; yht_access_token?: string; header?: object; shouldShowSaveOption?: bool })

参数

参数类型说明
current?string当前显示图片的 url
urlsstring []需要预览的图片 url 列表
yht_access_token?string访问用友文件服务时需要传
header?object请求头（Header），对传入的网络 url 生效。示例值：{"csrf-token": "<redacted>"}（仅飞书支持）
shouldShowSaveOption?bool在预览页长按后，是否显示保存图片选项。（仅飞书支持）

调用示例

const result = await mtl.previewImage({ current: /* string */, urls: /* string [] */, yht_access_token: /* string */, header: /* object */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/图片

mtl.saveBase64Image 待实现

友空间兼容方法。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.saveBase64Image({ name: String; base64str: String })

参数

参数类型说明
nameString图片的名称
base64strString图片的 base64 数据

调用示例

const result = await mtl.saveBase64Image({ name: /* String */, base64str: /* String */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/图片

mtl.saveImageToLocal 待实现

用于保存图片到本地。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.saveImageToLocal({ url: String })

参数

参数类型说明
urlString图片的文件服务器地址

调用示例

const result = await mtl.saveImageToLocal({ url: /* String */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/图片

mtl.saveImageToPhotoAlbum 待实现

用于保存图片到相册。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.saveImageToPhotoAlbum({ url?: String })

参数

参数类型说明
url?String图片的文件服务器地址

调用示例

const result = await mtl.saveImageToPhotoAlbum({ url: /* String */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/投屏

mtl.checkMirrorStatus 不支持

用于检测投屏状态。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.checkMirrorStatus()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.checkMirrorStatus()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/投屏

mtl.closeMirrorScreen 不支持

用于关闭投屏功能。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.closeMirrorScreen()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.closeMirrorScreen()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/投屏

mtl.startMirrorScreen 不支持

用于开始投屏功能。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.startMirrorScreen({ code: string })

参数

参数类型说明
codestring投屏码

调用示例

const result = await mtl.startMirrorScreen({ code: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/视频

mtl.chooseVideo 待实现

用于选取视频。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.chooseVideo({ sourceType?: String Array; maxDuration?: Number })

参数

参数类型说明
sourceType?String Array选择视频来源，默认二者都有。['album', 'camera']
maxDuration?Number最长视频时间。最长60秒，默认15秒

调用示例

const result = await mtl.chooseVideo({ sourceType: /* String Array */, maxDuration: /* Number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/视频

mtl.chooseVideoToServer 待实现

用于选取视频并上传友空间服务器。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.chooseVideoToServer({ sourceType?: String Array; maxDuration?: Number })

参数

参数类型说明
sourceType?String Array选择视频来源，默认二者都有。['album', 'camera']
maxDuration?Number最长视频时间。最长60秒，默认15秒

调用示例

const result = await mtl.chooseVideoToServer({ sourceType: /* String Array */, maxDuration: /* Number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/视频

mtl.getVideoThumbnail 待实现

用于获取视频缩略图，返回缩略图的 base64 编码数据。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.getVideoThumbnail({ videoPath: String; thumbnailQuality?: Number })

参数

参数类型说明
videoPathString本地视频的地址
thumbnailQuality?Number缩略图质量（0-100）

调用示例

const result = await mtl.getVideoThumbnail({ videoPath: /* String */, thumbnailQuality: /* Number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/返回

mtl.canWebviewBack 待实现

用于判断浏览器当前网页是否可返回上一级。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.canWebviewBack()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.canWebviewBack()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/返回

mtl.onInterceptBack 待实现

用于拦截返回事件。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.onInterceptBack({ callback: function })

参数

参数类型说明
callbackfunction返回事件回调函数

调用示例

const result = await mtl.onInterceptBack({ callback: /* function */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/返回

mtl.webviewBack 待实现

用于浏览器当前网页返回上一级。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.webviewBack()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.webviewBack()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/导航栏

mtl.closeCurrentWebview 待实现

用于关闭当前webview。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.closeCurrentWebview({ needClose?: bool })

参数

参数类型说明
needClose?bool是否强制关闭当前页面（仅友空间、私有版支持）

调用示例

const result = await mtl.closeCurrentWebview({ needClose: /* bool */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/导航栏

mtl.getNavBarInfo 待实现

用于获取原生导航信息。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.getNavBarInfo()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.getNavBarInfo()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/导航栏

mtl.getStatusBarHeight 待实现

用于获取状态栏高度。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.getStatusBarHeight()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.getStatusBarHeight()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/导航栏

mtl.navigateBack 待实现

用于关闭当前浏览窗体。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.navigateBack({ needClose?: bool })

参数

参数类型说明
needClose?bool是否强制关闭当前页面（仅友空间、私有版支持）

调用示例

const result = await mtl.navigateBack({ needClose: /* bool */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/导航栏

mtl.navigateTo 待实现

用于打开新的浏览窗体。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.navigateTo({ url: string; orientation?: number; navShow?: number; forceShow?: bool; title?: sting })

参数

参数类型说明
urlstring新浏览器窗体加载的url
orientation?number0 强制竖屏; 1 跟随系统; 2 强制横屏（H5、微信、飞书不支持）
navShow?number0：不显示顶部导航栏 1：显示顶部导航栏（仅友空间、私有版支持），默认1
forceShow?bool是否立即将webview添加到屏幕，不用等待资源加载完成。默认false（仅友空间、私有版支持）
title?sting导航标题（仅友空间、私有版支持）

调用示例

const result = await mtl.navigateTo({ url: /* string */, orientation: /* number */, navShow: /* number */, forceShow: /* bool */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/导航栏

mtl.openNewWebview 待实现

用于打开新的webview。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.openNewWebview({ url: string; orientation?: number; navShow?: number; forceShow?: bool; title?: sting; isClearCookie?: number })

参数

参数类型说明
urlstring新浏览器窗体加载的url
orientation?number0 强制竖屏; 1 跟随系统; 2 强制横屏（H5、微信、飞书、钉钉不支持）
navShow?number0：不显示顶部导航栏 1：显示顶部导航栏（仅友空间、私有版支持），默认1
forceShow?bool是否立即将webview添加到屏幕，不用等待资源加载完成。默认false（仅友空间、私有版支持）
title?sting导航标题（仅友空间、私有版支持）
isClearCookie?number是否清除cookie。0 否；1 是(仅友空间、私有版支持)

调用示例

const result = await mtl.openNewWebview({ url: /* string */, orientation: /* number */, navShow: /* number */, forceShow: /* bool */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/导航栏

mtl.openSchema 待实现

用于打开系统浏览器。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.openSchema({ url: string })

参数

参数类型说明
urlstring新浏览器窗体加载的url

调用示例

const result = await mtl.openSchema({ url: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/导航栏

mtl.redirectTo 待实现

用于打开新的浏览窗体，并关闭当前页面。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.redirectTo({ url: string; orientation?: number; navShow?: number; forceShow?: bool; title?: sting; isClearCookie?: number })

参数

参数类型说明
urlstring新浏览器窗体加载的url
orientation?number0 强制竖屏; 1 跟随系统; 2 强制横屏（H5、微信、飞书不支持）
navShow?number0：不显示顶部导航栏 1：显示顶部导航栏（仅友空间、私有版支持）
forceShow?bool是否立即将webview添加到屏幕，不用等待资源加载完成。默认false（仅友空间、私有版支持）
title?sting导航标题（仅友空间、私有版支持）
isClearCookie?number是否清除cookie。0 否；1 是(仅友空间、私有版支持)

调用示例

const result = await mtl.redirectTo({ url: /* string */, orientation: /* number */, navShow: /* number */, forceShow: /* bool */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/导航栏

mtl.reLaunch 待实现

用于打开新的浏览窗体，关闭前面所有页面。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.reLaunch({ url: string; orientation?: number; navShow?: number; forceShow?: bool; title?: sting; isClearCookie?: number })

参数

参数类型说明
urlstring新浏览器窗体加载的url
orientation?number0 强制竖屏; 1 跟随系统; 2 强制横屏（H5、微信、飞书不支持）
navShow?number0：不显示顶部导航栏 1：显示顶部导航栏（仅友空间、私有版支持）
forceShow?bool是否立即将webview添加到屏幕，不用等待资源加载完成。（仅友空间、私有版支持）
title?sting导航标题（仅友空间、私有版支持）
isClearCookie?number是否清除cookie。0 否；1 是(仅友空间、私有版支持)

调用示例

const result = await mtl.reLaunch({ url: /* string */, orientation: /* number */, navShow: /* number */, forceShow: /* bool */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/导航栏

mtl.setNavBar 待实现

用于配置友空间导航栏。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.setNavBar({ hide?: Integer; backgroundColor?: String; tintColor?: String; fullScreen?: Number; hideShadowImage?: Number; statusBarStyle?: Number; leftItems?: Array; centerItems?: Array; rightItems?: Array })

参数

参数类型说明
hide?Integer是否隐藏导航栏，1隐藏 0 不隐藏，【iOS需要注意修改的是全局导航，遵循谁修改谁负责还原】
backgroundColor?String导航条背景色
tintColor?String导航栏上按钮、标题等的颜色统一设置
fullScreen?Number是否设置为通栏样式
hideShadowImage?Number是否显示导航栏底部线(仅iOS)
statusBarStyle?Number状态栏样式(仅iOS)
leftItems?Array导航栏左边的菜单项
centerItems?Array导航栏中间的菜单项
rightItems?Array导航栏右边的菜单项

调用示例

const result = await mtl.setNavBar({ hide: /* Integer */, backgroundColor: /* String */, tintColor: /* String */, fullScreen: /* Number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/导航栏

mtl.setStatusBar 待实现

用于配置友空间app状态栏。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.setStatusBar({ isScreenEdge?: string; isStatusBarDefault?: string })

参数

参数类型说明
isScreenEdge?string“1”：通栏； “0” :不通栏
isStatusBarDefault?string“1”：默认样式(白色) ； “0” ：暗黑

调用示例

const result = await mtl.setStatusBar({ isScreenEdge: /* string */, isStatusBarDefault: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/导航栏

mtl.setStatusBarStyle 待实现

用于配置友空间app状态栏是否使用暗黑模式。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.setStatusBarStyle({ fontColorMode?: number })

参数

参数类型说明
fontColorMode?number状态栏模式。1：白色，0 ：暗黑模式

调用示例

const result = await mtl.setStatusBarStyle({ fontColorMode: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/导航栏

mtl.settingNavBar 待实现

用于配置友空间导航栏。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.settingNavBar({ hide?: Integer; backgroundColor?: String; tintColor?: String; fullScreen?: Number; hideShadowImage?: Number; statusBarStyle?: Number; leftItems?: Array; centerItems?: Array; rightItems?: Array })

参数

参数类型说明
hide?Integer是否隐藏导航栏，1隐藏 0 不隐藏，【iOS需要注意修改的是全局导航，遵循谁修改谁负责还原】
backgroundColor?String导航条背景色
tintColor?String导航栏上按钮、标题等的颜色统一设置
fullScreen?Number是否设置为通栏样式
hideShadowImage?Number是否显示导航栏底部线(仅iOS)
statusBarStyle?Number状态栏样式(仅iOS)
leftItems?Array导航栏左边的菜单项
centerItems?Array导航栏中间的菜单项
rightItems?Array导航栏右边的菜单项

调用示例

const result = await mtl.settingNavBar({ hide: /* Integer */, backgroundColor: /* String */, tintColor: /* String */, fullScreen: /* Number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/系统设置

mtl.backToHome 待实现

用于应用到后台。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.backToHome({ callback: function })

参数

参数类型说明
callbackfunction网络变化是的回调函数

调用示例

const result = await mtl.backToHome({ callback: /* function */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/系统设置

mtl.jumpSystemSettings 待实现

用于跳转系统设置。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.jumpSystemSettings()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.jumpSystemSettings()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/剪贴板

mtl.getClipboardData 可用

用于获取系统剪贴板内容。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.getClipboardData()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.getClipboardData()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/剪贴板

mtl.setClipboardData 可用

用于设置系统剪贴板内容。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.setClipboardData({ data: string })

参数

参数类型说明
datastring需要复制到剪切板的内容。

调用示例

const result = await mtl.setClipboardData({ data: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/数据操作

mtl.clearCache 可用

用于清理友空间移动端的 Cache。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.clearCache()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.clearCache()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/数据操作

mtl.clearStorage 可用

用于清除所有缓存的数据。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.clearStorage({ domain?: string })

参数

参数类型说明
domain?string缺省时使用默认的域

调用示例

const result = await mtl.clearStorage({ domain: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/数据操作

mtl.decryptData 可用

用于对加密数据进行解密处理。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.decryptData({ data: string })

参数

参数类型说明
datastring需要解密的数据

调用示例

const result = await mtl.decryptData({ data: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/数据操作

mtl.encryptData 可用

用于对数据进行加密处理。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.encryptData({ data: string })

参数

参数类型说明
datastring需要加密的数据

调用示例

const result = await mtl.encryptData({ data: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/数据操作

mtl.executeDBOperate 待实现

用于执行数据库操作、建表、增删改查，SQL语句业务方操作。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.executeDBOperate({ executeType: string; executeSql: string })

参数

参数类型说明
executeTypestring执行SQL类型。0:建表；1:删表；2:新增数据；3:删除数据；4:更新数据；5:查询数据；6:修改表。
executeSqlstring执行SQL语句。业务方控制该sql安全性，创建表格要求表名字前缀为NCC_。

调用示例

const result = await mtl.executeDBOperate({ executeType: /* string */, executeSql: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/数据操作

mtl.getStorage 可用

用于获取存储的信息。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.getStorage({ domain?: string; key: string; callbackSuccess?: boolean })

参数

参数类型说明
domain?string缺省时使用默认的域
keystring存储数据用的 key
callbackSuccess?boolean是否全部执行成功回调，即未获取到值也按照成功回调方式返回 返回 { code: 200, data: null } 形式

调用示例

const result = await mtl.getStorage({ domain: /* string */, key: /* string */, callbackSuccess: /* boolean */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/数据操作

mtl.getStorageParseSync 可用sync

用于同步获取存储信息JSON对象。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

mtl.getStorageParseSync({ domain?: string; key: string })

参数

参数类型说明
domain?string缺省时使用默认的域
keystring存储数据用的 key

调用示例

const result = mtl.getStorageParseSync({ domain: /* string */, key: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/数据操作

mtl.getStorageStringifySync 可用sync

用于同步获取存储信息JSON串。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

mtl.getStorageStringifySync({ domain?: string; key: string })

参数

参数类型说明
domain?string缺省时使用默认的域
keystring存储数据用的 key

调用示例

const result = mtl.getStorageStringifySync({ domain: /* string */, key: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/数据操作

mtl.getStorageSync 可用sync

用于获取存储的信息。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

mtl.getStorageSync({ domain?: string; key: string })

参数

参数类型说明
domain?string缺省时使用默认的域
keystring存储数据用的 key

调用示例

const result = mtl.getStorageSync({ domain: /* string */, key: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/数据操作

mtl.getUserAgent 可用

用于获取友空间UserAgent信息。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.getUserAgent()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.getUserAgent()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/数据操作

mtl.removeStorage 可用

用于移除指定key的缓存数据。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.removeStorage({ domain?: string; key: string })

参数

参数类型说明
domain?string缺省时使用默认的域
keystring存储数据用的 key

调用示例

const result = await mtl.removeStorage({ domain: /* string */, key: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/数据操作

mtl.setContext 可用

用于设置MTL上下文Context。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.setContext()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.setContext()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/数据操作

mtl.setCookie 可用

用于设置友空间cookie。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.setCookie({ url: string; cookie: stirng })

参数

参数类型说明
urlstring需要注入cookie的地址
cookiestirng存储数据

调用示例

const result = await mtl.setCookie({ url: /* string */, cookie: /* stirng */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/数据操作

mtl.setStorage 可用

用于存储数据。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.setStorage({ domain?: string; key: string; data: any })

参数

参数类型说明
domain?string缺省时使用默认的域
keystring存储数据用的 key
dataany存储的数据，支持 number、string及能够通过 JSON.stringify 序列化的对象。

调用示例

const result = await mtl.setStorage({ domain: /* string */, key: /* string */, data: /* any */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/加载第三方 js

mtl.loadMtlCDNJs 不支持

用于获取动态加载 mtl 远程 js 包。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.loadMtlCDNJs({ url?: string; type?: string })

参数

参数类型说明
url?stringmtl 加载地址
type?string非微信-安卓平台必须传值all

调用示例

const result = await mtl.loadMtlCDNJs({ url: /* string */, type: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/加载第三方 js

mtl.loadRemoteResource 不支持

用于动态加载 js、css 资源。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.loadRemoteResource({ urls?: string [] })

参数

参数类型说明
urls?string []鉴权接口地址

调用示例

const result = await mtl.loadRemoteResource({ urls: /* string [] */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/mtl 框架信息

mtl.addPlatform 待实现

用于扩展平台。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.addPlatform({ platform: string; condition: function })

参数

参数类型说明
platformstring用户自定义的平台标识
conditionfunction用户自定义的平台加载逻辑。

调用示例

const result = await mtl.addPlatform({ platform: /* string */, condition: /* function */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/mtl 框架信息

mtl.extendApi 待实现

用于针对平台，扩展api。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.extendApi({ module: object; platform?: string; symbolPath?: string })

参数

参数类型说明
moduleobject扩展api集合
platform?string自定义的平台标志。缺省则默认为当前平台
symbolPath?string可扩展的命名空间。如果不自定义，默认添加到mtl 对象上；如果自定义，会添加到指定命名的对象上，例如：mtl.xxx.platform。

调用示例

const result = await mtl.extendApi({ module: /* object */, platform: /* string */, symbolPath: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/mtl 框架信息

mtl.platform 待实现

用于查看当前运行平台。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.platform()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.platform()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/mtl 框架信息

mtl.version 待实现

用于查看当前 mtl 版本号。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.version()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.version()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/多语

mtl.getExclusiveLanguage 可用

用于获取多语言信息。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.getExclusiveLanguage()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.getExclusiveLanguage()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/多语

mtl.setExclusiveLanguage 可用

用于设置多语言内容。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.setExclusiveLanguage({ language: number })

参数

参数类型说明
languagenumber多语言类别： 0:跟随系统， 1:英文， 2:简体， 3:繁体

调用示例

const result = await mtl.setExclusiveLanguage({ language: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/原生能力透传

mtl.canExecUpesnBridge 不支持

用于检测是否可以执行友空间的api。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.canExecUpesnBridge()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.canExecUpesnBridge()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/原生能力透传

mtl.checkBridgeNameExist 不支持

用于检测mtl对象上是否成功挂载了某个api。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.checkBridgeNameExist({ bridgeName: string })

参数

参数类型说明
bridgeNamestring需要检查的bridge名称

调用示例

const result = await mtl.checkBridgeNameExist({ bridgeName: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/原生能力透传

mtl.execPluginBridge 不支持

用于调用原生端函数或者指定插件函数。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.execPluginBridge({ method: string; requireName?: string })

参数

参数类型说明
methodstring需要执行的原生端或插件函数名
requireName?string插件名

调用示例

const result = await mtl.execPluginBridge({ method: /* string */, requireName: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/原生能力透传

mtl.execPluginSyncBridge 不支持

用于调用原生端函数或者指定插件函数。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.execPluginSyncBridge({ method: string; requireName?: string })

参数

参数类型说明
methodstring需要执行的原生端或插件函数名
requireName?string插件名

调用示例

const result = await mtl.execPluginSyncBridge({ method: /* string */, requireName: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/原生能力透传

mtl.execUpesnBridge 不支持

用于调用原生端或插件函数。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.execUpesnBridge({ method: string; requireName?: string })

参数

参数类型说明
methodstring需要执行的原生端或插件函数名
requireName?string插件名

调用示例

const result = await mtl.execUpesnBridge({ method: /* string */, requireName: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/原生能力透传

mtl.execUpesnBridgeify 不支持

用于直接调用原生端函数。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.execUpesnBridgeify({ name: string; param: object })

参数

参数类型说明
namestring原生端的函数名
paramobject参数体

调用示例

const result = await mtl.execUpesnBridgeify({ name: /* string */, param: /* object */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/原生能力透传

mtl.registerCallback 不支持

用于注册JS事件供原生端调用。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.registerCallback({ handleName: string; callback: function })

参数

参数类型说明
handleNamestring向原生端注册的函数名
callbackfunction回调函数

调用示例

const result = await mtl.registerCallback({ handleName: /* string */, callback: /* function */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/原生能力透传

mtl.registerCommonCallback 不支持

用于注册JS事件供原生端调用。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.registerCommonCallback({ handleName: string; callback: function })

参数

参数类型说明
handleNamestring向原生端注册的函数名
callbackfunction回调函数

调用示例

const result = await mtl.registerCommonCallback({ handleName: /* string */, callback: /* function */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/原生能力透传

mtl.registerResumeCallback 不支持

用于注册JS事件供原生端调用。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.registerResumeCallback({ handleName: string; callback: function })

参数

参数类型说明
handleNamestring向原生端注册的函数名
callbackfunction回调函数

调用示例

const result = await mtl.registerResumeCallback({ handleName: /* string */, callback: /* function */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/网络请求

mtl.request 可用

用于发送网络请求。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.request({ url: string; params?: object; headers?: object; method?: string; paramsType?: number })

参数

参数类型说明
urlstring请求接口地址
params?object请求参数
headers?object设置请求的 headers，content-type，默认为 application/json
method?string默认为 GET
paramsType?number请求参数的类型（仅友空间、私有版支持）

调用示例

const result = await mtl.request({ url: /* string */, params: /* object */, headers: /* object */, method: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/字体

mtl.getUserFontSize 待实现

用于获取字体大小。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.getUserFontSize()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.getUserFontSize()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/字体

mtl.setUserFontSize 待实现

用于设置字体大小。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.setUserFontSize({ level?: number })

参数

参数类型说明
level?number字体大小。 0：移动端字体14； 1：移动端字体16； 2：移动端字体18； 3：移动端字体20； 4：移动端字体22； 5：移动端字体24

调用示例

const result = await mtl.setUserFontSize({ level: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/生命周期

mtl.registerLifeCycle 待实现

用于页面生命周期监听（展示、隐藏）。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.registerLifeCycle({ onShow: function; onHide: function })

参数

参数类型说明
onShowfunction页面展示时回调函数
onHidefunction页面隐藏时回调函数

调用示例

const result = await mtl.registerLifeCycle({ onShow: /* function */, onHide: /* function */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/暗黑模式

mtl.appearanceMode 可用

用于获取手机当前UI模式（正常模式/暗黑模式）。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.appearanceMode()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.appearanceMode()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/暗黑模式

mtl.onAppearanceModeChange 待实现

用于监听系统UI模式的改变。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.onAppearanceModeChange({ callback: function })

参数

参数类型说明
callbackfunctionUI模式变化时的回调函数

调用示例

const result = await mtl.onAppearanceModeChange({ callback: /* function */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/下拉刷新

mtl.onPullDownHandle 待实现

用于注册下拉刷新事件，将callback 函数注册给mtl，当发生下拉时触发。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.onPullDownHandle({ callback: function })

参数

参数类型说明
callbackfunction注册下拉刷新函数

调用示例

const result = await mtl.onPullDownHandle({ callback: /* function */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/下拉刷新

mtl.onPullUpHandle 待实现

用于注册上拉加载事件，将callback 函数注册给mtl，当发生上拉时触发。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.onPullUpHandle({ callback: function })

参数

参数类型说明
callbackfunction注册上拉刷新函数

调用示例

const result = await mtl.onPullUpHandle({ callback: /* function */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/下拉刷新

mtl.stopPullDownHandle 待实现

用于停止顶部下拉事件。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.stopPullDownHandle()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.stopPullDownHandle()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/下拉刷新

mtl.stopPullUpHandle 待实现

用于停止顶部上拉事件。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.stopPullUpHandle()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.stopPullUpHandle()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/屏幕旋转

mtl.changeScreenOrientation 不支持

用于友空间内强制横竖屏。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.changeScreenOrientation({ orientation: boolean })

参数

参数类型说明
orientationboolean横屏 false, 竖屏 true

调用示例

const result = await mtl.changeScreenOrientation({ orientation: /* boolean */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/屏幕旋转

mtl.restoreScreenOrientation 不支持

用于友空间内恢复默认横竖屏。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.restoreScreenOrientation()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.restoreScreenOrientation()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/选择器

mtl.showCityPicker 待实现

用于展示城市选择组件。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.showCityPicker({ province?: string })

参数

参数类型说明
province?string默认选择省份（严格按照国家命名传入）（友空间必传）

调用示例

const result = await mtl.showCityPicker({ province: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/选择器

mtl.showDateTimePicker 待实现

用于展示日期选择组件。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.showDateTimePicker({ format?: string; currentDate?: string })

参数

参数类型说明
format?string返回的日期格式 1. yyyy-MM-dd 2. HH:mm 3. yyyy-MM-dd HH:mm 4.yyyy-MM 5.yyyy
currentDate?string控件默认选择的日期时间(格式yyyy-MM-dd)

调用示例

const result = await mtl.showDateTimePicker({ format: /* string */, currentDate: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/交互

mtl.showAlert 可用

用于展示警告框。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.showAlert()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.showAlert()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/交互

mtl.showMaintenanceWindow 可用

用于展示上线维护中的弹窗。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.showMaintenanceWindow()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.showMaintenanceWindow()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/交互

mtl.showToast 可用

用于展示信息提示框。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.showToast({ content: string; duration?: number })

参数

参数类型说明
contentstring需要显示的文本内容
duration?number显示时长

调用示例

const result = await mtl.showToast({ content: /* string */, duration: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/webview

mtl.configureWebView 待实现

用于webView配置。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.configureWebView({ pullDownRefresh?: boolean; pullUpRefresh?: boolean; scrollViewBounces?: boolean })

参数

参数类型说明
pullDownRefresh?boolean是否开启下拉刷新
pullUpRefresh?boolean是否开启上拉刷新
scrollViewBounces?boolean是否允许WebView弹簧效果，true允许，false不允许，如果设置了上拉或下拉，则强制允许（友空间iOS特有，友空间7.0.5及以上版本）

调用示例

const result = await mtl.configureWebView({ pullDownRefresh: /* boolean */, pullUpRefresh: /* boolean */, scrollViewBounces: /* boolean */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/webview

mtl.webviewLoadUrl 待实现

用于当前页面打开url。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.webviewLoadUrl({ url: sting; reload?: boolean; newWindow?: boolean })

参数

参数类型说明
urlsting接口请求域名
reload?boolean是否新开窗口（友空间、私有版支持）
newWindow?boolean是否新开窗口（飞书、钉钉支持）

调用示例

const result = await mtl.webviewLoadUrl({ url: /* sting */, reload: /* boolean */, newWindow: /* boolean */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/公告

mtl.announceDetail 待实现

用于打开公告详情。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.announceDetail({ qz_id: string; announce_id?: string })

参数

参数类型说明
qz_idstring圈子ID
announce_id?string公告ID

调用示例

const result = await mtl.announceDetail({ qz_id: /* string */, announce_id: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/公告

mtl.openAnnounceReply 待实现

用于获取公告评论列表。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.openAnnounceReply({ feedId?: string; replyNum?: number })

参数

参数类型说明
feedId?string评论ID
replyNum?number评论数

调用示例

const result = await mtl.openAnnounceReply({ feedId: /* string */, replyNum: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/公告

mtl.writeAnnounceReply 待实现

用于给公告写评论。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.writeAnnounceReply({ feedId?: string; replyNum?: number })

参数

参数类型说明
feedId?string评论ID
replyNum?number评论数

调用示例

const result = await mtl.writeAnnounceReply({ feedId: /* string */, replyNum: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/卡包

mtl.getWechatBill 不支持

用于跳转微信卡包。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.getWechatBill()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.getWechatBill()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/云闹钟

mtl.checkCloudAlarm 待实现

用于查询云闹钟开关状态。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.checkCloudAlarm({ id: string })

参数

参数类型说明
idstring事件id

调用示例

const result = await mtl.checkCloudAlarm({ id: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/云闹钟

mtl.operateCloudAlarm 待实现

用于开关云闹铃。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.operateCloudAlarm({ member_id: string; qz_id?: number; operate_type: number; id: string; remind_time?: string; title?: string; start_time?: string; end_time?: string; from?: number; remind_mode?: number })

参数

参数类型说明
member_idstring人员id
qz_id?number空间id
operate_typenumber开关，1开启，0关闭 (开闹钟必须传)
idstring事件id
remind_time?string提醒时间（10位）(开闹钟必须传)
title?string事件名称 (开闹钟必须传)
start_time?string事件名称 事件开始时间（10位）
end_time?string事件结束时间（10位）
from?number事件来源（0考勤，1日程，2会议）(开闹钟必须传)
remind_mode?number提醒模式（0只提醒一次，暂时不需要）

调用示例

const result = await mtl.operateCloudAlarm({ member_id: /* string */, qz_id: /* number */, operate_type: /* number */, id: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/配置

mtl.configMoreMenuArray 待实现

用于更多菜单配置。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.configMoreMenuArray({ menuArray?: object [] })

参数

参数类型说明
menuArray?object []更多按钮信息

调用示例

const result = await mtl.configMoreMenuArray({ menuArray: /* object [] */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/配置

mtl.getMultiDataCenterConfig 待实现

用于获取多数据中心服务配置，包括集中部署、多数据中心部署的服务的域名、服务编码。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.getMultiDataCenterConfig({ type?: number })

参数

参数类型说明
type?number要获取的配置的类型，可选值见下表

调用示例

const result = await mtl.getMultiDataCenterConfig({ type: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/配置

mtl.jumpToSystemSetting 待实现

用于跳转系统设置。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.jumpToSystemSetting()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.jumpToSystemSetting()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/通讯录

mtl.chooseDepartment 待实现

用于选择部门，返回部门基础信息。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.chooseDepartment({ multiple?: bool; selectedList?: object []; maxCount?: number; selectedCount?: number; deptType?: number })

参数

参数类型说明
multiple?bool是否多选。true：多选；false：单选
selectedList?object []已选部门数组
maxCount?number最大选择组织数
selectedCount?number已选择组织数
deptType?number部门类型。0：所有；1：部门；2：组织

调用示例

const result = await mtl.chooseDepartment({ multiple: /* bool */, selectedList: /* object [] */, maxCount: /* number */, selectedCount: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/通讯录

mtl.chooseGroupContacts 待实现

用于群内选择联系人。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.chooseGroupContacts({ multiple?: boolean; qzId: string; groupId: string; maxCount?: number; navTitle?: string })

参数

参数类型说明
multiple?boolean是否多选
qzIdstring需要选择的空间id
groupIdstring群id
maxCount?number最大选择人数, 多选时用
navTitle?string导航标题

调用示例

const result = await mtl.chooseGroupContacts({ multiple: /* boolean */, qzId: /* string */, groupId: /* string */, maxCount: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/通讯录

mtl.chooseInsideGroup 可用

用于选择内部群，返回内部群信息。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.chooseInsideGroup({ multiple?: boolean; selectedList?: object []; groupType?: number })

参数

参数类型说明
multiple?boolean是否多选。true：多选 false：单选
selectedList?object []已选内部群数组
groupType?number内部群类型。0：已加入的内部群 1：所有内部群 2：未加入的内部群

调用示例

const result = await mtl.chooseInsideGroup({ multiple: /* boolean */, selectedList: /* object [] */, groupType: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/通讯录

mtl.viewUserInfo 可用

用于打开人员详情界面。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.viewUserInfo({ memberId: string })

参数

参数类型说明
memberIdstring人员id

调用示例

const result = await mtl.viewUserInfo({ memberId: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/埋点

mtl.collectionData 可用

用于数据埋点。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.collectionData({ appId: string; action: string; detailId: string })

参数

参数类型说明
appIdstring应用ID
actionstring埋点事件
detailIdstring详情ID

调用示例

const result = await mtl.collectionData({ appId: /* string */, action: /* string */, detailId: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/人脸

mtl.faceCompare 不支持

用于提供当前采集的面部信息与人脸库内的面部信息进行比对，返回匹配的用户id和分数以及微笑值。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.faceCompare({ spaceId?: string; faceGroupId?: string; needSmile?: boolean })

参数

参数类型说明
spaceId?string空间id
faceGroupId?string存放人脸信息的库id
needSmile?boolean是否需要返回微笑分数

调用示例

const result = await mtl.faceCompare({ spaceId: /* string */, faceGroupId: /* string */, needSmile: /* boolean */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/人脸

mtl.faceRegister 不支持

用于采集当前面部信息并与当前登录用户绑定。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.faceRegister({ spaceId?: string; faceGroupId?: string })

参数

参数类型说明
spaceId?string空间id
faceGroupId?string存放人脸信息的库id

调用示例

const result = await mtl.faceRegister({ spaceId: /* string */, faceGroupId: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/人脸

mtl.faceVerify 不支持

用于提供当前采集到的人脸信息与当前账号录入的人脸信息进行识别，返回对比分数以及微笑值。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.faceVerify({ spaceId?: string; faceGroupId?: string; needSmile?: boolean })

参数

参数类型说明
spaceId?string空间id
faceGroupId?string存放人脸信息的库id
needSmile?boolean是否需要返回微笑分数

调用示例

const result = await mtl.faceVerify({ spaceId: /* string */, faceGroupId: /* string */, needSmile: /* boolean */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/人脸

mtl.smileDetect 不支持

用于提供检测目标微笑值的功能。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.smileDetect({ spaceId?: string })

参数

参数类型说明
spaceId?string空间id

调用示例

const result = await mtl.smileDetect({ spaceId: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/IM

mtl.openChatByGroupId 可用

用于直接发起和特定群组的会话。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.openChatByGroupId({ groupId: string })

参数

参数类型说明
groupIdstring群ID

调用示例

const result = await mtl.openChatByGroupId({ groupId: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/IM

mtl.openChatByUserId 可用

用于直接发起和特定人员的单聊会话。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.openChatByUserId({ userType?: number; userId: string })

参数

参数类型说明
userType?number对方用户id的使用类型，0-使用友空间用户id；1-使用友互通用户id
userIdstring对方用户的唯一标示

调用示例

const result = await mtl.openChatByUserId({ userType: /* number */, userId: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/IM

mtl.openChatWindow 可用

用于直接发起和特定人员的单聊会话。

查看友空间原文
当前状态

已接入 WorkFly 宿主能力，可用于迁移与新代码。

调用签名

await mtl.openChatWindow({ userType?: number; userId: string })

参数

参数类型说明
userType?number对方用户id的使用类型，0-使用友空间用户id；1-使用友互通用户id
userIdstring对方用户的唯一标示

调用示例

const result = await mtl.openChatWindow({ userType: /* number */, userId: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/IM

mtl.sendImageMessages 待实现

用于向指定的个人或者群组发送图片消息。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.sendImageMessages({ userType?: number; chatId: string; chatType: string; filePaths: string [] })

参数

参数类型说明
userType?number对方用户id的使用类型。0-使用友空间用户id；1-使用友互通用户id。此字段仅作用于单聊
chatIdstring对方的唯一标示
chatTypestring对方的类型。chat：单聊；groupchat：群聊
filePathsstring []发送图片的本地地址集合

调用示例

const result = await mtl.sendImageMessages({ userType: /* number */, chatId: /* string */, chatType: /* string */, filePaths: /* string [] */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/IM

mtl.sendTodoReceipt 待实现

用于发送待办处理回执。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.sendTodoReceipt()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.sendTodoReceipt()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/直播

mtl.openLiveFlow 不支持

用于调用直播界面。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.openLiveFlow({ pushurl: string; screenOrientation?: bool; videoResolution?: number })

参数

参数类型说明
pushurlstring推流URL
screenOrientation?bool默认竖屏, 是否需要横屏, true不需要, false需要
videoResolution?number0 320p, 1 640p, 2 865p, 3 1280p (默认))

调用示例

const result = await mtl.openLiveFlow({ pushurl: /* string */, screenOrientation: /* bool */, videoResolution: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/地图

mtl.chooseMap 待实现

用于选取附近或者目标地区的兴趣点。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.chooseMap({ searchRadius?: number; latitude?: string; longitude?: string })

参数

参数类型说明
searchRadius?number查询半径（单位：米），小于0时不限制
latitude?string目标地区纬度
longitude?string目标地区经度

调用示例

const result = await mtl.chooseMap({ searchRadius: /* number */, latitude: /* string */, longitude: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/微邮

mtl.sendMiniMail 待实现

用于打开发送微邮界面。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.sendMiniMail({ users: object []; spaceId?: string })

参数

参数类型说明
usersobject []收件人列表
spaceId?string空间id

调用示例

const result = await mtl.sendMiniMail({ users: /* object [] */, spaceId: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/支付

mtl.yonyouPay 不支持

用于用友支付，目前只支持通过微信付款给用友网络。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.yonyouPay({ type?: number; orderNo: string; totalAmount: number; orderDesc?: string; callback?: string })

参数

参数类型说明
type?number支付类型，见下表
orderNostring订单号
totalAmountnumber订单金额，必须大于0
orderDesc?string订单说明
callback?string支付结果回调，需要在页面中注册

调用示例

const result = await mtl.yonyouPay({ type: /* number */, orderNo: /* string */, totalAmount: /* number */, orderDesc: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/支付

mtl.yonyouPayQuery 不支持

用于查询用友支付结果，目前只支持通过微信（包括微信H5、微信公众号两种支付通道）支付的款项查询。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.yonyouPayQuery({ orderNo: string })

参数

参数类型说明
orderNostring订单号

调用示例

const result = await mtl.yonyouPayQuery({ orderNo: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/隐私

mtl.afterPrivacyAgreement 待实现

用于记录用户已同意隐私政策。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.afterPrivacyAgreement()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.afterPrivacyAgreement()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/日程

mtl.createNewSchedule 待实现

用于提供新建日程功能，调用时端上会打开新建日程页面，用户可以在此完善日程信息，并新建日程。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.createNewSchedule()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.createNewSchedule()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/日程

mtl.getSchedulesFromMobile 待实现

用于提供时间区间，如果用户开启了同步手机日程的开关，返回该时间区间内的手机日程列表，否则返回空。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.getSchedulesFromMobile({ startTime: long; endTime: long })

参数

参数类型说明
startTimelong开始时间戳
endTimelong结束时间戳

调用示例

const result = await mtl.getSchedulesFromMobile({ startTime: /* long */, endTime: /* long */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/日程

mtl.openScheduleDetail 待实现

用于根据传入的日程id以及用户id打开日程查看详情界面。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.openScheduleDetail({ scheduleId: string; currentDay?: string; memberId?: string })

参数

参数类型说明
scheduleIdstring日程id
currentDay?string日程当前时间(20201112)
memberId?string用户id(从哪个人进入的，从共享人进入，就是共享人的id)

调用示例

const result = await mtl.openScheduleDetail({ scheduleId: /* string */, currentDay: /* string */, memberId: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/日程

mtl.viewScheduleDetail 待实现

用于提供一个日程详情页面，根据传入的日程id以及用户id，展示出指定日程的详细信息。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.viewScheduleDetail({ scheduleId: string; subId?: string; memberId?: string })

参数

参数类型说明
scheduleIdstring日程id
subId?string日程子Id。只有重复日程存在子Id
memberId?string用户ID

调用示例

const result = await mtl.viewScheduleDetail({ scheduleId: /* string */, subId: /* string */, memberId: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/日程

mtl.viewScheduleList 待实现

用于传入指定日期，展示指定日期的日程列表界面（展示界面包括月视图）。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.viewScheduleList({ time?: number; memberId?: string })

参数

参数类型说明
time?number指定日期时间戳（10位）
memberId?string人员id

调用示例

const result = await mtl.viewScheduleList({ time: /* number */, memberId: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/分享

mtl.shareApplet 不支持

用于分享小程序到im或动态。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.shareApplet({ type: number; params?: string; customTitle: string; customSubTitle: string; customShowImgUrl: string })

参数

参数类型说明
typenumber0-转发到im，1-分享到动态
params?string共享的自定义参数值
customTitlestring自定义标题
customSubTitlestring自定义副标题
customShowImgUrlstring自定义图标远程地址

调用示例

const result = await mtl.shareApplet({ type: /* number */, params: /* string */, customTitle: /* string */, customSubTitle: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/换肤

mtl.configSkinAndTabbar 不支持

用于移动端换肤功能：保存换肤数据到本地，用与显示用户的换肤数据。

查看友空间原文
当前状态

桌面宿主不提供对应能力；迁移时需要改写交互或移除调用。

调用签名

await mtl.configSkinAndTabbar({ skinData: string; tabbarData?: string; currentQzId: string })

参数

参数类型说明
skinDatastring换肤主题色数据,json字符串,用于取主题色
tabbarData?string换肤下导航数据,json字符串,用于下导航显示
currentQzIdstring需要更换主题租户的空间id

调用示例

const result = await mtl.configSkinAndTabbar({ skinData: /* string */, tabbarData: /* string */, currentQzId: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/水印

mtl.getWatermarkInfo 待实现

用于获取空间水印信息。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.getWatermarkInfo({ qzId: string })

参数

参数类型说明
qzIdstring圈子ID

调用示例

const result = await mtl.getWatermarkInfo({ qzId: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/工作圈

mtl.commonReplyComponent 待实现

用于通用的评论组件，支持文字，图片，语音，视频，附件。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.commonReplyComponent({ replyName?: string; memberArray?: object []; qzId?: string })

参数

参数类型说明
replyName?string被回复对象的名字
memberArray?object []限定人员范围
qzId?string空间 id

调用示例

const result = await mtl.commonReplyComponent({ replyName: /* string */, memberArray: /* object [] */, qzId: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/工作圈

mtl.createFeedComponent 待实现

用于新建发言。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.createFeedComponent({ groupId?: string; groupName?: string })

参数

参数类型说明
groupId?string开放权限(是否能看到这条发言)的团队id
groupName?string开放权限的团队id的名字

调用示例

const result = await mtl.createFeedComponent({ groupId: /* string */, groupName: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/工作台

mtl.appletFromQzId 待实现

用于获取小程序来源圈子ID。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.appletFromQzId()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.appletFromQzId()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/工作台

mtl.configAppletMenu 待实现

用于配置小程序的菜单。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.configAppletMenu({ hideShare?: number; hideForward?: number })

参数

参数类型说明
hideShare?number隐藏分享按钮
hideForward?number隐藏转发按钮

调用示例

const result = await mtl.configAppletMenu({ hideShare: /* number */, hideForward: /* number */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/工作台

mtl.getAppData 待实现

用于查询单个应用信息(只返回当前空间)。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.getAppData({ appId: string; url?: string; serviceCode?: string })

参数

参数类型说明
appIdstringappid（友空间使用）
url?string获取轻应用接口地址（除友空间外其他平台使用）
serviceCode?string应用编码（除友空间外其他平台使用）

调用示例

const result = await mtl.getAppData({ appId: /* string */, url: /* string */, serviceCode: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/工作台

mtl.getAppletCapsuleParams 待实现

用于获取小程序胶囊占屏幕宽度比例值。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.getAppletCapsuleParams()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.getAppletCapsuleParams()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/工作台

mtl.getGzipAppData 待实现

用于获取gzip app数据。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.getGzipAppData({ key: string })

参数

参数类型说明
keystringgzip存数据的键

调用示例

const result = await mtl.getGzipAppData({ key: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/工作台

mtl.getHhtQrCodeInfo 待实现

用于获取红火台缓存信息。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.getHhtQrCodeInfo()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.getHhtQrCodeInfo()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/工作台

mtl.getOAuthCode 待实现

用于获取免登授权码，实现单点登录。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.getOAuthCode({ tenantId: string })

参数

参数类型说明
tenantIdstring租户ID

调用示例

const result = await mtl.getOAuthCode({ tenantId: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/工作台

mtl.getOffLineOutSignPhoto 待实现

用于拍照上传服务器或者返回base64信息（上传成功返回图片url，上传失败返回图片的base64信息）。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.getOffLineOutSignPhoto({ tenantId?: string; watermark_type?: number; watermark?: object })

参数

参数类型说明
tenantId?string租户ID，可跨租户上传(友空间6.5.0及以上版本)
watermark_type?number1考勤签到；0 不添加水印
watermark?object水印数据对象与type匹配

调用示例

const result = await mtl.getOffLineOutSignPhoto({ tenantId: /* string */, watermark_type: /* number */, watermark: /* object */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/工作台

mtl.openAppSetting 待实现

用于打开混合云常用应用页面。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.openAppSetting()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.openAppSetting()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/工作台

mtl.openCustomSetting 待实现

用于打开多维门户自定义设置。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.openCustomSetting()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.openCustomSetting()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/工作台

mtl.openPluginWithParams 待实现

用于打开插件。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.openPluginWithParams({ plugin_id: string })

参数

参数类型说明
plugin_idstring插件id

调用示例

const result = await mtl.openPluginWithParams({ plugin_id: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/工作台

mtl.openSearchAppList 待实现

用于打开应用搜索列表。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.openSearchAppList()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.openSearchAppList()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/工作台

mtl.openSignViewWithParams 待实现

用于打开专属化考勤应用。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.openSignViewWithParams({ domainUrl: string; cookieKey: string; cookieDomain: string })

参数

参数类型说明
domainUrlstring域名
cookieKeystringcookie的key
cookieDomainstringcookie的域名

调用示例

const result = await mtl.openSignViewWithParams({ domainUrl: /* string */, cookieKey: /* string */, cookieDomain: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/工作台

mtl.reloadWorkbenchPath 待实现

用于通知客户端加载最新资源包。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.reloadWorkbenchPath()

参数

无业务参数，或只接受可选回调对象。

调用示例

const result = await mtl.reloadWorkbenchPath()

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。

MTL/工作台

mtl.setAppletCapsuleStyle 待实现

用于设置小程序胶囊样式。

查看友空间原文
当前状态

接口已进入兼容目录，但当前版本尚未实现；不要把它作为可用能力发布。

调用签名

await mtl.setAppletCapsuleStyle({ capsuleStyle: number; customCapsuleBgColor?: string; customCapsuleBgAlpha?: number; customCapsuleImgColor?: string; customCapsuleBorderColor?: string; isShowCapsule?: boolean })

参数

参数类型说明
capsuleStylenumber胶囊样式，0浅色 1深色 2自定义颜色
customCapsuleBgColor?string自定义胶囊背景色值 例:#00ff00
customCapsuleBgAlpha?number自定义胶囊背景透明度 0-1，默认0-完全透明
customCapsuleImgColor?string自定义胶囊图片色值 例:#00ff00
customCapsuleBorderColor?string自定义胶囊边框色值 例:#00ff00
isShowCapsule?booleantrue:显示胶囊 false隐藏胶囊

调用示例

const result = await mtl.setAppletCapsuleStyle({ capsuleStyle: /* number */, customCapsuleBgColor: /* string */, customCapsuleBgAlpha: /* number */, customCapsuleImgColor: /* string */ })

示例只展示调用形态，业务值与返回字段以友空间原文和当前 WorkFly 实现为准。