instabug-reactnative/dist/modules/BugReporting.d.ts

React Native plugin for integrating the Instabug SDK

import type { DismissType, ExtendedBugReportMode, FloatingButtonPosition, InvocationEvent, InvocationOption, RecordingButtonPosition, ReportType, userConsentActionType } from '../utils/Enums';
/**
 * Enables and disables manual invocation and prompt options for bug and feedback.
 * @param isEnabled
 */
export declare const setEnabled: (isEnabled: boolean) => void;
/**
 * Sets the events that invoke the feedback form.
 * Default is set by `Instabug.init`.
 * @param events Array of events that invokes the feedback form.
 */
export declare const setInvocationEvents: (events: InvocationEvent[]) => void;
/**
 * Sets the invocation options.
 * Default is set by `Instabug.init`.
 * @param options Array of invocation options
 */
export declare const setOptions: (options: InvocationOption[]) => void;
/**
 * Sets a block of code to be executed just before the SDK's UI is presented.
 * This block is executed on the UI thread. Could be used for performing any
 * UI changes before the SDK's UI is shown.
 * @param handler A callback that gets executed before invoking the SDK
 */
export declare const onInvokeHandler: (handler: () => void) => void;
/**
 * Sets a block of code to be executed right after the SDK's UI is dismissed.
 * This block is executed on the UI thread. Could be used for performing any
 * UI changes after the SDK's UI is dismissed.
 * @param handler A callback to get executed after dismissing the SDK.
 */
export declare const onSDKDismissedHandler: (handler: (dismissType: DismissType, reportType: ReportType) => void) => void;
/**
 * Sets the threshold value of the shake gesture for iPhone/iPod Touch
 * Default for iPhone is 2.5.
 * @param threshold Threshold for iPhone.
 */
export declare const setShakingThresholdForiPhone: (threshold: number) => void;
/**
 * Sets the threshold value of the shake gesture for iPad.
 * Default for iPad is 0.6.
 * @param threshold Threshold for iPad.
 */
export declare const setShakingThresholdForiPad: (threshold: number) => void;
/**
 * Sets the threshold value of the shake gesture for android devices.
 * Default for android is an integer value equals 350.
 * you could increase the shaking difficulty level by
 * increasing the `350` value and vice versa
 * @param threshold Threshold for android devices.
 */
export declare const setShakingThresholdForAndroid: (threshold: number) => void;
/**
 * Sets whether the extended bug report mode should be disabled, enabled with
 * required fields or enabled with optional fields.
 * @param mode An enum to disable the extended bug report mode,
 * enable it with required or with optional fields.
 */
export declare const setExtendedBugReportMode: (mode: ExtendedBugReportMode) => void;
/**
 * Sets what type of reports, bug or feedback, should be invoked.
 * @param types Array of reportTypes
 */
export declare const setReportTypes: (types: ReportType[]) => void;
/**
 * Invoke bug reporting with report type and options.
 * @param type
 * @param options
 */
export declare const show: (type: ReportType, options: InvocationOption[]) => void;
/**
 * Enable/Disable screen recording
 * @param isEnabled enable/disable screen recording on crash feature
 */
export declare const setAutoScreenRecordingEnabled: (isEnabled: boolean) => void;
/**
 * Sets auto screen recording maximum duration
 *
 * @param maxDuration maximum duration of the screen recording video in seconds.
 * The maximum duration is 30 seconds
 */
export declare const setAutoScreenRecordingDurationIOS: (maxDuration: number) => void;
/**
 * Sets the default position at which the Instabug screen recording button will be shown.
 * Different orientations are already handled.
 * (Default for `position` is `bottomRight`)
 *
 * @param buttonPosition is of type position `topLeft` to show on the top left
 * of screen, or `bottomRight` to show on the bottom right of screen.
 */
export declare const setVideoRecordingFloatingButtonPosition: (buttonPosition: RecordingButtonPosition) => void;
/**
 * Enables/disables inspect view hierarchy when reporting a bug/feedback.
 * @param isEnabled A boolean to set whether view hierarchy are enabled or disabled.
 */
export declare const setViewHierarchyEnabled: (isEnabled: boolean) => void;
/**
 * Adds a user consent item to the bug reporting form.
 * @param key A unique identifier string for the consent item.
 * @param description The text shown to the user describing the consent item.
 * @param mandatory Whether the user must agree to this item before submitting a report.
 * @param checked Whether the consent checkbox is pre-selected.
 * @param actionType A string representing the action type to map to SDK behavior.
 */
export declare const addUserConsent: (key: string, description: string, mandatory: boolean, checked: boolean, actionType?: userConsentActionType) => void;
/**
 * Sets a block of code to be executed when a prompt option is selected.
 * @param handler - A callback that gets executed when a prompt option is selected.
 */
export declare const setDidSelectPromptOptionHandler: (handler: (promptOption: string) => void) => void;
/**
 * Sets the default edge and offset from the top at which the floating button
 * will be shown. Different orientations are already handled.
 * @param edge The screen edge to show the floating button onto. Default is `floatingButtonEdge.right`.
 * @param offset The offset of the floating button from the top of the screen. Default is 50.
 */
export declare const setFloatingButtonEdge: (edge: FloatingButtonPosition, offset: number) => void;
/**
 * Sets whether attachments in bug reporting and in-app messaging are enabled or not.
 * @param screenshot A boolean to enable or disable screenshot attachments.
 * @param extraScreenshot A boolean to enable or disable extra screenshot attachments.
 * @param galleryImage A boolean to enable or disable gallery image attachments. In iOS 10+,
 * NSPhotoLibraryUsageDescription should be set in info.plist to enable gallery image attachments.
 * @param screenRecording A boolean to enable or disable screen recording attachments.
 */
export declare const setEnabledAttachmentTypes: (screenshot: boolean, extraScreenshot: boolean, galleryImage: boolean, screenRecording: boolean) => void;
/**
 * Adds a disclaimer text within the bug reporting form, which can include hyperlinked text.
 * @param text String text.
 */
export declare const setDisclaimerText: (text: string) => void;
/**
 * Sets a minimum number of characters as a requirement for the comments field in the different report types.
 * @param limit int number of characters.
 * @param reportTypes (Optional) Array of reportType. If it's not passed, the limit will apply to all report types.
 */
export declare const setCommentMinimumCharacterCount: (limit: number, reportTypes?: ReportType[]) => void;