react-native-scanbot-sdk/lib/typescript/src/analytics/Analytics.d.ts

Scanbot Document and Barcode Scanner SDK React Native Plugin for Android and iOS

import { ToJsonConfiguration } from '../utils/json/JsonSerializationTypes';
import { DeepPartial, PartiallyConstructible } from '../utils/utils';
/**
The feature that is being tracked.
*/
export declare class AnalyticsFeature extends PartiallyConstructible {
    /** @param source {@displayType `DeepPartial<AnalyticsFeature>`} */
    constructor(source?: DeepPartial<AnalyticsFeature>);
    serialize(config?: ToJsonConfiguration): DeepPartial<AnalyticsFeature>;
}
export declare namespace AnalyticsFeature {
    /**
      The document scanner feature.
      
      Default is "rtuui_document_scanner"
      */
    const documentScanner: string;
}
/**
The category that is being tracked.
*/
export declare class AnalyticsCategory extends PartiallyConstructible {
    /** @param source {@displayType `DeepPartial<AnalyticsCategory>`} */
    constructor(source?: DeepPartial<AnalyticsCategory>);
    serialize(config?: ToJsonConfiguration): DeepPartial<AnalyticsCategory>;
}
export declare namespace AnalyticsCategory {
    /**
      The acknowledge category.
      
      Default is "acknowledge"
      */
    const acknowledge: string;
}
/**
The event that is being tracked.
*/
export declare class AnalyticsEvent extends PartiallyConstructible {
    /**
      The feature associated with the event.
      */
    feature: string;
    /**
      The category of the event.
      */
    category: string;
    /**
      The name of the event.
      */
    name: string;
    /**
      The value associated with the event.
      */
    values: string[];
    /** @param source {@displayType `DeepPartial<AnalyticsEvent>`} */
    constructor(source?: DeepPartial<AnalyticsEvent>);
    serialize(config?: ToJsonConfiguration): DeepPartial<AnalyticsEvent>;
}
/**
The name of the event.
*/
export declare class AnalyticsEventName extends PartiallyConstructible {
    /** @param source {@displayType `DeepPartial<AnalyticsEventName>`} */
    constructor(source?: DeepPartial<AnalyticsEventName>);
    serialize(config?: ToJsonConfiguration): DeepPartial<AnalyticsEventName>;
}
export declare namespace AnalyticsEventName {
    /**
      The image quality result event for imported page.
      
      Default is "imported_image_quality_result"
      */
    const importedImageQualityResult: string;
    /**
      The image quality result event for scanned page.
      
      Default is "scanned_image_quality_result"
      */
    const scannedImageQualityResult: string;
    /**
      The proceed event.
      
      Default is "proceed_with_image"
      */
    const proceedImage: string;
    /**
      The retake event.
      
      Default is "retake_image"
      */
    const retakeImage: string;
}
/**
A predefined analytics event.
*/
export declare class AnalyticsEventFactory extends PartiallyConstructible {
    /** @param source {@displayType `DeepPartial<AnalyticsEventFactory>`} */
    constructor(source?: DeepPartial<AnalyticsEventFactory>);
    serialize(config?: ToJsonConfiguration): DeepPartial<AnalyticsEventFactory>;
}
export declare namespace AnalyticsEventFactory {
    /**
      A predefined analytics event.
      */
    const scannedImageQualityResult: AnalyticsEvent;
    /**
      A predefined analytics event.
      */
    const importedImageQualityResult: AnalyticsEvent;
    /**
      A predefined analytics event.
      */
    const proceedWithImage: AnalyticsEvent;
    /**
      A predefined analytics event.
      */
    const retakeImage: AnalyticsEvent;
}
//# sourceMappingURL=Analytics.d.ts.map