@@ -48,20 +48,6 @@ module.exports = {
4848 Instabug . dismiss ( ) ;
4949 } ,
5050
51- /**
52- * Attaches a file to each report being sent.
53- * A new copy of the file at fileLocation will be attached with each bug
54- * report being sent.
55- * Each call to this method overrides the file to be attached.
56- * The file has to be available locally at the provided path.
57- * @param {string } fileLocation Path to a file that's going to be attached
58- * to each report.
59- */
60- // Not yet tested
61- setFileAttachment : function ( fileLocation ) {
62- Instabug . setFileAttachment ( fileLocation ) ;
63- } ,
64-
6551 /**
6652 * Attaches user data to each report being sent.
6753 * Each call to this method overrides the user data to be attached.
@@ -98,7 +84,7 @@ module.exports = {
9884 * Sets a block of code to be executed before sending each report.
9985 * This block is executed in the background before sending each report. Could
10086 * be used for attaching logs and extra data to reports.
101- * @param {preSendingHandler } preSendingHandler - A callback that gets executed before sending each bug
87+ * @param {function } preSendingHandler - A callback that gets executed before sending each bug
10288 * report.
10389 */
10490 setPreSendingHandler : function ( preSendingHandler ) {
@@ -119,7 +105,7 @@ module.exports = {
119105 * Sets a block of code to be executed just before the SDK's UI is presented.
120106 * This block is executed on the UI thread. Could be used for performing any
121107 * UI changes before the SDK's UI is shown.
122- * @param {preInvocationHandler } preInvocationHandler - A callback that gets executed before invoking the SDK
108+ * @param {function } preInvocationHandler - A callback that gets executed before invoking the SDK
123109 */
124110 setPreInvocationHandler : function ( preInvocationHandler ) {
125111 if ( Platform . OS === 'ios' ) {
@@ -138,7 +124,7 @@ module.exports = {
138124 * Sets a block of code to be executed right after the SDK's UI is dismissed.
139125 * This block is executed on the UI thread. Could be used for performing any
140126 * UI changes after the SDK's UI is dismissed.
141- * @param {postInvocationHandler } postInvocationHandler - A callback to get executed after
127+ * @param {function } postInvocationHandler - A callback to get executed after
142128 * dismissing the SDK.
143129 */
144130 setPostInvocationHandler : function ( postInvocationHandler ) {
@@ -390,15 +376,15 @@ module.exports = {
390376
391377 /**
392378 * Sets a block of code that gets executed when a new message is received.
393- * @param {onNewMessgaeHandler } onNewMessageHandler - A callback that gets
379+ * @param {function } onNewMessageHandler - A callback that gets
394380 * executed when a new message is received.
395381 */
396382 setOnNewMessageHandler : function ( onNewMessageHandler ) {
397383 if ( Platform . OS === 'ios' ) {
398384 Instabug . addListener ( 'IBGonNewMessageHandler' ) ;
399385 NativeAppEventEmitter . addListener (
400386 'IBGonNewMessageHandler' ,
401- onNewMessgaeHandler
387+ onNewMessageHandler
402388 ) ;
403389 }
404390
@@ -413,7 +399,7 @@ module.exports = {
413399 * you should call didReceiveRemoteNotification: to let the Instabug handle
414400 * the notification. Otherwise, handle the notification on your own.
415401 * @param {Object } dict Notification's userInfo
416- * @param {isInstabugNotificationCallback } isInstabugNotificationCallback callback with
402+ * @param {function } isInstabugNotificationCallback callback with
417403 * argument isInstabugNotification
418404 */
419405 isInstabugNotification : function ( dict , isInstabugNotificationCallback ) {
@@ -449,7 +435,7 @@ module.exports = {
449435 * feedback.
450436 * Use this method to give users a list of choices of categories their bug report or feedback might be related
451437 * to. Selected category will be shown as a tag on your dashboard.
452- * @param {array } titles titles to be shown in the list.
438+ * @param {Array } titles titles to be shown in the list.
453439 */
454440 setReportCategories : function ( ...titles ) {
455441 if ( Platform . OS == 'ios' ) {
@@ -604,7 +590,7 @@ module.exports = {
604590 * Returns the user attribute associated with a given key.
605591 aKey
606592 * @param {string } key The attribute key as string
607- * @param {userAttributeCallback } userAttributeCallback callback with argument as the desired user attribute value
593+ * @param {function } userAttributeCallback callback with argument as the desired user attribute value
608594 */
609595 getUserAttribute : function ( key , userAttributeCallback ) {
610596 Instabug . getUserAttribute ( key , userAttributeCallback ) ;
@@ -624,7 +610,7 @@ module.exports = {
624610
625611 /**
626612 * @summary Returns all user attributes.
627- * @param {userAttributesCallback } userAttributesCallback callback with argument A new dictionary containing all the currently set user attributes,
613+ * @param {function } userAttributesCallback callback with argument A new dictionary containing all the currently set user attributes,
628614 * or an empty dictionary if no user attributes have been set.
629615 */
630616 getAllUserAttributes : function ( userAttributesCallback ) {
@@ -638,18 +624,43 @@ module.exports = {
638624 Instabug . clearAllUserAttributes ( ) ;
639625 } ,
640626
641- setViewHirearchyEnabled : function ( viewHirearchyEnabled ) {
642- Instabug . setViewHirearchyEnabled ( viewHirearchyEnabled ) ;
627+ /**
628+ * @summary Enables/disables inspect view hierarchy when reporting a bug/feedback.
629+ * @param {boolean } viewHierarchyEnabled A boolean to set whether view hierarchy are enabled or disabled.
630+ */
631+ setViewHierarchyEnabled : function ( viewHierarchyEnabled ) {
632+ if ( Platform . OS === 'ios' ) {
633+ Instabug . setViewHierarchyEnabled ( viewHierarchyEnabled ) ;
634+ }
643635 } ,
644636
637+ /**
638+ * @summary Sets whether surveys are enabled or not.
639+ * If you disable surveys on the SDK but still have active surveys on your Instabug dashboard,
640+ * those surveys are still going to be sent to the device, but are not going to be shown automatically.
641+ * To manually display any available surveys, call `Instabug.showSurveyIfAvailable()`.
642+ * Defaults to `true`.
643+ * @param {boolean } surveysEnabled A boolean to set whether Instabug Surveys is enabled or disabled.
644+ */
645645 setSurveysEnabled : function ( surveysEnabled ) {
646646 Instabug . setSurveysEnabled ( surveysEnabled )
647647 } ,
648648
649+ /**
650+ * @summary Shows one of the surveys that were not shown before, that also have conditions that match the current device/user.
651+ * Does nothing if there are no available surveys or if a survey has already been shown in the current session.
652+ */
649653 showSurveysIfAvailable : function ( ) {
650654 Instabug . showSurveysIfAvailable ( )
651655 } ,
652656
657+ /**
658+ * @summary Sets a block of code to be executed just before the survey's UI is presented.
659+ * This block is executed on the UI thread. Could be used for performing any UI changes before
660+ * the survey's UI is shown.
661+ * @param {function } willShowSurveyHandler - A block of code that gets executed before presenting the survey's UI.
662+ * report.
663+ */
653664 setWillShowSurveyHandler : function ( willShowSurveyHandler ) {
654665 if ( Platform . OS === 'ios' ) {
655666 Instabug . addListener ( 'IBGWillShowSurvey' ) ;
@@ -663,6 +674,12 @@ module.exports = {
663674
664675 } ,
665676
677+ /**
678+ * @summary Sets a block of code to be executed right after the survey's UI is dismissed.
679+ * This block is executed on the UI thread. Could be used for performing any UI changes after the survey's UI
680+ * is dismissed.
681+ * @param {function } didDismissSurveyHandler - A block of code that gets executed after the survey's UI is dismissed.
682+ */
666683 setDidDismissSurveyHandler : function ( didDismissSurveyHandler ) {
667684 if ( Platform . OS === 'ios' ) {
668685 Instabug . addListener ( 'IBGDidDismissSurvey' ) ;
@@ -691,14 +708,6 @@ module.exports = {
691708 Instabug . setPromptOptionsEnabled ( chat , bug , feedback ) ;
692709 } ,
693710
694- /**
695- * Clears all Uris of the attached files.
696- * The URIs which added via {@link Instabug#addFileAttachment} API not the physical files.
697- */
698- clearFileAttachment : function ( ) {
699- Instabug . clearFileAttachment ( ) ;
700- } ,
701-
702711 /**
703712 * The event used to invoke the feedback form
704713 * @readonly
0 commit comments