@@ -48,6 +48,20 @@ 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+
5165 /**
5266 * Attaches user data to each report being sent.
5367 * Each call to this method overrides the user data to be attached.
@@ -84,7 +98,7 @@ module.exports = {
8498 * Sets a block of code to be executed before sending each report.
8599 * This block is executed in the background before sending each report. Could
86100 * be used for attaching logs and extra data to reports.
87- * @param {function } preSendingHandler - A callback that gets executed before sending each bug
101+ * @param {preSendingHandler } preSendingHandler - A callback that gets executed before sending each bug
88102 * report.
89103 */
90104 setPreSendingHandler : function ( preSendingHandler ) {
@@ -105,7 +119,7 @@ module.exports = {
105119 * Sets a block of code to be executed just before the SDK's UI is presented.
106120 * This block is executed on the UI thread. Could be used for performing any
107121 * UI changes before the SDK's UI is shown.
108- * @param {function } preInvocationHandler - A callback that gets executed before invoking the SDK
122+ * @param {preInvocationHandler } preInvocationHandler - A callback that gets executed before invoking the SDK
109123 */
110124 setPreInvocationHandler : function ( preInvocationHandler ) {
111125 if ( Platform . OS === 'ios' ) {
@@ -124,7 +138,7 @@ module.exports = {
124138 * Sets a block of code to be executed right after the SDK's UI is dismissed.
125139 * This block is executed on the UI thread. Could be used for performing any
126140 * UI changes after the SDK's UI is dismissed.
127- * @param {function } postInvocationHandler - A callback to get executed after
141+ * @param {postInvocationHandler } postInvocationHandler - A callback to get executed after
128142 * dismissing the SDK.
129143 */
130144 setPostInvocationHandler : function ( postInvocationHandler ) {
@@ -376,15 +390,15 @@ module.exports = {
376390
377391 /**
378392 * Sets a block of code that gets executed when a new message is received.
379- * @param {function } onNewMessageHandler - A callback that gets
393+ * @param {onNewMessgaeHandler } onNewMessageHandler - A callback that gets
380394 * executed when a new message is received.
381395 */
382396 setOnNewMessageHandler : function ( onNewMessageHandler ) {
383397 if ( Platform . OS === 'ios' ) {
384398 Instabug . addListener ( 'IBGonNewMessageHandler' ) ;
385399 NativeAppEventEmitter . addListener (
386400 'IBGonNewMessageHandler' ,
387- onNewMessageHandler
401+ onNewMessgaeHandler
388402 ) ;
389403 }
390404
@@ -399,7 +413,7 @@ module.exports = {
399413 * you should call didReceiveRemoteNotification: to let the Instabug handle
400414 * the notification. Otherwise, handle the notification on your own.
401415 * @param {Object } dict Notification's userInfo
402- * @param {function } isInstabugNotificationCallback callback with
416+ * @param {isInstabugNotificationCallback } isInstabugNotificationCallback callback with
403417 * argument isInstabugNotification
404418 */
405419 isInstabugNotification : function ( dict , isInstabugNotificationCallback ) {
@@ -435,7 +449,7 @@ module.exports = {
435449 * feedback.
436450 * Use this method to give users a list of choices of categories their bug report or feedback might be related
437451 * to. Selected category will be shown as a tag on your dashboard.
438- * @param {Array } titles titles to be shown in the list.
452+ * @param {array } titles titles to be shown in the list.
439453 */
440454 setReportCategories : function ( ...titles ) {
441455 if ( Platform . OS == 'ios' ) {
@@ -590,7 +604,7 @@ module.exports = {
590604 * Returns the user attribute associated with a given key.
591605 aKey
592606 * @param {string } key The attribute key as string
593- * @param {function } userAttributeCallback callback with argument as the desired user attribute value
607+ * @param {userAttributeCallback } userAttributeCallback callback with argument as the desired user attribute value
594608 */
595609 getUserAttribute : function ( key , userAttributeCallback ) {
596610 Instabug . getUserAttribute ( key , userAttributeCallback ) ;
@@ -610,7 +624,7 @@ module.exports = {
610624
611625 /**
612626 * @summary Returns all user attributes.
613- * @param {function } userAttributesCallback callback with argument A new dictionary containing all the currently set user attributes,
627+ * @param {userAttributesCallback } userAttributesCallback callback with argument A new dictionary containing all the currently set user attributes,
614628 * or an empty dictionary if no user attributes have been set.
615629 */
616630 getAllUserAttributes : function ( userAttributesCallback ) {
@@ -624,43 +638,18 @@ module.exports = {
624638 Instabug . clearAllUserAttributes ( ) ;
625639 } ,
626640
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- }
641+ setViewHirearchyEnabled : function ( viewHirearchyEnabled ) {
642+ Instabug . setViewHirearchyEnabled ( viewHirearchyEnabled ) ;
635643 } ,
636644
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- */
653649 showSurveysIfAvailable : function ( ) {
654650 Instabug . showSurveysIfAvailable ( )
655651 } ,
656652
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- */
664653 setWillShowSurveyHandler : function ( willShowSurveyHandler ) {
665654 if ( Platform . OS === 'ios' ) {
666655 Instabug . addListener ( 'IBGWillShowSurvey' ) ;
@@ -674,12 +663,6 @@ module.exports = {
674663
675664 } ,
676665
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- */
683666 setDidDismissSurveyHandler : function ( didDismissSurveyHandler ) {
684667 if ( Platform . OS === 'ios' ) {
685668 Instabug . addListener ( 'IBGDidDismissSurvey' ) ;
@@ -708,6 +691,14 @@ module.exports = {
708691 Instabug . setPromptOptionsEnabled ( chat , bug , feedback ) ;
709692 } ,
710693
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+
711702 /**
712703 * The event used to invoke the feedback form
713704 * @readonly
0 commit comments