@ionic-native/image-picker/index.d.ts

Ionic Native - Native plugins for ionic apps

import { IonicNativePlugin } from '@ionic-native/core';
export interface ImagePickerOptions {
    /**
     * 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. (Android only)
     */
    maximumImagesCount?: number;
    /**
     * Max width to allow images to be
     */
    width?: number;
    /**
     * Max height to allow images to be
     */
    height?: number;
    /**
     * Quality of images, defaults to 100
     */
    quality?: number;
    /**
     * Videos allowed?
     */
    allow_video?: boolean;
    /**
     * the default is the message of the old plugin impl
     */
    title?: string;
    /**
     * the old plugin impl didn't have it, so passing null by default
     */
    message?: string;
    /**
     * Choose the format of the return value.
     * Defined in ImagePicker.OutputType. Default is FILE_URI.
     *      FILE_URI : 0,   Return image file URI,
     *      DATA_URL : 1,   Return image as base64-encoded string
     */
    outputType?: number;
    /**
     * Disable the iOS popover as seen on iPad
     */
    disable_popover?: boolean;
}
export declare enum OutputType {
    FILE_URL = 0,
    DATA_URL = 1
}
/**
 * @name Image Picker
 * @description
 * Cordova Plugin For Multiple Image Selection
 *
 * Requires Cordova plugin: `cordova-plugin-image-picker`.
 * For more info, please see the https://github.com/Telerik-Verified-Plugins/ImagePicker
 *
 * @usage
 * ```typescript
 * import { ImagePicker } from '@ionic-native/image-picker/ngx';
 *
 *
 * constructor(private imagePicker: ImagePicker) { }
 *
 * ...
 *
 * this.imagePicker.getPictures(options).then((results) => {
 *   for (var i = 0; i < results.length; i++) {
 *       console.log('Image URI: ' + results[i]);
 *   }
 * }, (err) => { });
 *
 * ```
 * @interfaces
 * ImagePickerOptions
 */
export declare class ImagePickerOriginal extends IonicNativePlugin {
    /**
     * Pick pictures from the library.
     * @param {ImagePickerOptions} options
     * @returns {Promise<any>} Returns a Promise that resolves the image file URI
     * otherwise rejects with an error.
     */
    getPictures(options: ImagePickerOptions): Promise<any>;
    /**
     * 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
     */
    hasReadPermission(): Promise<boolean>;
    /**
     * Request permission to read images
     * @returns {Promise<any>}
     */
    requestReadPermission(): Promise<any>;
}

export declare const ImagePicker: ImagePickerOriginal;