Event handling

fileOpen

The callback of the fileOpen event.

Usage

instance.ApiEvent.AddApiEventListener("fileOpen", (data) => {
  console.log("fileOpen: ", data);
});

Success response

{
  duration: 812,
  fileInfo: {
    createTime: 1606461829,
    id: "94749723688",
    modifyTime: 1606461829,
    name: "userName",
    officeType: "s",
  },
  stageTime: 1614,
  success: true,
  time: 1614,
  ts: 1607858260164,
}

Failure response

{
  msg: "Fail",
  result: "Fail"
}

error

The callback of the error event.

Usage

instance.ApiEvent.AddApiEventListener("error", (data) => {
  console.log("error: ", data);
});

Response parameters

{
  reason: "Fail"
}

tabSwitch

The callback of tabSwitch event.

Usage

instance.ApiEvent.AddApiEventListener("tabSwitch", (data) => {
  console.log("tabSwitch: ", data);
});

Response parameters

// Take Excel as an example.
{
  tabKey: "InsertTab",
  tabKey: "StartTab",
  // For more statuses, see the specific tab.
}

fileStatus

This event callback is triggered to save a file.

Usage

instance.ApiEvent.AddApiEventListener("fileStatus", (data) => {
  console.log("fileStatus: ", data);
});

Response parameters

{
  status: 0, // The document is not updated.
  status: 1, // The version is saved. Scenarios: manual save, scheduled save, or closing the web page.
  status: 2, // Saving an empty file is not supported. Scenario: The file is empty after the kernel saves it.
  status: 3, // The storage space is full.
  status: 4, // Do not perform frequent operations during saving. Scenario: The server-side save queue is full and waiting.
  status: 5, // Failed to save.
  status: 6, // The file update is being saved. Scenario: Saving is triggered by modifying the document content.
  status: 7, // Saved successfully. Scenario: The document content modification is saved successfully.
}

previewLimit

The callback of the previewLimit event. The event is triggered when you scroll to the bottom of the limited page.

Usage

instance.ApiEvent.AddApiEventListener("previewLimit", (data) => {
  console.log("previewLimit: ", data);
});

Response parameters

// Word document
// Because Word documents use a flow layout, the exact number of pages cannot be obtained. Therefore, the callback has only the total parameter.
{
  total: 4; // The page limit.
}
// PPT and PDF
{
  total: 4; // The page limit.
  realTotal: 10; // The actual total number of pages.
}

hasDocMap

If the file has a table of contents, a callback is executed.

instance.ApiEvent.AddApiEventListener("hasDocMap", (data) => {
  console.log("hasDocMap: ", data);
});

fullscreenchange

A callback is executed when you enter or exit full screen.

If isBrowserViewFullscreen or isIframeViewFullscreen is configured in commonOptions, this listener has no effect.

Usage

instance.ApiEvent.AddApiEventListener("fullscreenchange", (data) => {
  console.log("fullscreenchange: ", data);
});

Response parameters

{
  status: 0, // Exit full-screen mode.
  status: 1, // Enter full-screen mode.
}

webSocketStatus

Listen to the connection status of the webSocket.

Usage

instance.ApiEvent.AddApiEventListener("webSocketStatus", (data) => {
  console.log("webSocketStatus: ", data);
});

Response parameters

{
  status: '_online', // Connected
  status: '_offline', // Offline
  status: '_close', // Connection closed
}

fileNameChange

The callback of the fileNameChange event. After the file is successfully renamed, the new file name is returned.

Usage

instance.ApiEvent.AddApiEventListener("fileNameChange", (data) => {
  console.log("fileNameChange: ", data);
});

Response parameters

{
  fileName: "NewName"
}

filePasswordStatus

Listen to the password status of encrypted files.

Usage

instance.ApiEvent.AddApiEventListener("filePasswordStatus", (data) => {
  console.log("filePasswordStatus: ", data);
});

Response parameters

{
  status: 'NeedPassword', // A password is required.
  status: 'InvalidPassword', // Incorrect password.
}

ModelVisible

This event is triggered when a modal box is opened or closed. For example, this event is triggered when you choose More > Print.

instance.ApiEvent.AddApiEventListener("ModelVisible", (data) => {
  console.log("ModelVisible: ", data);
});

OnBroadcast

Listen to global broadcasts for multi-user collaboration.

instance.ApiEvent.AddApiEventListener("OnBroadcast", (data) => {
  console.log("OnBroadcast: ", data);
});