awesome-cordova-plugins/src/@ionic-native/plugins/screenshot/index.ts
2017-06-14 01:40:51 -04:00

87 lines
2.2 KiB
TypeScript

import { Injectable } from '@angular/core';
import { Plugin, IonicNativePlugin } from '@ionic-native/core';
declare const navigator: any;
/**
* @name Screenshot
* @description Captures a screen shot
* @usage
* ```typescript
* import { Screenshot } from '@ionic-native/screenshot';
*
* constructor(private screenshot: Screenshot) { }
*
* ...
*
* // Take a screenshot and save to file
* this.screenshot.save('jpg', 80, 'myscreenshot.jpg').then(onSuccess, onError);
*
* // Take a screenshot and get temporary file URI
* this.screenshot.URI(80).then(onSuccess, onError);
* ```
*/
@Plugin({
pluginName: 'Screenshot',
plugin: 'com.darktalker.cordova.screenshot',
pluginRef: 'navigator.screenshot',
repo: 'https://github.com/gitawego/cordova-screenshot',
platforms: ['Android', 'iOS', 'macOS']
})
@Injectable()
export class Screenshot extends IonicNativePlugin {
/**
* Takes screenshot and saves the image
*
* @param format {string} Format can take the value of either 'jpg' or 'png'
* On ios, only 'jpg' format is supported
* @param quality {number} Determines the quality of the screenshot.
* Default quality is set to 100.
* @param filename {string} Name of the file as stored on the storage
* @returns {Promise<any>}
*/
save(format?: string, quality?: number, filename?: string): Promise<any> {
return new Promise<any>(
(resolve, reject) => {
navigator.screenshot.save(
(error: any, result: any) => {
if (error) {
reject(error);
} else {
resolve(result);
}
},
format,
quality,
filename
);
}
);
}
/**
* Takes screenshot and returns the image as an URI
*
* @param quality {number} Determines the quality of the screenshot.
* Default quality is set to 100.
* @returns {Promise<any>}
*/
URI(quality?: number): Promise<any> {
return new Promise<any>(
(resolve, reject) => {
navigator.screenshot.URI(
(error: any, result: any) => {
if (error) {
reject(error);
} else {
resolve(result);
}
},
quality
);
}
);
}
}