import {NativeModules, NativeAppEventEmitter, Platform} from "react-native";
let {Instabug} = NativeModules;
/**
* Instabug
* @exports Instabug
*/
module.exports = {
/**
* Starts the SDK.
* This is the main SDK method that does all the magic. This is the only
* method that SHOULD be called.
* Should be called in constructor of the app registery component
* @param {string} token The token that identifies the app, you can find
* it on your dashboard.
* @param {invocationEvent} invocationEvent The event that invokes
* the SDK's UI.
*/
startWithToken: function (token, invocationEvent) {
Instabug.startWithToken(token, invocationEvent);
},
/**
* Invokes the SDK manually with the default invocation mode.
* Shows a view that asks the user whether they want to start a chat, report
* a problem or suggest an improvement.
*/
invoke: function () {
Instabug.invoke();
},
/**
* Invokes the SDK with a specific mode.
* Invokes the SDK and show a specific view, instead of showing a prompt for
* users to choose from.
* @param {invocationMode} invocationMode Specifies which mode the
* SDK is going to start with.
*/
invokeWithInvocationMode: function (invocationMode) {
Instabug.invokeWithInvocationMode(invocationMode);
},
/**
* Dismisses any Instabug views that are currently being shown.
*/
dismiss: function () {
Instabug.dismiss();
},
/**
* Attaches a file to each report being sent.
* A new copy of the file at fileLocation will be attached with each bug
* report being sent.
* Each call to this method overrides the file to be attached.
* The file has to be available locally at the provided path.
* @param {string} fileLocation Path to a file that's going to be attached
* to each report.
*/
// Not yet tested
setFileAttachment: function (fileLocation) {
Instabug.setFileAttachment(fileLocation);
},
/**
* Attaches user data to each report being sent.
* Each call to this method overrides the user data to be attached.
* Maximum size of the string is 1,000 characters.
* @param {string} userData A string to be attached to each report, with a
* maximum size of 1,000 characters.
*/
setUserData: function (userData) {
Instabug.setUserData(userData);
},
/**
* Adds custom logs that will be sent with each report.
* @param {string} log Message to be logged.
*/
IBGLog: function (log) {
Instabug.IBGLog(log);
},
/**
* Sets whether the SDK is tracking user steps or not.
* Enabling user steps would give you an insight on the scenario a user has
* performed before encountering a bug or a crash. User steps are attached
* with each report being sent.
* @param {boolean} isUserStepsEnabled A boolean to set user steps tracking
* to being enabled or disabled.
*/
setUserStepsEnabled: function (isUserStepsEnabled) {
if (Platform.OS === 'ios')
Instabug.setUserStepsEnabled(isUserStepsEnabled);
},
/**
* Sets a block of code to be executed before sending each report.
* This block is executed in the background before sending each report. Could
* be used for attaching logs and extra data to reports.
* @param {preSendingHandler} preSendingHandler - A callback that gets executed before sending each bug
* report.
*/
setPreSendingHandler: function (preSendingHandler) {
if (Platform.OS === 'ios') {
Instabug.addListener('IBGpreSendingHandler');
NativeAppEventEmitter.addListener(
'IBGpreSendingHandler',
preSendingHandler
);
Instabug.setPreSendingHandler(preSendingHandler);
}
},
/**
* 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 {preInvocationHandler} preInvocationHandler - A callback that gets executed before invoking the SDK
*/
setPreInvocationHandler: function (preInvocationHandler) {
if (Platform.OS === 'ios') {
Instabug.addListener('IBGpreInvocationHandler');
NativeAppEventEmitter.addListener(
'IBGpreInvocationHandler',
preInvocationHandler
);
Instabug.setPreInvocationHandler(preInvocationHandler);
}
},
/**
* 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 {postInvocationHandler} postInvocationHandler - A callback to get executed after
* dismissing the SDK.
*/
setPostInvocationHandler: function (postInvocationHandler) {
if (Platform.OS === 'ios') {
Instabug.addListener('IBGpostInvocationHandler');
NativeAppEventEmitter.addListener(
'IBGpostInvocationHandler',
function (payload) {
postInvocationHandler(payload['dismissType'], payload['reportType']);
}
);
Instabug.setPostInvocationHandler(postInvocationHandler);
}
},
/**
* Present a view that educates the user on how to invoke the SDK with the
* currently set invocation event.
*/
showIntroMessage: function () {
Instabug.showIntroMessage();
},
/**
* Sets the default value of the user's email and hides the email field
* from the reporting UI.
* Defaults to an empty string.
* @param {string} userEmail An email address to be set as the user's email.
*/
setUserEmail: function (userEmail) {
Instabug.setUserEmail(userEmail);
},
/**
* Sets the default value of the user's name to be included with all reports.
* Defaults to an empty string.
* @param {string} userName Name of the user to be set.
*/
setUserName: function (userName) {
Instabug.setUserName(userName);
},
/**
* Enables/disables screenshot view when reporting a bug/improvement.
* By default, screenshot view is shown when reporting a bug, but not when
* sending feedback.
* @param {boolean} willSkipScreenshotAnnotation sets whether screenshot view is
* shown or not. Passing YES will show screenshot view for both feedback and
* bug reporting, while passing NO will disable it for both.
*/
setWillSkipScreenshotAnnotation: function (willSkipScreenshotAnnotation) {
if (Platform.OS === 'ios') {
Instabug.setWillSkipScreenshotAnnotation(willSkipScreenshotAnnotation);
}
},
/**
* Returns the number of unread messages the user currently has.
* Use this method to get the number of unread messages the user
* has, then possibly notify them about it with your own UI.
* @param {messageCountCallback} messageCountCallback callback with argument
* Notifications count, or -1 in case the SDK has not been initialized.
*/
getUnreadMessagesCount: function (messageCountCallback) {
Instabug.getUnreadMessagesCount(messageCountCallback);
},
/**
* Sets the event that invoke the feedback form.
* Default is set by `Instabug.startWithToken`.
* @param {invocationEvent} invocationEvent Event that invokes the
* feedback form.
*/
setInvocationEvent: function (invocationEvent) {
Instabug.setInvocationEvent(invocationEvent);
},
/**
* Enables/disables the use of push notifications in the SDK.
* Defaults to YES.
* @param {boolean} isPushNotificationEnabled A boolean to indicate whether push
* notifications are enabled or disabled.
*/
setPushNotificationsEnabled: function (isPushNotificationEnabled) {
if (Platform.OS === 'ios')
Instabug.setPushNotificationsEnabled(isPushNotificationEnabled);
},
/**
* Sets whether users are required to enter an email address or not when
* sending reports.
* Defaults to YES.
* @param {boolean} isEmailFieldRequired A boolean to indicate whether email
* field is required or not.
*/
setEmailFieldRequired: function (isEmailFieldRequired) {
Instabug.setEmailFieldRequired(isEmailFieldRequired);
},
/**
* Sets whether users are required to enter a comment or not when sending reports.
* Defaults to NO.
* @param {boolean} isCommentFieldRequired A boolean to indicate whether comment
* field is required or not.
*/
setCommentFieldRequired: function (isCommentFieldRequired) {
Instabug.setCommentFieldRequired(isCommentFieldRequired);
},
/**
* Sets the threshold value of the shake gesture for iPhone/iPod Touch and iPad.
* Default for iPhone is 2.5.
* Default for iPad is 0.6.
* @param {number} iPhoneShakingThreshold Threshold for iPhone.
* @param {number} iPadShakingThreshold Threshold for iPad.
*/
setShakingThresholdForIPhone: function (iPhoneShakingThreshold, iPadShakingThreshold) {
if (Platform.OS === 'ios')
Instabug.setShakingThresholdForIPhone(iPhoneShakingThreshold, iPadShakingThreshold);
},
/**
* Sets the default edge and offset from the top at which the floating button
* will be shown. Different orientations are already handled.
* Default for `floatingButtonEdge` is `rectEdge.maxX`.
* Default for `floatingButtonOffsetFromTop` is 50
* @param {rectEdge} floatingButtonEdge `maxX` to show on the right,
* or `minX` to show on the left.
* @param {number} offsetFromTop floatingButtonOffsetFromTop Top offset for
* floating button.
*/
setFloatingButtonEdge: function (floatingButtonEdge, offsetFromTop) {
if (Platform.OS === 'ios')
Instabug.setFloatingButtonEdge(floatingButtonEdge, offsetFromTop);
},
/**
* Sets the SDK's locale.
* Use to change the SDK's UI to different language.
* Defaults to the device's current locale.
* @param {locale} locale A locale to set the SDK to.
*/
setLocale: function (locale) {
if (Platform.OS === 'ios') {
Instabug.setLocale(locale);
} else if (Platform.OS === 'android') {
Instabug.changeLocale(locale);
}
},
/**
* Sets whether the intro message that gets shown on launching the app is
* enabled or not.
* Defaults to YES.
* @param {boolean} isIntroMessageEnabled A boolean to indicate whether the
* intro message is enabled or not.
*/
setIntroMessageEnabled: function (isIntroMessageEnabled) {
if (Platform.OS === 'ios')
Instabug.setIntroMessageEnabled(isIntroMessageEnabled);
},
/**
* Sets the color theme of the SDK's whole UI.
* the SDK's UI to.
* @param colorTheme
*/
setColorTheme: function (colorTheme) {
Instabug.setColorTheme(colorTheme);
},
/**
* Sets the primary color of the SDK's UI.
* Sets the color of UI elements indicating interactivity or call to action.
* To use, import processColor and pass to it with argument the color hex
* as argument.
* @param {color} primaryColor A color to set the UI elements of the SDK to.
*/
setPrimaryColor: function (primaryColor) {
Instabug.setPrimaryColor(primaryColor);
},
/**
* Appends a set of tags to previously added tags of reported feedback,
* bug or crash.
* @param {string[]} tags An array of tags to append to current tags.
*/
appendTags: function (tags) {
Instabug.appendTags(tags);
},
/**
* Manually removes all tags of reported feedback, bug or crash.
*/
resetTags: function () {
Instabug.resetTags();
},
/**
* return callback
* @callback tagsCallback
* @param {string[]} tags of reported feedback, bug or crash.
*/
/**
* Gets all tags of reported feedback, bug or crash.
* @param {tagsCallback} tagsCallback callback with argument tags of reported feedback, bug or crash.
*/
getTags: function (tagsCallback) {
Instabug.getTags(tagsCallback);
},
/**
* Overrides any of the strings shown in the SDK with custom ones.
* Allows you to customize any of the strings shown to users in the SDK.
* @param {string} string String value to override the default one.
* @param {strings} key Key of string to override.
*/
setStringToKey: function (string, key) {
Instabug.setString(string, key);
},
/**
* Sets whether attachments in bug reporting and in-app messaging are enabled or not.
* @param {boolean} screenshot A boolean to enable or disable screenshot attachments.
* @param {boolean} extraScreenshot A boolean to enable or disable extra
* screenshot attachments.
* @param {boolean} 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 {boolean} voiceNote A boolean to enable or disable voice note attachments.
* In iOS 10+, NSMicrophoneUsageDescription should be set in info.plist to enable
* voiceNote attachments.
* @param {boolean} screenRecording A boolean to enable or disable screen recording attachments.
*/
setAttachmentTypesEnabled: function (screenshot, extraScreenshot, galleryImage, voiceNote, screenRecording) {
Instabug.setAttachmentTypesEnabled(screenshot, extraScreenshot, galleryImage, voiceNote, screenRecording);
},
/**
* Enables/disables showing in-app notifications when the user receives a
* new message.
* @param {boolean} isChatNotificationEnabled A boolean to set whether
* notifications are enabled or disabled.
*/
setChatNotificationEnabled: function (isChatNotificationEnabled) {
Instabug.setChatNotificationEnabled(isChatNotificationEnabled);
},
/**
* Sets a block of code that gets executed when a new message is received.
* @param {onNewMessgaeHandler} onNewMessageHandler - A callback that gets
* executed when a new message is received.
*/
setOnNewMessageHandler: function (onNewMessageHandler) {
if (Platform.OS === 'ios') {
Instabug.addListener('IBGonNewMessageHandler');
NativeAppEventEmitter.addListener(
'IBGonNewMessageHandler',
onNewMessgaeHandler
);
Instabug.setOnNewMessageHandler(onNewMessgaeHandler);
}
},
/**
* Checks if a notification is from Instabug.
* If you are using push notifications, use this method to check whether an
* incoming notification is from Instabug or not. If this method returns YES,
* you should call didReceiveRemoteNotification: to let the Instabug handle
* the notification. Otherwise, handle the notification on your own.
* @param {Object} dict Notification's userInfo
* @param {isInstabugNotificationCallback} isInstabugNotificationCallback callback with
* argument isInstabugNotification
*/
isInstabugNotification: function (dict, isInstabugNotificationCallback) {
if (Platform.OS === 'ios')
Instabug.isInstabugNotification(dict, isInstabugNotificationCallback);
},
/**
* Sets the default value of the user's email and hides the email field from the reporting UI
* and set the user's name to be included with all reports.
* It also reset the chats on device to that email and removes user attributes, user data and completed surveys.
* @param {string} email Email address to be set as the user's email.
* @param {string} name Name of the user to be set.
*/
identifyUserWithEmail: function (email, name) {
if (Platform.OS == 'ios') {
Instabug.identifyUserWithEmail(email, name);
} else if ('android') {
Instabug.identifyUser(name, email);
}
},
/**
* Sets the default value of the user's email to nil and show email field and remove user name from all reports
* It also reset the chats on device and removes user attributes, user data and completed surveys.
*/
logOut: function () {
if (Platform.OS == 'ios') {
Instabug.logOut();
}
},
/**
* Sets an array of report categories to be shown for users to select from before reporting a bug or sending
* feedback.
* Use this method to give users a list of choices of categories their bug report or feedback might be related
* to. Selected category will be shown as a tag on your dashboard.
* @param {array} titles titles to be shown in the list.
*/
setReportCategories: function (...titles) {
if (Platform.OS == 'ios') {
Instabug.setReportCategories(titles, null);
} else if (Platform.OS == 'android') {
Instabug.setReportCategories(titles);
}
},
/**
* Logs a user event that happens through the lifecycle of the application.
* Logged user events are going to be sent with each report, as well as at the end of a session.
* @param {string} name Event name.
*/
logUserEventWithName: function (name) {
if (Platform.OS == 'ios') {
Instabug.logUserEventWithName(name);
}
},
/**
* Logs a user event that happens through the lifecycle of the application.
* Logged user events are going to be sent with each report, as well as at the end of a session.
* @param {string} name Event name.
* @param {Object} params An optional dictionary or parameters to be associated with the event.
*/
logUserEventWithNameAndParams: function (name, params) {
if (Platform.OS == 'ios') {
Instabug.logUserEventWithNameAndParams(name, params);
}
},
/**
* 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 {@link #clearLogs()} ()}
*
* Note: logs passed to this method are NOT printed to Logcat
*
* @param message the message
*/
logVerbose: function (message) {
if (!message)return;
if (Platform.OS === 'android') {
Instabug.log("v", message);
} else {
Instabug.logVerbose(message);
}
},
/**
* 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 {@link #clearLogs()} ()}
*
* Note: logs passed to this method are NOT printed to Logcat
*
* @param message the message
*/
logInfo: function (message) {
if (!message)return;
if (Platform.OS === 'android') {
Instabug.log("i", message);
} else {
Instabug.logInfo(message);
}
},
/**
* 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 {@link #clearLogs()} ()}
*
* Note: logs passed to this method are NOT printed to Logcat
*
* @param message the message
*/
logDebug: function (message) {
if (!message)return;
if (Platform.OS === 'android') {
Instabug.log("d", message);
} else {
Instabug.logDebug(message);
}
},
/**
* 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 {@link #clearLogs()} ()}
*
* Note: logs passed to this method are NOT printed to Logcat
*
* @param message the message
*/
logError: function (message) {
if (!message)return;
if (Platform.OS === 'android') {
Instabug.log("e", message);
} else {
Instabug.logError(message);
}
},
/**
* 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 {@link #clearLogs()} ()}
*
* Note: logs passed to this method are NOT printed to Logcat
*
* @param message the message
*/
logWarn: function (message) {
if (!message)return;
if (Platform.OS === 'android') {
Instabug.log("w", message);
} else {
Instabug.logWarn(message);
}
},
/**
* Sets user attribute to overwrite it's value or create a new one if it doesn't exist.
*
* @param key the attribute
* @param value the value
*/
setUserAttribute: function (key, value) {
if (!key || !value || typeof key !== "string" || typeof value !== "string")
throw new TypeError("Invalid param, Expected String");
Instabug.setUserAttribute(key, value);
},
/**
* Returns the user attribute associated with a given key.
aKey
* @param {string} key The attribute key as string
* @param {userAttributeCallback} userAttributeCallback callback with argument as the desired user attribute value
*/
getUserAttribute: function (key, userAttributeCallback) {
Instabug.getUserAttribute(key, userAttributeCallback);
},
/**
* Removes user attribute if exists.
*
* @param key the attribute key as string
* @see #setUserAttribute(String, String)
*/
removeUserAttribute: function (key) {
if (!key || typeof key !== "string")
throw new TypeError("Invalid param, Expected String");
Instabug.removeUserAttribute(key);
},
/**
* @summary Returns all user attributes.
* @param {userAttributesCallback} userAttributesCallback callback with argument A new dictionary containing all the currently set user attributes,
* or an empty dictionary if no user attributes have been set.
*/
getAllUserAttributes: function (userAttributesCallback) {
Instabug.getAllUserAttributes(userAttributesCallback);
},
/**
* Clears all user attributes if exists.
*/
clearAllUserAttributes: function () {
Instabug.clearAllUserAttributes();
},
setViewHirearchyEnabled: function (viewHirearchyEnabled) {
Instabug.setViewHirearchyEnabled(viewHirearchyEnabled);
},
setSurveysEnabled: function (surveysEnabled) {
Instabug.setSurveysEnabled(surveysEnabled)
},
showSurveysIfAvailable: function () {
Instabug.showSurveysIfAvailable()
},
setWillShowSurveyHandler: function (willShowSurveyHandler) {
if (Platform.OS === 'ios') {
Instabug.addListener('IBGWillShowSurvey');
NativeAppEventEmitter.addListener(
'IBGWillShowSurvey',
willShowSurveyHandler
);
Instabug.setWillShowSurveyHandler(willShowSurveyHandler);
}
},
setDidDismissSurveyHandler: function (didDismissSurveyHandler) {
if (Platform.OS === 'ios') {
Instabug.addListener('IBGDidDismissSurvey');
NativeAppEventEmitter.addListener(
'IBGDidDismissSurvey',
didDismissSurveyHandler
);
Instabug.setDidDismissSurveyHandler(didDismissSurveyHandler);
}
},
/**
* The event used to invoke the feedback form
* @readonly
* @enum {number}
*/
invocationEvent: {
none: Instabug.invocationEventNone,
shake: Instabug.invocationEventShake,
screenshot: Instabug.invocationEventScreenshot,
twoFingersSwipe: Instabug.invocationEventTwoFingersSwipeLeft,
floatingButton: Instabug.invocationEventFloatingButton
},
/**
* Type of SDK dismiss
* @readonly
* @enum {number}
*/
dismissType: {
submit: Instabug.dismissTypeSubmit,
cancel: Instabug.dismissTypeCancel,
addAttachment: Instabug.dismissTypeAddAttachment
},
/**
* Type of report to be submit
* @readonly
* @enum {number}
*/
reportType: {
bug: Instabug.reportTypeBug,
feedback: Instabug.reportTypeFeedback
},
/**
* The mode used upon invocating the SDK
* @readonly
* @enum {number}
*/
invocationMode: {
NA: Instabug.invocationModeNA,
newBug: Instabug.invocationModeNewBug,
newFeedback: Instabug.invocationModeNewFeedback,
newChat: Instabug.invocationModeNewChat,
chatsList: Instabug.invocationModeChatsList
},
/**
* The supported locales
* @readonly
* @enum {number}
*/
locale: {
arabic: Instabug.localeArabic,
chineseSimplified: Instabug.localeChineseSimplified,
chineseTraditional: Instabug.localeChineseTraditional,
czech: Instabug.localeCzech,
danish: Instabug.localeDanish,
english: Instabug.localeEnglish,
french: Instabug.localeFrench,
german: Instabug.localeGerman,
italian: Instabug.localeItalian,
japanese: Instabug.localeJapanese,
polish: Instabug.localePolish,
portugueseBrazil: Instabug.localePortugueseBrazil,
russian: Instabug.localeRussian,
spanish: Instabug.localeSpanish,
swedish: Instabug.localeSwedish,
turkish: Instabug.localeTurkish
},
/**
* The color theme of the different UI elements
* @readonly
* @enum {number}
*/
colorTheme: {
light: Instabug.colorThemeLight,
dark: Instabug.colorThemeDark
},
/**
* Rectangle edges
* @readonly
* @enum {number}
*/
rectEdge: {
minX: Instabug.rectMinXEdge,
minY: Instabug.rectMinYEdge,
maxX: Instabug.rectMaxXEdge,
maxY: Instabug.rectMaxYEdge
},
/**
* Instabug strings
* @readonly
* @enum {number}
*/
strings: {
shakeHint: Instabug.shakeHint,
swipeHint: Instabug.swipeHint,
edgeSwipeStartHint: Instabug.edgeSwipeStartHint,
startAlertText: Instabug.startAlertText,
invalidEmailMessage: Instabug.invalidEmailMessage,
invalidEmailTitle: Instabug.invalidEmailTitle,
invalidCommentMessage: Instabug.invalidCommentMessage,
invalidCommentTitle: Instabug.invalidCommentTitle,
invocationHeader: Instabug.invocationHeader,
talkToUs: Instabug.talkToUs,
reportBug: Instabug.reportBug,
reportFeedback: Instabug.reportFeedback,
emailFieldHint: Instabug.emailFieldHint,
commentFieldHintForBugReport: Instabug.commentFieldHintForBugReport,
commentFieldHintForFeedback: Instabug.commentFieldHintForFeedback,
addVideoMessage: Instabug.addVideoMessage,
addVoiceMessage: Instabug.addVoiceMessage,
addImageFromGallery: Instabug.addImageFromGallery,
addExtraScreenshot: Instabug.addExtraScreenshot,
audioRecordingPermissionDeniedTitle: Instabug.audioRecordingPermissionDeniedTitle,
audioRecordingPermissionDeniedMessage: Instabug.audioRecordingPermissionDeniedMessage,
microphonePermissionAlertSettingsButtonText: Instabug.microphonePermissionAlertSettingsButtonText,
recordingMessageToHoldText: Instabug.recordingMessageToHoldText,
recordingMessageToReleaseText: Instabug.recordingMessageToReleaseText,
conversationsHeaderTitle: Instabug.conversationsHeaderTitle,
screenshotHeaderTitle: Instabug.screenshotHeaderTitle,
chatsNoConversationsHeadlineText: Instabug.chatsNoConversationsHeadlineText,
doneButtonText: Instabug.doneButtonText,
okButtonText: Instabug.okButtonText,
cancelButtonText: Instabug.cancelButtonText,
thankYouText: Instabug.thankYouText,
audio: Instabug.audio,
video: Instabug.video,
image: Instabug.image,
chatsHeaderTitle: Instabug.chatsHeaderTitle,
team: Instabug.team,
messageNotification: Instabug.messageNotification,
messagesNotificationAndOthers: Instabug.messagesNotificationAndOthers,
conversationTextFieldHint: Instabug.conversationTextFieldHint
}
};