expo-barcode-scanner/build/BarCodeScanner.d.ts

import { PermissionResponse, PermissionStatus, PermissionHookOptions } from 'expo-modules-core';
import * as React from 'react';
import { ViewProps } from 'react-native';
/**
 * Those coordinates are represented in the coordinate space of the barcode source (e.g. when you
 * are using the barcode scanner view, these values are adjusted to the dimensions of the view).
 */
export declare type BarCodePoint = {
    /**
     * The `x` coordinate value.
     */
    x: number;
    /**
     * The `y` coordinate value.
     */
    y: number;
};
export declare type BarCodeSize = {
    /**
     * The height value.
     */
    height: number;
    /**
     * The width value.
     */
    width: number;
};
export declare type BarCodeBounds = {
    /**
     * The origin point of the bounding box.
     */
    origin: BarCodePoint;
    /**
     * The size of the bounding box.
     */
    size: BarCodeSize;
};
/**
 * > __Note:__ `bounds` and `cornerPoints` are not always available. On iOS, for `code39` and `pdf417`
 * > you don't get those values. Moreover, on iOS, those values don't have to bounds the whole barcode.
 * > For some types, they will represent the area used by the scanner.
 */
export declare type BarCodeScannerResult = {
    /**
     * The barcode type.
     */
    type: string;
    /**
     * The information encoded in the bar code.
     */
    data: string;
    /**
     * The [BarCodeBounds](#barcodebounds) object.
     */
    bounds?: BarCodeBounds;
    /**
     * Corner points of the bounding box.
     */
    cornerPoints?: BarCodePoint[];
};
export declare type BarCodeEvent = BarCodeScannerResult & {
    target?: number;
};
export declare type BarCodeEventCallbackArguments = {
    nativeEvent: BarCodeEvent;
};
export declare type BarCodeScannedCallback = (params: BarCodeEvent) => void;
export declare type BarCodeScannerProps = ViewProps & {
    /**
     * Camera facing. Use one of `BarCodeScanner.Constants.Type`. Use either `Type.front` or `Type.back`.
     * Same as `Camera.Constants.Type`.
     * @default Type.back
     */
    type?: 'front' | 'back' | number;
    /**
     * An array of bar code types. Usage: `BarCodeScanner.Constants.BarCodeType.<codeType>` where
     * `codeType` is one of these [listed above](#supported-formats). Defaults to all supported bar
     * code types. It is recommended to provide only the bar code formats you expect to scan to
     * minimize battery usage.
     *
     * For example: `barCodeTypes={[BarCodeScanner.Constants.BarCodeType.qr]}`.
     */
    barCodeTypes?: string[];
    /**
     * A callback that is invoked when a bar code has been successfully scanned. The callback is
     * provided with an [BarCodeScannerResult](#barcodescannerresult).
     * > __Note:__ Passing `undefined` to the `onBarCodeScanned` prop will result in no scanning. This
     * > can be used to effectively "pause" the scanner so that it doesn't continually scan even after
     * > data has been retrieved.
     */
    onBarCodeScanned?: BarCodeScannedCallback;
};
export declare class BarCodeScanner extends React.Component<BarCodeScannerProps> {
    lastEvents: {
        [key: string]: any;
    };
    lastEventsTimes: {
        [key: string]: any;
    };
    static Constants: {
        BarCodeType: any;
        Type: any;
    };
    static ConversionTables: {
        type: any;
    };
    static defaultProps: {
        type: any;
        barCodeTypes: unknown[];
    };
    /**
     * Checks user's permissions for accessing the camera.
     * @return Return a promise that fulfills to an object of type [`PermissionResponse`](#permissionresponse).
     */
    static getPermissionsAsync(): Promise<PermissionResponse>;
    /**
     * Asks the user to grant permissions for accessing the camera.
     *
     * On iOS this will require apps to specify the `NSCameraUsageDescription` entry in the `Info.plist`.
     * @return Return a promise that fulfills to an object of type [`PermissionResponse`](#permissionresponse).
     */
    static requestPermissionsAsync(): Promise<PermissionResponse>;
    /**
     * Check or request permissions for the barcode scanner.
     * This uses both `requestPermissionAsync` and `getPermissionsAsync` to interact with the permissions.
     *
     * @example
     * ```ts
     * const [status, requestPermission] = BarCodeScanner.usePermissions();
     * ```
     */
    static usePermissions: (options?: PermissionHookOptions<object> | undefined) => [PermissionResponse | null, () => Promise<PermissionResponse>, () => Promise<PermissionResponse>];
    /**
     * Scan bar codes from the image given by the URL.
     * @param url URL to get the image from.
     * @param barCodeTypes An array of bar code types. Defaults to all supported bar code types on
     * the platform.
     * > __Note:__ Only QR codes are supported on iOS.
     * @return A possibly empty array of objects of the `BarCodeScannerResult` shape, where the type
     * refers to the bar code type that was scanned and the data is the information encoded in the bar
     * code.
     */
    static scanFromURLAsync(url: string, barCodeTypes?: string[]): Promise<BarCodeScannerResult[]>;
    render(): JSX.Element;
    onObjectDetected: (callback?: BarCodeScannedCallback | undefined) => ({ nativeEvent }: BarCodeEventCallbackArguments) => void;
    convertNativeProps(props: BarCodeScannerProps): BarCodeScannerProps;
}
export { PermissionResponse, PermissionStatus, PermissionHookOptions };
export declare const Constants: {
    BarCodeType: any;
    Type: any;
}, getPermissionsAsync: typeof BarCodeScanner.getPermissionsAsync, requestPermissionsAsync: typeof BarCodeScanner.requestPermissionsAsync, usePermissions: (options?: PermissionHookOptions<object> | undefined) => [PermissionResponse | null, () => Promise<PermissionResponse>, () => Promise<PermissionResponse>], scanFromURLAsync: typeof BarCodeScanner.scanFromURLAsync;