EndAction

指定长时间操作的结束操作。

备注

GroupActions 仅适用于 ONLYOFFICE Docs Enterprise 和 ONLYOFFICE Docs Developer。

语法

expression.EndAction(type, description, status);

expression - 表示 Api 类的变量。

参数

名称	必需/可选	数据类型	默认值	描述
type	必需	"Information" | "Block" | "GroupActions"		操作类型："Information" - 结束非阻塞信息操作，"Block" - 结束阻塞交互操作，"GroupActions" - 结束通过 StartAction("GroupActions") 启动的分组操作。
description	可选	string | Object		对于 "Information" 和 "Block" 类型：在操作期间显示的字符串描述。对于 "GroupActions" 类型：具有以下属性的可选对象：
description.scrollToTarget	可选	boolean	true	如果为 false，组操作结束后编辑器将不会滚动到目标位置。
description.cancel	可选	boolean	false	如果为 true，组操作将被取消并回滚，而不是提交。
status	可选	string		对于 "Information" 和 "Block" 类型：错误状态码。如果未发生错误，则传递空字符串。

返回值

此方法不返回任何数据。

示例

window.Asc.plugin.executeMethod ("EndAction", ["Block", "Save to local storage...", ""]);