instabug-cordova

Cordova Instabug Plugin

The purpose of this plugin is to simplify the process of integrating the Instabug SDK in a hybrid application, as well as to provide an interface to interfacing with the SDK through JavaScript.

Supported Platforms

• iOS (SDK >= ?)
• Android (SDK >= 10)

Installation

Currently, this plugin can only be installed via the Command-Line Interface.

cordova plugin add https://github.com/Instabug/instabug-cordova

Usage

To initialize Instabug in your app, you only need to make one call to the plugin: activate. This method requires your app's token and your desired invocation event, and can take a wide range of optional parameters for configuration.

Your app's token (available on your Instabug dashboard online) can be specified as a string or an object containing properties according to platform:

var token = 'YOUR_TOKEN_HERE';

or

var tokens = {
  android: 'YOUR_ANDROID_TOKEN_HERE',
  ios: 'YOUR_IOS_TOKEN_HERE'
};

The invocation event can be specified as one of the following values:

value	native equivalent	description	iOS only?
'shake'	InstabugInvocationEvent.SHAKE	Shaking the device while in any screen to show the feedback form.
'button'	InstabugInvocationEvent.FLOATING_BUTTON	Shows a floating button on top of all views, when pressed it takes a screenshot.
'screenshot'	InstabugInvocationEvent.SCREENSHOT_GESTURE	Taking a screenshot using the Home+Lock buttons while in any screen to show the feedback form, substituted with IBGInvocationEventShake on iOS 6.1.3 and earlier.	√
'swipe'	InstabugInvocationEvent.TWO_FINGER_SWIPE_LEFT	Swiping two fingers left while in any screen to show the feedback form.	√
'none'	InstabugInvocationEvent.NONE	No event will be registered to show the feedback form, you'll need to code your own and call the method invoke.
Like the token, the value itself can be provided, or you can give an object with values according to platforms using the same syntax as above.

The final parameter to the activate method (besides success and error callback functions) is an optional object containing properties to set a variety of configurations. None of these configurations are required. See the table below for their specifications.

property	description	possible values	default value	Android?	iOS?
emailRequired	Sets whether email field is required or not when submitting bug/feedback	true, false	true	√	√
commentRequired	Sets whether comment field is required or not when submitting bug/feedback	true, false	false	√	√
defaultInvocationMode	Sets which invocation mode should the SDK use by default when the invocation event occurs	'bug','feedback', 'na'	'na'	√	√
shakingThresholdAndroid	Sets the threshold value of the shake gesture on the device	String representation of int	'11'	√
shakingThresholdIPhone	Sets the threshold value of the shake gesture on the device	String representation of double	'2.5'		√
shakingThresholdIPad	Sets the threshold value of the shake gesture on the device	String representation of double	'0.6'		√
floatingButtonEdge	Sets the default edge at which the floating button will be shown	'right', 'left'	'right'	√	√
floatingButtonOffset	Sets the default offset of the floating button from the top of the screen	String representation of integer	'-1'	√	√
enableDebug	Enable/Disable debug logs from Instabug SDK	true, false	false	√
enableConsoleLogs	Enable/disable console log to be added to reports	true, false	true	√
enableInstabugLogs	Enable/disable Instabug log to be added to reports	true, false	true	√
enableTrackingUserSteps*	Enable/disable automatic user steps tracking	true, false	true	√	√
enableCrashReporting*	Enable/disable crash reporting	true, false	true	√	√
enableInAppMessaging	Enable/Disable in-app messaging	true, false	true	√
enableConversationSounds	Set whether new messages received will trigger a small sound notification or not	true, false	false	√
enablePushNotifications	Enable/disable push notifications feature	true, false	true	√	√
enableIntroDialog	Enable/disable intro dialog shown the first time app is opened	true, false	true	√	√
enableUserData	Enable/disable user data to be added to reports	true, false	true	√
colorTheme	Set which color theme to use for the SDK's UI	'light', 'dark'	'light'	√	√
*Pro feature

Sample

The sample demonstrates how to initiate Instabug.

cordova.plugins.instabug.activate(
    {
        android: 'MY_ANDROID_TOKEN',
        ios: 'MY_IOS_TOKEN'
    },
    'shake',
    {
        commentRequired: true,
        colorTheme: 'dark',
        shakingThresholdIPhone: '1.5',
        shakingThresholdIPad: '0.6',
        enableIntroDialog: false
    },
    function () {
        console.log('Instabug initialized.');
    },
    function (error) {
        console.log('Instabug could not be initialized - ' + error);
    }
);

Other actions

After you've initialized Instabug, you can call a variety of other methods on the plugin object. Each of these methods takes success and error callback function parameters, specified after any parameters detailed in the table below. If a parameter is listed as optional and you do not wish to supply it, pass null instead, otherwise your callback functions won't run.

method	description	parameters	Android?	iOS?
invoke	Show the Instabug dialog so user can choose to report a bug, or submit feedback	optional: 'bug', 'feedback', or 'na'	√	√
showIntro*	Display the discovery dialog explaining the shake gesture or the two finger swipe gesture	none	√	√
setPrimaryColor	Set the primary color that the SDK will use to tint certain UI elements in the SDK	integer representation of a color .	√	√
setUserEmail*	If your app already acquires the user's email address and you provide it to this method, Instabug will pre-fill the user email in reports	email address	√	√
setUserName*	Sets the user name that is used in the dashboard's contact	name	√	√
setUserData*	Adds specific user data that you need to be added to the reports	any string	√	√
addFile*	Uploads file along upcoming reports	Path to desired file on device - can't use path of file relative to your application files. Can be specified as a string or an object with properties by platform.	√	√
addLog*	Appends a log message to Instabug internal log. These logs are then sent along the next uploaded report. All log messages are timestamped. Logs aren't cleared per single application run. If you wish to reset the logs, use clearLog(). Note: logs passed to this method are NOT printed to Logcat.	any string	√	√
clearLog	Clears Instabug internal log	none	√
changeInvocationEvent	Changes the event used to invoke Instabug SDK	'shake', 'button', 'screenshot', 'swipe', or 'none' (see first table on page)	√	√
disable	Disables all Instabug functionality	none	√
enable	Enables all Instabug functionality	none	√
isEnabled	Returns true if Instabug is enabled, false if it's disabled	none	√
isDebugEnabled	Returns if Instabug SDK debug logs will be added to LogCat logs or not	none	√
setLocale	Set the locale used to display the strings in the correct language	'arabic', 'chineseSimplified', 'chineseTraditional', 'english', 'french', 'german', 'italian', 'japanese', 'korean', 'polish', 'portugueseBrazil', 'russian', 'spanish', 'swedish', or 'turkish'		√
*Pro feature

Tips & tricks

• You should initialize Instabug as soon as you can in your app. For Ionic users, the best place is in the run method of your module.
• For Android, if you use other plugins that open dialogs (like InAppBrowser) that you will want included in your screenshots, you'll need to modify the plugin code itself to call Instabug.setDialog(Dialog dialog) when it is opened. See Instabug official documentation for more info on usage (or, you can always check out my InAppBrowser fork, which includes this functionality as well as other useful things like hiding an open browser).
• The Instabug SDK also offers a reportException method that is not accessible through JavaScript but may be useful for adding these exceptions to your reports if you modify plugins to call it.

Contributing (please do!)

• Fork this repo.
• Create your own branch. (git checkout -b my-feature)
• Commit your changes. (git commit -am 'Add my awesome feature')
• Push to your branch. (git push origin my-feature)
• Create new pull request.

License

This software is released under the Apache 2.0 License.

© 2016 Instabug. All rights reserved.

Changelog

v11.0.0 (2022-07-07)

• Bumps Instabug native SDKs to v11
• Adds the ability to initialize the Android SDK from JavaScript. Check the [migration guide][migration-guide-v11] for further info
• Improves Instabug modules import usage. Check the [migration guide][migration-guide-v11] for further info
• Migrates Instabug iOS SDK to be installed through CocoaPods
• Adds new APIs:
  • Instabug.setString to allow for SDK text customizations
  • Instabug.setWelcomeMessageMode
  • Instabug.setColorTheme
  • Instabug.setSessionProfilerEnabled
  • BugReporting.setShakingThresholdForiPhone
  • BugReporting.setShakingThresholdForiPad
  • BugReporting.setFloatingButtonEdge
• Replaces Instabug.setShakingThreshold with BugReporting.setShakingThresholdForAndroid
• Moves Instabug.setVideoRecordingFloatingButtonPosition to the BugReporting module
• Fixes an issue with uploading attachments in URL form on iOS
• Fixes an issue with BugReporting.setEnabledAttachmentTypes not working on Android
• Removes the deprecated APIs. Check the [migration guide][migration-guide-v11] for further info
• Removes the Android multidex dependency
• Removes the APIs:
  • Instabug.setAutoScreenRecordingMaxDuration
  • Surveys.setThresholdForReshowingSurveyAfterDismiss
• Removes BugReporting.invocationModes enum