-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(plugin): add File encryption plugin (#1509)
* feat(plugin): File encryption fix #618 * typo
- Loading branch information
1 parent
3d747d3
commit 46b4e25
Showing
1 changed file
with
52 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core'; | ||
import { Injectable } from '@angular/core'; | ||
|
||
/** | ||
* @name File Encryption | ||
* @description | ||
* Simple file encryption for Cordova. | ||
* | ||
* @usage | ||
* ```typescript | ||
* import { FileEncryption } from '@ionic-native/file-encryption'; | ||
* | ||
* | ||
* constructor(private fileEncryption: FileEncryption) { } | ||
* | ||
* ... | ||
* | ||
* this.fileEncryption.decrypt('assets/json/topSecret.json', 'secretKey'); | ||
* | ||
* this.fileEncryption.encrypt('assets/json/topSecret.json', 'secretKey'); | ||
* | ||
* ``` | ||
*/ | ||
@Plugin({ | ||
pluginName: 'FileEncryption', | ||
plugin: 'cordova-safe', | ||
pluginRef: 'cordova.plugins.disusered', | ||
repo: 'https://github.com/disusered/cordova-safe', | ||
platforms: ['Android', 'iOS'] | ||
}) | ||
@Injectable() | ||
export class FileEncryption extends IonicNativePlugin { | ||
|
||
/** | ||
* Enrcypt a file | ||
* @param file {string} A string representing a local URI | ||
* @param key {string} A key for the crypto operations | ||
* @return {Promise<any>} Returns a promise that resolves when something happens | ||
*/ | ||
@Cordova() | ||
encrypt(file: string, key: string): Promise<any> { return; } | ||
|
||
/** | ||
* Decrypt a file | ||
* @param file {string} A string representing a local URI | ||
* @param key {string} A key for the crypto operations | ||
* @return {Promise<any>} Returns a promise that resolves when something happens | ||
*/ | ||
@Cordova() | ||
decrypt(file: string, key: string): Promise<any> { return; } | ||
|
||
} |