PDF 查看器

打开 PDF 查看器

SDK 函数： openPDFViewer

openPDFViewer是将以 Base64 编码的 PDF 数据在原生 PDF 查看器中打开的函数。用户关闭 PDF 查看器时 'CLOSE'会返回。

签名

function openPDFViewer(params: OpenPDFViewerParams): Promise<OpenPDFViewerResult>;

参数

• params必填

  是包含 PDF 数据和文件名的对象。详细类型请参考下面的 OpenPDFViewerParams。

返回值

• Promise<OpenPDFViewerResult>

  PDF 查看器关闭时 'CLOSE'会返回。

错误

错误代码	发生条件
INVALID_REQUEST	当请求参数不正确时
INVALID_DATA	当 PDF 数据无效时
PDF_VIEWER_ERROR	在打开 PDF 查看器的过程中发生错误时
UNSUPPORTED_APP_VERSION	当 Toss App 版本低于 5.261.0 时

示例

React

import { openPDFViewer } from '@apps-in-toss/web-framework';

async function showPdf() {
  try {
    const result = await openPDFViewer({
      data: 'JVBERi0xLjQK...',
      filename: 'document.pdf',
    });

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

React Native

import { openPDFViewer } from '@apps-in-toss/framework';

async function showPdf() {
  try {
    const result = await openPDFViewer({
      data: 'JVBERi0xLjQK...',
      filename: 'document.pdf',
    });

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

类型 · 对象

PDF 查看器参数 (OpenPDFViewerParams)

openPDFViewer 是传递给函数的参数类型。

签名

interface OpenPDFViewerParams {
  data: string;
  filename?: string;
}

属性

• datastring必填

  是以 Base64 格式编码的 PDF 数据字符串。
• filenamestring

  是 PDF 文件名。

PDF 查看器结果 (OpenPDFViewerResult)

是 PDF 查看器关闭时返回的结果类型。

签名

type OpenPDFViewerResult = 'CLOSE';

值说明

值	说明
'CLOSE'	表示用户关闭了 PDF 查看器。