mirror of
https://github.com/danielsogl/awesome-cordova-plugins.git
synced 2026-05-02 00:07:23 +08:00
Daniel Sogl
100 lines
4.0 KiB
TypeScript
100 lines
4.0 KiB
TypeScript
import { Injectable } from '@angular/core';
|
|
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
|
|
|
|
export interface PreviewAnyFileOptions {
|
|
/**
|
|
* The name of the file to preview.
|
|
*/
|
|
name?: string;
|
|
/**
|
|
* The mime type of the file to preview.
|
|
*/
|
|
mimeType: string;
|
|
}
|
|
|
|
/**
|
|
* @name PreviewAnyFile
|
|
* @description
|
|
* Whatever the file is PDF document, Word document, Excel, office document,zip archive file, image, text, html or anything else, you can perform a preview by this cordova Plugin to preview any file in native mode by providing the local or external URL.
|
|
*
|
|
* Requires Cordova plugin: `cordova-plugin-preview-any-file`. For more info, please see the [previewAnyFile plugin docs](https://github.com/mostafa-mansour1/previewAnyFile).
|
|
*
|
|
* @usage
|
|
* ```typescript
|
|
* import { PreviewAnyFile } from '@ionic-native/preview-any-file/ngx';
|
|
*
|
|
*
|
|
* constructor(private previewAnyFile: PreviewAnyFile) { }
|
|
*
|
|
* ...
|
|
*
|
|
*
|
|
* this.previewAnyFile.preview('file://filepath.ext')
|
|
* .then((res: any) => console.log(res))
|
|
* .catch((error: any) => console.error(error));
|
|
*
|
|
* ```
|
|
*
|
|
*
|
|
* ...
|
|
*
|
|
*
|
|
* this.previewAnyFile.previewPath('http://www.domain.com/samplefile')
|
|
* .then((res: any) => console.log(res))
|
|
* .catch((error: any) => console.error(error));
|
|
*
|
|
* ```
|
|
*/
|
|
|
|
@Plugin({
|
|
pluginName: 'PreviewAnyFile',
|
|
plugin: 'cordova-plugin-preview-any-file', // npm package name, example: cordova-plugin-camera
|
|
pluginRef: 'PreviewAnyFile', // the variable reference to call the plugin, example: navigator.geolocation
|
|
repo: 'https://github.com/mostafa-mansour1/previewAnyFile', // the github repository URL for the plugin
|
|
install: '', // OPTIONAL install command, in case the plugin requires variables
|
|
installVariables: [], // OPTIONAL the plugin requires variables
|
|
platforms: ['Android', 'iOS'], // Array of platforms supported, example: ['Android', 'iOS']
|
|
})
|
|
@Injectable()
|
|
export class PreviewAnyFile extends IonicNativePlugin {
|
|
/**
|
|
* this function return SUCCESS in success callback if the file successfully opened, if the content is base64 you have to write it into file by cordova-plugin-file
|
|
* @param url {string} full absolute URL for the file, if the path is content:// you need to resolve the native url, if the path is https:// it may not work in android
|
|
* @return {Promise<any>} Returns a promise that resolves if the file opened reject if not;
|
|
*/
|
|
@Cordova()
|
|
preview(url: string): Promise<string> {
|
|
return;
|
|
}
|
|
|
|
/**
|
|
* previewPath function will return success callback if the file successfully opened, if the content is base64 you have to use previewBase64 method
|
|
* @param base64 {String} base64 string content
|
|
* @param options {PreviewAnyFileOptions} define the name of the file with extension or it's mimeType, if the correct extension not exist in the path
|
|
*/
|
|
@Cordova()
|
|
previewBase64(base64: string, options?: PreviewAnyFileOptions): Promise<string> {
|
|
return;
|
|
}
|
|
|
|
/**
|
|
* previewPath function will return success callback if the file successfully opened, if the content is base64 you have to use previewBase64 method
|
|
* @param url {String} full absolute URL -> file://, content://, http://, https, ... etc, if extension not exist, you must define it in the opt param
|
|
* @param options {PreviewAnyFileOptions} define the name of the file with extension or it's mimeType, if the correct extension not exist in the path
|
|
*/
|
|
@Cordova()
|
|
previewPath(url: string, options?: PreviewAnyFileOptions): Promise<string> {
|
|
return;
|
|
}
|
|
|
|
/**
|
|
* previewPath function will return success callback if the file successfully opened, if the content is base64 you have to use previewBase64 method
|
|
* @param url {String} full absolute URL -> file://, content://, http://, https, ... etc, if extension not exist, you must define it in the opt param
|
|
* @param options {PreviewAnyFileOptions} define the name of the file with extension or it's mimeType, if the correct extension not exist in the path
|
|
*/
|
|
@Cordova()
|
|
previewAsset(url: string, options?: PreviewAnyFileOptions): Promise<string> {
|
|
return;
|
|
}
|
|
}
|