@capacitor-firebase/crashlytics/dist/esm/definitions.d.ts

Capacitor plugin for Firebase Crashlytics.

export interface FirebaseCrashlyticsPlugin {
    /**
     * Forces a crash to test the implementation.
     *
     * Only available for Android and iOS.
     *
     * @since 0.1.0
     */
    crash(options: CrashOptions): Promise<void>;
    /**
     * Sets a custom key and value that is associated with subsequent fatal and non-fatal reports.
     *
     * Only available for Android and iOS.
     *
     * @since 0.1.0
     */
    setCustomKey(options: SetCustomKeyOptions): Promise<void>;
    /**
     * Sets a user ID (identifier) that is associated with subsequent fatal and non-fatal reports.
     *
     * Only available for Android and iOS.
     *
     * @since 0.1.0
     */
    setUserId(options: SetUserIdOptions): Promise<void>;
    /**
     * Adds a custom log message that is sent with your crash data to give yourself more context for the events leading up to a crash.
     *
     * Only available for Android and iOS.
     *
     * @since 0.1.0
     */
    log(options: LogOptions): Promise<void>;
    /**
     * Enables/disables automatic data collection.
     * The value does not apply until the next run of the app.
     *
     * Only available for Android and iOS.
     *
     * @since 0.1.0
     */
    setEnabled(options: SetEnabledOptions): Promise<void>;
    /**
     * Returns whether or not automatic data collection is enabled.
     *
     * Only available for iOS.
     *
     * @since 0.1.0
     */
    isEnabled(): Promise<IsEnabledResult>;
    /**
     * Returns whether the app crashed during the previous execution.
     *
     * Only available for Android and iOS.
     *
     * @since 0.1.0
     */
    didCrashOnPreviousExecution(): Promise<DidCrashOnPreviousExecutionResult>;
    /**
     * Uploads any unsent reports to Crashlytics at next startup.
     *
     * When automatic data collection is enabled, Crashlytics automatically uploads reports at startup.
     *
     * Only available for Android and iOS.
     *
     * @since 0.1.0
     */
    sendUnsentReports(): Promise<void>;
    /**
     * Deletes any unsent reports on the device.
     *
     * Only available for Android and iOS.
     *
     * @since 0.1.0
     */
    deleteUnsentReports(): Promise<void>;
    /**
     * Records a non-fatal report to send to Crashlytics.
     *
     * Only available for Android and iOS.
     *
     * @since 0.1.0
     */
    recordException(options: RecordExceptionOptions): Promise<void>;
}
/**
 * @since 0.1.0
 */
export interface CrashOptions {
    /**
     * @since 0.1.0
     */
    message: string;
}
/**
 * @since 0.1.0
 */
export type SetCustomKeyOptions = CustomKeyAndValue;
/**
 * @since 0.1.0
 */
export interface SetUserIdOptions {
    /**
     * @since 0.1.0
     */
    userId: string;
}
/**
 * @since 0.1.0
 */
export interface LogOptions {
    /**
     * @since 0.1.0
     */
    message: string;
}
/**
 * @since 0.1.0
 */
export interface SetEnabledOptions {
    /**
     * @since 0.1.0
     */
    enabled: boolean;
}
/**
 * @since 0.1.0
 */
export interface IsEnabledResult {
    /**
     * @since 0.1.0
     */
    enabled: boolean;
}
/**
 * @since 0.1.0
 */
export interface DidCrashOnPreviousExecutionResult {
    /**
     * @since 0.1.0
     */
    crashed: boolean;
}
/**
 * @since 0.1.0
 */
export interface RecordExceptionOptions {
    /**
     * The message to record as a non-fatal exception.
     *
     * @since 0.1.0
     */
    message: string;
    /**
     * Error code within a specific error domain.
     *
     * **Attention:** This option is ignored on iOS if `stacktrace` is provided.
     *
     * Only available for iOS.
     *
     * @since 0.1.0
     */
    code?: number;
    /**
     * A string containing the error domain.
     *
     * **Attention:** This option is ignored on iOS if `stacktrace` is provided.
     *
     * Only available for iOS.
     *
     * @since 0.1.0
     */
    domain?: string;
    /**
     * An array of keys and the values to associate with the non fatal exception,
     * in addition to the app level custom keys.
     *
     * **Attention:** This option is ignored on iOS if `stacktrace` is provided.
     *
     * @since 7.1.0
     */
    keysAndValues?: CustomKeyAndValue[];
    /**
     * A stacktrace generated by stacktrace.js.
     *
     * @since 1.1.0
     */
    stacktrace?: StackFrame[];
}
/**
 * @since 7.1.0
 */
export interface CustomKeyAndValue {
    /**
     * @since 7.1.0
     */
    key: string;
    /**
     * @since 7.1.0
     */
    value: string | number | boolean;
    /**
     * @since 7.1.0
     */
    type: 'string' | 'long' | 'double' | 'boolean' | 'int' | 'float';
}
/**
 * Subset of the Stacktrace generated by stacktrace.js.
 *
 * @since 1.1.0
 */
export interface StackFrame {
    lineNumber?: number;
    fileName?: string;
    functionName?: string;
}