edits for documentation

README.md

@@ -44,7 +44,7 @@ import Instabug from'instabug-reactnative';
 class testApp extends Component {
   constructor() {
     super();
-    Instabug.startWithToken('YOUR_TOKEN', Instabug.constants.invocationEvent.floatingButton);
+    Instabug.startWithToken('YOUR_TOKEN', Instabug.invocationEvent.floatingButton);
   }
   ...
 }

index.js

@@ -8,16 +8,20 @@ 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 {constants.invocationEvent} invocationEvent The event that invokes
+	 * @param {invocationEvent} invocationEvent The event that invokes
 	 * the SDK's UI.
 	 */
 	startWithToken: function(token, invocationEvent) {
@@ -37,7 +41,7 @@ module.exports = {
 	* 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 {constants.invocationMode} invocationMode Specifies which mode the
+	* @param {invocationMode} invocationMode Specifies which mode the
 	* SDK is going to start with.
 	*/
 	invokeWithInvocationMode: function(invocationMode) {
@@ -80,7 +84,6 @@ module.exports = {
 	* Adds custom logs that will be sent with each report.
 	* @param {string} log Message to be logged.
 	*/
-	// Needs renaming
 	IBGLog: function(log) {
 		Instabug.IBGLog(log);
 	},
@@ -93,64 +96,81 @@ module.exports = {
 	* @param {boolean} isUserStepsEnabled A boolean to set user steps tracking
 	* to being enabled or disabled.
 	*/
-	// Not working
 	setUserStepsEnabled: function(isUserStepsEnabled) {
 		Instabug.setUserStepsEnabled(isUserStepsEnabled);
 	},
 
+	/**
+	* A callback that gets executed before sending each bug report.
+	* @callback preSendingHandler
+	*/
+
 	/**
 	* 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.
-	* @callback handler - A callback that gets executed before sending each bug
+	* @param {preSendingHandler} preSendingHandler - A callback that gets executed before sending each bug
 	* report.
 	*/
-	setPreSendingHandler: function(handler) {
+	setPreSendingHandler: function(preSendingHandler) {
 		Instabug.addListener('IBGpreSendingHandler');
 		NativeAppEventEmitter.addListener(
 			'IBGpreSendingHandler',
-			handler
+			preSendingHandler
 		);
 
-		Instabug.setPreSendingHandler(handler);
+		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.
-	* @callback handler - A callback that gets executed before sending each bug report.
+	* @callback preSendingHandler 
 	*/
-	setPreInvocationHandler: function(handler) {
+
+	/**
+	* 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) {
 		Instabug.addListener('IBGpreInvocationHandler');
 		NativeAppEventEmitter.addListener(
 			'IBGpreInvocationHandler',
-			handler
+			preInvocationHandler
 		);
 
-		Instabug.setPreInvocationHandler(handler);
+		Instabug.setPreInvocationHandler(preInvocationHandler);
 	},
 
+	/**
+	* A callback that gets executed after the SDK's UI is dismissed.
+	* @callback postInvocationHandler 
+	* @param {dismissType} dismissType How the SDK was dismissed.
+	* @param {reportType} reportType Type of report that has been sent. Will be set 
+	* to IBGReportTypeBug in case the SDK has been dismissed without selecting a 
+	* report type, so you might need to check issueState before reportType
+	*/
+
 	/**
 	* 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.
-	* @callback handler - A callback that gets executed after the SDK's UI is dismissed.
+	* @param {postInvocationHandler} postInvocationHandler - A callback to get executed after
-	* @param {constants.dismissType} dismissType How the SDK was dismissed.
+	* dismissing the SDK.
-	* @param {constants.reportType} reportType Type of report that has been sent. Will be set 
-	* to IBGReportTypeBug in case the SDK has been dismissed without selecting a 
-	* report type, so you might need to check issueState before reportType
 	*/
-	setPostInvocatioHandler: function(handler) {
+	setPostInvocatioHandler: function(postInvocationHandler) {
 		Instabug.addListener('IBGpostInvocationHandler');
 		NativeAppEventEmitter.addListener(
 			'IBGpostInvocationHandler',
 			function(payload) {
-				handler(payload['dismissType'], payload['reportType']);
+				postInvocationHandler(payload['dismissType'], payload['reportType']);
 			}
 		);
 
-		Instabug.setPostInvocatioHandler(handler);
+		Instabug.setPostInvocatioHandler(postInvocationHandler);
 	},
 
 	/**
@@ -188,27 +208,32 @@ module.exports = {
 	* shown or not. Passing YES will show screenshot view for both feedback and
 	* bug reporting, while passing NO will disable it for both.
 	*/
-	// Doesn't work on existing SDK
 	setWillSkipScreenshotAnnotation: function(willSkipeScreenshotAnnotation) {
 		Instabug.setWillSkipScreenshotAnnotation(willSkipeScreenshotAnnotation);
 	},
 
+	/**
+	* return callback
+	* @callback messageCountCallback
+	* @param{number} responseCount Notifications count, or -1 incase the SDK has 
+	* not been initialized.
+	*/
+
 	/**
 	* 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.
-	* @callback responseCallback
+	* @param {messageCountCallback} messageCountCallback callback with argument 
-	* @param {number} responseCount Notifications count, or -1 incase the SDK has 
+	* Notifications count, or -1 incase the SDK has not been initialized.
-	* not been initialized.
 	*/
-	getUnreadMessagesCount: function(responseCallBack) {
+	getUnreadMessagesCount: function(messageCountCallback) {
-		Instabug.getUnreadMessagesCount(responseCallBack);
+		Instabug.getUnreadMessagesCount(messageCountCallback);
 	},
 
 	/**
 	* Sets the event that invoke the feedback form.
 	* Default is set by `Instabug.startWithToken`.
-	* @param {constants.invocattionEvent} invocationEvent Event that invokes the
+	* @param {invocattionEvent} invocationEvent Event that invokes the
 	* feedback form.
 	*/
 	setInvocationEvent: function(invocationEvent) {
@@ -221,7 +246,6 @@ module.exports = {
 	* @param {boolean} isPushNotificationEnabled A boolean to indicate whether push
 	* notifications are enabled or disabled.
 	*/
-	// Not tested
 	setPushNotificationsEnabled: function(isPushNotificationEnabled) {
 		Instabug.setPushNotificationsEnabled(isPushNotificationEnabled);
 	},
@@ -261,9 +285,9 @@ module.exports = {
 	/**
 	* 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 `constants.rectEdge.maxX`.
+	* Default for `floatingButtonEdge` is `rectEdge.maxX`.
  	* Default for `floatingButtonOffsetFromTop` is 50
- 	* @param {constants.rectEdge} floatingButtonEdge `maxX` to show on the right,
+ 	* @param {rectEdge} floatingButtonEdge `maxX` to show on the right,
  	* or `minX` to show on the left.
  	* @param {numnber} offsetFromTop floatingButtonOffsetFromTop Top offset for
  	* floating button.
@@ -276,7 +300,7 @@ module.exports = {
 	* Sets the SDK's locale.
 	* Use to change the SDK's UI to different language.
 	* Defaults to the device's current locale.
-	* @param {constants.locale} locale A locale to set the SDK to.
+	* @param {locale} locale A locale to set the SDK to.
 	*/
 	setLocale: function(locale) {
 		Instabug.setLocale(locale);
@@ -295,7 +319,7 @@ module.exports = {
 
 	/**
 	* Sets the color theme of the SDK's whole UI.
-	* @param {contants.colorTheme) colorTheme An `constants.colorTheme` to set
+	* @param {colorTheme) colorTheme An `colorTheme` to set
 	* the SDK's UI to.
 	 */
 	setColorTheme: function(colorTheme) {
@@ -322,9 +346,6 @@ module.exports = {
 		Instabug.appendTags(tags);
 	},
 
-	// TODO: research this: vvvv
-	// + (void)setScreenshotCapturingHandler:(UIImage *(^)())screenshotCapturingHandler;
-
 	/**
 	* Manually removes all tags of reported feedback, bug or crash.
 	*/
@@ -333,19 +354,24 @@ module.exports = {
 	},
 
 	/**
-	* Gets all tags of reported feedback, bug or crash.
+	* return callback
-	* @callback responseCallback
+	* @callback tagsCallback
 	* @param {string[]} tags of reported feedback, bug or crash.
 	*/
-	getTags: function(responseCallBack) {
+
-		Instabug.getTags(responseCallBack);
+	/**
+	* 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 {constants.strings} key Key of string to override.
+	* @param {strings} key Key of string to override.
 	*/
 	setStringToKey: function(string, key) {
 		Instabug.setString(string, key);
@@ -364,7 +390,6 @@ module.exports = {
  	* voiceNote attachments.
  	* @param {boolean} screenRecording A boolean to enable or disable screen recording attachments.
 	*/
-	// TODO: investigate doing it in more like JS pattern
 	setAttachmentTypesEnabled: function(screenshot, extraScreenshot, galleryImage, voiceNote, screenRecording) {
 		Instabug.setAttachmentTypesEnabled(screenshot, extraScreenshot, galleryImage, voiceNote, screenRecording);
 	},
@@ -375,24 +400,28 @@ module.exports = {
 	* @param {boolean} isChatNotificationEnabled A boolean to set whether
 	* notifications are enabled or disabled.
 	*/
-	// Not tested
 	setChatNotificationEnabled: function(isChatNotificationEnabled) {
 		Instabug.setChatNotificationEnabled(isChatNotificationEnabled);
 	},
 
 	/**
-	* Sets a block of code that gets executed when a new message is received.
+	* A callback that gets executed when a new message is received.
-	* @callback handler - A callback that gets executed when a new message
+	* @callback onNewMessgaeHandler
-	* is received.
 	*/
-	setOnNewMessageHandler: function(handler) {
+
+	/**
+	* Sets a block of code that gets executed when a new message is received.
+	* @param {onNewMessgaeHandler} onNewMessgaeHandler - A callback that gets 
+	* executed when a new message is received.
+	*/
+	setOnNewMessageHandler: function(onNewMessgaeHandler) {
 		Instabug.addListener('IBGonNewMessageHandler');
 		NativeAppEventEmitter.addListener(
 			'IBGonNewMessageHandler',
-			handler
+			onNewMessgaeHandler
 		);
 
-		Instabug.setOnNewMessageHandler(handler);
+		Instabug.setOnNewMessageHandler(onNewMessgaeHandler);
 	},
 
 	/**
@@ -411,6 +440,12 @@ module.exports = {
 		Instabug.setPromptOptions(isBugReportingEnabled, isFeedbackReportingEnabled, isChatEnabled);
 	},
 
+	/**
+	* return callback
+	* @callback isInstabugNotificationCallback
+ 	* @param {boolean} isInstabugNotification 
+	*/
+
 	/**
 	* Checks if a notification is from Instabug.
 	* If you are using push notifications, use this method to check whether an
@@ -418,130 +453,142 @@ module.exports = {
 	* you should call didReceiveRemoteNotification: to let the Instabug handle
  	* the notification. Otherwise, handle the notification on your own.
  	* @param {Object} dict Notification's userInfo
- 	* @callback responseCallback
+ 	* @param {isInstabugNotificationCallback} isInstabugNotificationCallback callback with
- 	* @param {boolean} isInstabugNotification 
+ 	* argument isInstabugNotification
 	*/
-	// Not tested 
+	isInstabugNotification: function(dict, isInstabugNotificationCallback) {
-	isInstabugNotification: function(dict, responseCallback) {
+		Instabug.isInstabugNotification(dict, isInstabugNotificationCallback);
-		Instabug.isInstabugNotification(dict, responseCallback);
 	},
 
-	constants: {
+	/**
-		/**
+	 * The event used to invoke the feedback form
-		 *  The event used to invoke the feedback form
+	 * @readonly
-		 */
+ 	 * @enum {number}
-		invocationEvent: {
+	 */
-			none: Instabug.invocationEventNone,
+	invocationEvent: {
-			shake: Instabug.invocationEventShake,
+		none: Instabug.invocationEventNone,
-			screenshot: Instabug.invocationEventScreenshot,
+		shake: Instabug.invocationEventShake,
-			twoFingersSwipe: Instabug.invocationEventTwoFingersSwipe,
+		screenshot: Instabug.invocationEventScreenshot,
-			rightEdgePan: Instabug.invocationEventRightEdgePan,
+		twoFingersSwipe: Instabug.invocationEventTwoFingersSwipe,
-			floatingButton: Instabug.invocationEventFloatingButton
+		floatingButton: Instabug.invocationEventFloatingButton
-		},
+	},
-		/**
+	/**
-		 *  Type of SDK dismiss
+	 * Type of SDK dismiss
-		 */
+	 * @readonly
-		dismissType: {
+ 	 * @enum {number}
-			submit: Instabug.dismissTypeSubmit,
+	 */
-			cancel: Instabug.dismissTypeCancel,
+	dismissType: {
-			addAttachment: Instabug.dismissTypeAddAttachment
+		submit: Instabug.dismissTypeSubmit,
-		},
+		cancel: Instabug.dismissTypeCancel,
-		/**
+		addAttachment: Instabug.dismissTypeAddAttachment
-		 *  Type of report to be submit
+	},
-		 */
+	/**
-		reportType: {
+	 * Type of report to be submit
-			bug: Instabug.reportTypeBug,
+	 * @readonly
-			feedback: Instabug.reportTypeFeedback
+ 	 * @enum {number}
-		},
+	 */
-		/**
+	reportType: {
-		 *  The mode used upon invocating the SDK
+		bug: Instabug.reportTypeBug,
-		 */
+		feedback: Instabug.reportTypeFeedback
-		invocationMode: {
+	},
-			NA: Instabug.invocationModeNA,
+	/**
-			newBug: Instabug.invocationModeNewBug,
+	 *  The mode used upon invocating the SDK
-			newFeedback: Instabug.invocationModeNewFeedback,
+	 * @readonly
-			newChat: Instabug.invocationModeNewChat,
+ 	 * @enum {number}
-			chatsList: Instabug.invocationModeChatsList
+	 */
-		},
+	invocationMode: {
-		/**
+		NA: Instabug.invocationModeNA,
-		 *  The supported locales
+		newBug: Instabug.invocationModeNewBug,
-		 */
+		newFeedback: Instabug.invocationModeNewFeedback,
-		locale: {
+		newChat: Instabug.invocationModeNewChat,
-			arabic: Instabug.localeArabic,
+		chatsList: Instabug.invocationModeChatsList
-			chineseSimplified: Instabug.localeChineseSimplified,
+	},
-			chineseTraditional: Instabug.localeChineseTraditional,
+	/**
-			czech: Instabug.localeCzech,
+	 * The supported locales
-			danish: Instabug.localeDanish,
+	 * @readonly
-			english: Instabug.localeEnglish,
+ 	 * @enum {number}
-			french: Instabug.localeFrench,
+	 */
-			german: Instabug.localeGerman,
+	locale: {
-			italian: Instabug.localeItalian,
+		arabic: Instabug.localeArabic,
-			japanese: Instabug.localeJapanese,
+		chineseSimplified: Instabug.localeChineseSimplified,
-			polish: Instabug.localePolish,
+		chineseTraditional: Instabug.localeChineseTraditional,
-			portugueseBrazil: Instabug.localePortugueseBrazil,
+		czech: Instabug.localeCzech,
-			russian: Instabug.localeRussian,
+		danish: Instabug.localeDanish,
-			spanish: Instabug.localeSpanish,
+		english: Instabug.localeEnglish,
-			swedish: Instabug.localeSwedish,
+		french: Instabug.localeFrench,
-			turkish: Instabug.localeTurkish
+		german: Instabug.localeGerman,
-		},
+		italian: Instabug.localeItalian,
-		/**
+		japanese: Instabug.localeJapanese,
-		 *  The color theme of the different UI elements
+		polish: Instabug.localePolish,
-		 */
+		portugueseBrazil: Instabug.localePortugueseBrazil,
-		colorTheme: {
+		russian: Instabug.localeRussian,
-			light: Instabug.colorThemeLight,
+		spanish: Instabug.localeSpanish,
-			dark: Instabug.colorThemeDark
+		swedish: Instabug.localeSwedish,
-		},
+		turkish: Instabug.localeTurkish
-		/** 
+	},
-		*   Rectangle edges
+	/**
-		*/
+	 * The color theme of the different UI elements
-		rectEdge: {
+	 * @readonly
-			minX: Instabug.rectMinXEdge,
+ 	 * @enum {number}
-			minY: Instabug.rectMinYEdge,
+	 */
-			maxX: Instabug.rectMaxXEdge,
+	colorTheme: {
-			maxY: Instabug.rectMaxYEdge
+		light: Instabug.colorThemeLight,
-		},
+		dark: Instabug.colorThemeDark
-		/**
+	},
-		 *  Instabug strings
+	/** 
-		 */
+	* Rectangle edges
-		strings: {
+	* @readonly
-			shakeHint: Instabug.shakeHint,
+ 	* @enum {number}
-			swipeHint: Instabug.swipeHint,
+	*/
-			edgeSwipeStartHint: Instabug.edgeSwipeStartHint,
+	rectEdge: {
-			startAlertText: Instabug.startAlertText,
+		minX: Instabug.rectMinXEdge,
-			invalidEmailMessage: Instabug.invalidEmailMessage,
+		minY: Instabug.rectMinYEdge,
-			invalidEmailTitle: Instabug.invalidEmailTitle,
+		maxX: Instabug.rectMaxXEdge,
-			invalidCommentMessage: Instabug.invalidCommentMessage,
+		maxY: Instabug.rectMaxYEdge
-			invalidCommentTitle: Instabug.invalidCommentTitle,
+	},
-			invocationHeader: Instabug.invocationHeader,
+	/**
-			talkToUs: Instabug.talkToUs,
+	 * Instabug strings
-			reportBug: Instabug.reportBug,
+	 * @readonly
-			reportFeedback: Instabug.reportFeedback,
+ 	 * @enum {number}
-			emailFieldHint: Instabug.emailFieldHint,
+	 */
-			commentFieldHintForBugReport: Instabug.commentFieldHintForBugReport,
+	strings: {
-			commentFieldHintForFeedback: Instabug.commentFieldHintForFeedback,
+		shakeHint: Instabug.shakeHint,
-			addVideoMessage: Instabug.addVideoMessage,
+		swipeHint: Instabug.swipeHint,
-			addVoiceMessage: Instabug.addVoiceMessage,
+		edgeSwipeStartHint: Instabug.edgeSwipeStartHint,
-			addImageFromGallery: Instabug.addImageFromGallery,
+		startAlertText: Instabug.startAlertText,
-			addExtraScreenshot: Instabug.addExtraScreenshot,
+		invalidEmailMessage: Instabug.invalidEmailMessage,
-			audioRecordingPermissionDeniedTitle: Instabug.audioRecordingPermissionDeniedTitle,
+		invalidEmailTitle: Instabug.invalidEmailTitle,
-			audioRecordingPermissionDeniedMessage: Instabug.audioRecordingPermissionDeniedMessage,
+		invalidCommentMessage: Instabug.invalidCommentMessage,
-			microphonePermissionAlertSettingsButtonText: Instabug.microphonePermissionAlertSettingsButtonText,
+		invalidCommentTitle: Instabug.invalidCommentTitle,
-			recordingMessageToHoldText: Instabug.recordingMessageToHoldText,
+		invocationHeader: Instabug.invocationHeader,
-			recordingMessageToReleaseText: Instabug.recordingMessageToReleaseText,
+		talkToUs: Instabug.talkToUs,
-			conversationsHeaderTitle: Instabug.conversationsHeaderTitle,
+		reportBug: Instabug.reportBug,
-			screenshotHeaderTitle: Instabug.screenshotHeaderTitle,
+		reportFeedback: Instabug.reportFeedback,
-			chatsNoConversationsHeadlineText: Instabug.chatsNoConversationsHeadlineText,
+		emailFieldHint: Instabug.emailFieldHint,
-			doneButtonText: Instabug.doneButtonText,
+		commentFieldHintForBugReport: Instabug.commentFieldHintForBugReport,
-			okButtonText: Instabug.okButtonText,
+		commentFieldHintForFeedback: Instabug.commentFieldHintForFeedback,
-			cancelButtonText: Instabug.cancelButtonText,
+		addVideoMessage: Instabug.addVideoMessage,
-			thankYouText: Instabug.thankYouText,
+		addVoiceMessage: Instabug.addVoiceMessage,
-			audio: Instabug.audio,
+		addImageFromGallery: Instabug.addImageFromGallery,
-			video: Instabug.video,
+		addExtraScreenshot: Instabug.addExtraScreenshot,
-			image: Instabug.image,
+		audioRecordingPermissionDeniedTitle: Instabug.audioRecordingPermissionDeniedTitle,
-			chatsHeaderTitle: Instabug.chatsHeaderTitle,
+		audioRecordingPermissionDeniedMessage: Instabug.audioRecordingPermissionDeniedMessage,
-			team: Instabug.team,
+		microphonePermissionAlertSettingsButtonText: Instabug.microphonePermissionAlertSettingsButtonText,
-			messageNotification: Instabug.messageNotification,
+		recordingMessageToHoldText: Instabug.recordingMessageToHoldText,
-			messagesNotifiactionAndOthers: Instabug.messagesNotifiactionAndOthers
+		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,
+		messagesNotifiactionAndOthers: Instabug.messagesNotifiactionAndOthers
 	}
 }