90 lines
2.1 KiB
TypeScript
Raw Normal View History

2016-07-17 19:56:02 +02:00
import { Cordova, Plugin } from './plugin';
2016-03-10 20:29:50 +00:00
export interface ImagePickerOptions {
2016-10-14 06:44:57 -04:00
/**
* max images to be selected, defaults to 15. If this is set to 1, upon selection of a single image, the plugin will return it.
*/
2016-07-17 19:56:02 +02:00
maximumImagesCount?: number;
2016-03-10 20:29:50 +00:00
2016-10-14 06:44:57 -04:00
/**
* Max width to allow images to be
*/
2016-07-17 19:56:02 +02:00
width?: number;
2016-10-14 06:44:57 -04:00
/**
* Max height to allow images to be
*/
2016-07-17 19:56:02 +02:00
height?: number;
2016-03-10 20:29:50 +00:00
2016-10-14 06:44:57 -04:00
/**
* Quality of images, defaults to 100
*/
2016-07-17 19:56:02 +02:00
quality?: number;
/**
* Output type, defaults to 0 (FILE_URI).
*/
outputType?: number;
2016-03-10 20:29:50 +00:00
}
/**
2016-03-13 15:45:07 -04:00
* @name Image Picker
2016-03-10 20:29:50 +00:00
* @description
* Cordova Plugin For Multiple Image Selection
*
* Requires Cordova plugin: `cordova-plugin-image-picker`.
* For more info, please see the https://github.com/wymsee/cordova-imagePicker
*
* @usage
* ```typescript
* import { ImagePicker } from 'ionic-native';
*
*
*
2016-03-10 15:59:14 -08:00
* ImagePicker.getPictures(options).then((results) => {
2016-03-10 20:29:50 +00:00
* for (var i = 0; i < results.length; i++) {
* console.log('Image URI: ' + results[i]);
* }
* }, (err) => { });
2016-03-10 20:29:50 +00:00
* ```
2016-10-14 06:44:57 -04:00
* @interfaces
* ImagePickerOptions
2016-03-10 20:29:50 +00:00
*/
@Plugin({
pluginName: 'ImagePicker',
2016-11-23 08:51:04 -05:00
plugin: 'https://github.com/Telerik-Verified-Plugins/ImagePicker',
2016-03-10 20:39:14 +00:00
pluginRef: 'window.imagePicker',
2016-11-23 08:51:04 -05:00
repo: 'https://github.com/Telerik-Verified-Plugins/ImagePicker'
2016-03-10 20:29:50 +00:00
})
export class ImagePicker {
/**
* Pick pictures from the library.
* @param {ImagePickerOptions} options
* @returns {Promise<any>} Returns a Promise that resolves the image file URI
2016-03-10 20:29:50 +00:00
* otherwise rejects with an error.
*/
@Cordova({
callbackOrder: 'reverse'
})
static getPictures(options: ImagePickerOptions): Promise<any> { return; }
2016-07-17 19:56:02 +02:00
/**
* Check if we have permission to read images
* @returns {Promise<boolean>} Returns a promise that resolves with a boolean that indicates whether we have permission
*/
@Cordova({
platforms: ['Android']
})
static hasReadPermission(): Promise<boolean> { return; }
/**
* Request permission to read images
* @returns {Promise<any>}
*/
@Cordova({
platforms: ['Android']
})
static requestReadPermission(): Promise<any> { return; }
2016-03-10 20:29:50 +00:00
}