@@ -64,7 +64,7 @@ module.exports = {
64
64
* @param {string } fileLocation Path to a file that's going to be attached
65
65
* to each report.
66
66
*/
67
- // Not yet testsed
67
+ // Not yet tested
68
68
setFileAttachment : function ( fileLocation ) {
69
69
Instabug . setFileAttachment ( fileLocation ) ;
70
70
} ,
@@ -124,14 +124,14 @@ module.exports = {
124
124
125
125
/**
126
126
* Sets a block of code to be executed just before the SDK's UI is presented.
127
- * This block is executed on the UI thread. Could be used for performing any
127
+ * This block is executed on the UI thread. Could be used for performing any
128
128
* UI changes before the SDK's UI is shown.
129
- * @callback preSendingHandler
129
+ * @callback preSendingHandler
130
130
*/
131
131
132
132
/**
133
133
* Sets a block of code to be executed just before the SDK's UI is presented.
134
- * This block is executed on the UI thread. Could be used for performing any
134
+ * This block is executed on the UI thread. Could be used for performing any
135
135
* UI changes before the SDK's UI is shown.
136
136
* @param {preInvocationHandler } preInvocationHandler - A callback that gets executed before invoking the SDK
137
137
*/
@@ -147,10 +147,10 @@ module.exports = {
147
147
148
148
/**
149
149
* A callback that gets executed after the SDK's UI is dismissed.
150
- * @callback postInvocationHandler
150
+ * @callback postInvocationHandler
151
151
* @param {dismissType } dismissType How the SDK was dismissed.
152
- * @param {reportType } reportType Type of report that has been sent. Will be set
153
- * to IBGReportTypeBug in case the SDK has been dismissed without selecting a
152
+ * @param {reportType } reportType Type of report that has been sent. Will be set
153
+ * to IBGReportTypeBug in case the SDK has been dismissed without selecting a
154
154
* report type, so you might need to check issueState before reportType
155
155
*/
156
156
@@ -161,7 +161,7 @@ module.exports = {
161
161
* @param {postInvocationHandler } postInvocationHandler - A callback to get executed after
162
162
* dismissing the SDK.
163
163
*/
164
- setPostInvocatioHandler : function ( postInvocationHandler ) {
164
+ setPostInvocationHandler : function ( postInvocationHandler ) {
165
165
Instabug . addListener ( 'IBGpostInvocationHandler' ) ;
166
166
NativeAppEventEmitter . addListener (
167
167
'IBGpostInvocationHandler' ,
@@ -170,7 +170,7 @@ module.exports = {
170
170
}
171
171
) ;
172
172
173
- Instabug . setPostInvocatioHandler ( postInvocationHandler ) ;
173
+ Instabug . setPostInvocationHandler ( postInvocationHandler ) ;
174
174
} ,
175
175
176
176
/**
@@ -204,26 +204,26 @@ module.exports = {
204
204
* Enables/disables screenshot view when reporting a bug/improvement.
205
205
* By default, screenshot view is shown when reporting a bug, but not when
206
206
* sending feedback.
207
- * @param {boolean } willSkipeScreenshotAnnotation sets whether screenshot view is
207
+ * @param {boolean } willSkipScreenshotAnnotation sets whether screenshot view is
208
208
* shown or not. Passing YES will show screenshot view for both feedback and
209
209
* bug reporting, while passing NO will disable it for both.
210
210
*/
211
- setWillSkipScreenshotAnnotation : function ( willSkipeScreenshotAnnotation ) {
212
- Instabug . setWillSkipScreenshotAnnotation ( willSkipeScreenshotAnnotation ) ;
211
+ setWillSkipScreenshotAnnotation : function ( willSkipScreenshotAnnotation ) {
212
+ Instabug . setWillSkipScreenshotAnnotation ( willSkipScreenshotAnnotation ) ;
213
213
} ,
214
214
215
215
/**
216
216
* return callback
217
217
* @callback messageCountCallback
218
- * @param {number } responseCount Notifications count, or -1 incase the SDK has
218
+ * @param {number } responseCount Notifications count, or -1 incase the SDK has
219
219
* not been initialized.
220
220
*/
221
221
222
222
/**
223
223
* Returns the number of unread messages the user currently has.
224
224
* Use this method to get the number of unread messages the user
225
225
* has, then possibly notify them about it with your own UI.
226
- * @param {messageCountCallback } messageCountCallback callback with argument
226
+ * @param {messageCountCallback } messageCountCallback callback with argument
227
227
* Notifications count, or -1 incase the SDK has not been initialized.
228
228
*/
229
229
getUnreadMessagesCount : function ( messageCountCallback ) {
@@ -233,7 +233,7 @@ module.exports = {
233
233
/**
234
234
* Sets the event that invoke the feedback form.
235
235
* Default is set by `Instabug.startWithToken`.
236
- * @param {invocattionEvent } invocationEvent Event that invokes the
236
+ * @param {invocationEvent } invocationEvent Event that invokes the
237
237
* feedback form.
238
238
*/
239
239
setInvocationEvent : function ( invocationEvent ) {
@@ -278,8 +278,8 @@ module.exports = {
278
278
* @param {number } iPhoneShakingThreshold Threshold for iPhone.
279
279
* @param {number } iPadShakingThreshold Threshold for iPad.
280
280
*/
281
- setShakingThresholdForiPhone : function ( iphoneThreshold , ipadThreshold ) {
282
- Instabug . setShakingThresholdForiPhone ( iphoneThreshold , ipadThreshold ) ;
281
+ setShakingThresholdForIPhone : function ( iPhoneShakingThreshold , iPadShakingThreshold ) {
282
+ Instabug . setShakingThresholdForIPhone ( iPhoneShakingThreshold , iPadShakingThreshold ) ;
283
283
} ,
284
284
285
285
/**
@@ -289,7 +289,7 @@ module.exports = {
289
289
* Default for `floatingButtonOffsetFromTop` is 50
290
290
* @param {rectEdge } floatingButtonEdge `maxX` to show on the right,
291
291
* or `minX` to show on the left.
292
- * @param {numnber } offsetFromTop floatingButtonOffsetFromTop Top offset for
292
+ * @param {number } offsetFromTop floatingButtonOffsetFromTop Top offset for
293
293
* floating button.
294
294
*/
295
295
setFloatingButtonEdge : function ( floatingButtonEdge , offsetFromTop ) {
@@ -321,11 +321,11 @@ module.exports = {
321
321
Instabug . setIntroMessageEnabled ( isIntroMessageEnabled ) ;
322
322
} ,
323
323
324
- /**
325
- * Sets the color theme of the SDK's whole UI.
326
- * @param {colorTheme) colorTheme An `colorTheme` to set
327
- * the SDK's UI to.
328
- */
324
+ /**
325
+ * Sets the color theme of the SDK's whole UI.
326
+ * the SDK's UI to.
327
+ * @param colorTheme
328
+ */
329
329
setColorTheme : function ( colorTheme ) {
330
330
Instabug . setColorTheme ( colorTheme ) ;
331
331
} ,
@@ -335,7 +335,7 @@ module.exports = {
335
335
* Sets the color of UI elements indicating interactivity or call to action.
336
336
* To use, import processColor and pass to it with argument the color hex
337
337
* as argument.
338
- * @param {color } color A color to set the UI elements of the SDK to.
338
+ * @param {color } primaryColor A color to set the UI elements of the SDK to.
339
339
*/
340
340
setPrimaryColor : function ( primaryColor ) {
341
341
Instabug . setPrimaryColor ( primaryColor ) ;
@@ -383,8 +383,8 @@ module.exports = {
383
383
384
384
/**
385
385
* Sets whether attachments in bug reporting and in-app messaging are enabled or not.
386
- * @param {boolean } screenShot A boolean to enable or disable screenshot attachments.
387
- * @param {boolean } extraScreenShot A boolean to enable or disable extra
386
+ * @param {boolean } screenshot A boolean to enable or disable screenshot attachments.
387
+ * @param {boolean } extraScreenshot A boolean to enable or disable extra
388
388
* screenshot attachments.
389
389
* @param {boolean } galleryImage A boolean to enable or disable gallery image
390
390
* attachments. In iOS 10+,NSPhotoLibraryUsageDescription should be set in
@@ -415,10 +415,10 @@ module.exports = {
415
415
416
416
/**
417
417
* Sets a block of code that gets executed when a new message is received.
418
- * @param {onNewMessgaeHandler } onNewMessgaeHandler - A callback that gets
418
+ * @param {onNewMessgaeHandler } onNewMessageHandler - A callback that gets
419
419
* executed when a new message is received.
420
420
*/
421
- setOnNewMessageHandler : function ( onNewMessgaeHandler ) {
421
+ setOnNewMessageHandler : function ( onNewMessageHandler ) {
422
422
Instabug . addListener ( 'IBGonNewMessageHandler' ) ;
423
423
NativeAppEventEmitter . addListener (
424
424
'IBGonNewMessageHandler' ,
@@ -433,11 +433,11 @@ module.exports = {
433
433
* When only a single option is enabled, it become the default invocation mode.
434
434
* If all options are disabled, bug reporting becomes the default invocation mode.
435
435
* By default, all three options are enabled.
436
- * @param {boolean } bugReportEnabled A boolean to indicate whether bug reports
436
+ * @param {boolean } isBugReportingEnabled A boolean to indicate whether bug reports
437
437
* are enabled or disabled.
438
- * @param {boolean } feedbackEnabled A boolean to indicate whether feedback is
438
+ * @param {boolean } isFeedbackReportingEnabled A boolean to indicate whether feedback is
439
439
* enabled or disabled.
440
- * @param {boolean } chatEnabled A boolean to indicate whether chat is enabled
440
+ * @param {boolean } isChatEnabled A boolean to indicate whether chat is enabled
441
441
* or disabled.
442
442
*/
443
443
setPromptOptions : function ( isBugReportingEnabled , isFeedbackReportingEnabled , isChatEnabled ) {
@@ -447,7 +447,7 @@ module.exports = {
447
447
/**
448
448
* return callback
449
449
* @callback isInstabugNotificationCallback
450
- * @param {boolean } isInstabugNotification
450
+ * @param {boolean } isInstabugNotification
451
451
*/
452
452
453
453
/**
@@ -539,7 +539,7 @@ module.exports = {
539
539
light : Instabug . colorThemeLight ,
540
540
dark : Instabug . colorThemeDark
541
541
} ,
542
- /**
542
+ /**
543
543
* Rectangle edges
544
544
* @readonly
545
545
* @enum {number}
@@ -593,6 +593,6 @@ module.exports = {
593
593
chatsHeaderTitle : Instabug . chatsHeaderTitle ,
594
594
team : Instabug . team ,
595
595
messageNotification : Instabug . messageNotification ,
596
- messagesNotifiactionAndOthers : Instabug . messagesNotifiactionAndOthers
596
+ messagesNotificationAndOthers : Instabug . messagesNotificationAndOthers
597
597
}
598
598
}
0 commit comments