@capacitor/file-viewer

FileViewer API 提供了打开文件和预览媒体的功能。该功能在 Web 平台上不可用。

媒体预览功能目前仅支持 iOS 平台，使用系统内置的播放器实现。

安装

npm install @capacitor/file-viewer
npx cap sync

示例

import { FileViewer } from '@capacitor/file-viewer';

// 可以使用如 @capacitor/filesystem 这样的插件获取文件的完整路径
const openDocument = async () => {
  await FileViewer.openDocumentFromLocalPath({
    path: 'path/to/file.pdf',
  });
};

// iOS 特有功能
const previewMedia = async () => {
  await FileViewer.previewMediaContentFromUrl({
    path: 'https://url_hosting_media/file.mp4',
  });
};

API

• openDocumentFromLocalPath(...)
• openDocumentFromResources(...)
• openDocumentFromUrl(...)
• previewMediaContentFromLocalPath(...)
• previewMediaContentFromResources(...)
• previewMediaContentFromUrl(...)
• 接口
• 类型别名

现有错误代码列表，请参见错误处理。

文件查看器 API

仅适用于原生 Android 和 iOS 平台；不适用于 Web/PWA。

openDocumentFromLocalPath(...)

openDocumentFromLocalPath(options: OpenFromLocalPathOptions) => Promise<void>

打开本地文件系统中存储的文件

参数	类型
options	OpenFromLocalPathOptions

Since: 1.0.0

---

openDocumentFromResources(...)

openDocumentFromResources(options: OpenFromResourcesOptions) => Promise<void>

打开应用资源文件

参数	类型
options	OpenFromResourcesOptions

Since: 1.0.0

---

openDocumentFromUrl(...)

openDocumentFromUrl(options: OpenFromUrlOptions) => Promise<void>

从远程 URL 打开文件

参数	类型
options	OpenFromUrlOptions

Since: 1.0.0

---

previewMediaContentFromLocalPath(...)

previewMediaContentFromLocalPath(options: PreviewMediaFromLocalPathOptions) => Promise<void>

预览本地文件系统中存储的媒体文件（主要是视频）。 仅在 iOS 平台实现。Android 平台默认使用 openDocumentFromLocalPath。

参数	类型
options	OpenFromLocalPathOptions

Since: 1.0.0

---

previewMediaContentFromResources(...)

previewMediaContentFromResources(options: PreviewMediaFromResourcesOptions) => Promise<void>

预览应用资源中的媒体文件（主要是视频）。 仅在 iOS 平台实现。Android 平台默认使用 openDocumentFromResources。

参数	类型
options	OpenFromResourcesOptions

Since: 1.0.0

---

previewMediaContentFromUrl(...)

previewMediaContentFromUrl(options: PreviewMediaFromUrlOptions) => Promise<void>

从远程 URL 预览媒体文件（主要是视频）。 仅在 iOS 平台实现。Android 平台默认使用 openDocumentFromUrl。

参数	类型
options	OpenFromUrlOptions

Since: 1.0.0

---

Interfaces

OpenFromLocalPathOptions

属性	类型	描述	Since
path	string	要打开的文件的完整绝对路径	1.0.0

OpenFromResourcesOptions

属性	类型	描述	Since
path	string	要打开的资源文件的相对路径	1.0.0

OpenFromUrlOptions

属性	类型	描述	Since
url	string	指向要打开的文件的远程 URL	1.0.0

Type Aliases

PreviewMediaFromLocalPathOptions

  OpenFromLocalPathOptions

PreviewMediaFromResourcesOptions

  OpenFromResourcesOptions

PreviewMediaFromUrlOptions

  OpenFromUrlOptions

错误处理

插件在原生 Android 和 iOS 平台上会返回以下特定代码的错误：

错误代码	平台	错误信息
OS-PLUG-FLVW-0004	Android, iOS	您尝试打开的文件不存在。
OS-PLUG-FLVW-0005	Android, iOS	您尝试打开的 URL 格式不正确。
OS-PLUG-FLVW-0006	Android, iOS	要打开的文件路径为空或未提供。
OS-PLUG-FLVW-0007	Android, iOS	要打开的 URL 为空或未提供。
OS-PLUG-FLVW-0008	Android, iOS	无法打开文件。
OS-PLUG-FLVW-0009	Android, iOS	参数无效。
OS-PLUG-FLVW-0010	Android	没有可用来打开此文件的应用程序。
OS-PLUG-FLVW-0011	iOS	Cordova/Capacitor 桥接未初始化。
OS-PLUG-FLVW-0012	iOS	下载失败。
OS-PLUG-FLVW-0013	iOS	文件没有扩展名。