Skip to content

实例对象

实例对象指的是您调用初始化函数后返回的 instance 实例。该实例内封装了一些常用的属性和函数供开发者使用。

属性类型说明
Applicationobject文档实例 API 对象
versionString当前 WebOffice SDK 版本
mainVersionString当前 WebOffice 版本
urlString当前 WebOffice SDK 版本
iframeHTMLElement当前文档实例 iframe 对象
方法说明
ready()加载 Application 对象
destroy()销毁 JSSDK 实例,关闭 WebOffice 文档的显示
setToken()向 WebOffice 内部设置 token 信息
save()主动保存文档

Application

文档实例 API 对象,开发者可通过此对象对文档进行 API 调用,实现更多高级操作,详情请参考API 调用

IMPORTANT

开发者需要先调用 ready() 函数来加载 Application 对象,然后再进行后续的 API 调用。

ready()

此函数用于加载 Application 对象,您需要等待此函数调用完成再来使用 Application 对象。

IMPORTANT

如果您的代码中存在多次 ready 函数调用的情况,请确保上一次的 ready 函数已经 resolve,然后再进行下一次 ready 的调用,否则可能会使文档实例多次被加载,最终出现 API 接口重复调用的情况。

destroy()

当我们不再需要 instance 的时候,可以通过 jssdk.destroy() 方法,来销毁 iframe 对应的 DOM 节点,从而销毁 JSSDK 实例,关闭 WebOffice 页面的展示。

js
async function example() {
  await jssdk.destroy();
}

IMPORTANT

如果仅仅是隐藏挂载节点的 DOM 对象而并没有销毁实例,此时 WebOffice 还是在运行的,只不过视觉上不可见了。

setToken()

js
jssdk.setToken({
  token: "yourToken",
  timeout: 10 * 60 * 1000, // 过期时间,毫秒
});

save()

可以在恰当的时机主动触发保存接口,用来辅助用户保存文件。