File.openPDFViewer

函数式 API openPDFViewer也可以通过它使用相同的功能。

功能说明

使用原生 PDF 查看器打开经过 Base64 编码的 PDF 数据。当用户关闭查看器时 'CLOSE'则返回。

Toss App Android/iOS 5.261.0 可在以上版本中使用。调用前 File.openPDFViewer.isSupported()可通过它确认是否支持。若在不支持的版本中调用， UNSUPPORTED_APP_VERSION 会发生错误。

类型

File.openPDFViewer(params: OpenPDFViewerParams): Promise<OpenPDFViewerResult>;

Params

type OpenPDFViewerParams = {
  data: string;
  filename?: string;
};

Response

type OpenPDFViewerResult = "CLOSE";

错误代码

错误代码是 catch 到的错误的 error.code 值。

代码	说明
UNSUPPORTED_APP_VERSION	如果当前运行的 Toss App 版本不支持此功能，调用后会立即发生。 File.openPDFViewer.isSupported()可通过它提前确认，发生时 error.message请向用户显示（更新提示文案）。
INVALID_REQUEST	请求参数不正确的情况。
INVALID_DATA	当 PDF 数据无效时。
PDF_VIEWER_ERROR	在打开 PDF 查看器的过程中发生错误时。

示例代码

import { File } from "@apps-in-toss/web-framework";

async function handleOpenPdf() {
  if (!File.openPDFViewer.isSupported()) {
    console.log("当前 Toss 应用版本中无法使用 PDF 查看器。");
    return;
  }

  try {
    const result = await File.openPDFViewer({
      data: "JVBERi0xLjQK...",
      filename: "document.pdf",
    });

    if (result === "CLOSE") {
      console.log("PDF 查看器已关闭。");
    }
  } catch (error) {
    console.error("PDF 查看器错误:", error);
  }
}

document.querySelector("#open-pdf").addEventListener("click", handleOpenPdf);