Skip to content

Commit 66fcde5

Browse files
Update public APIs in readme file
1 parent 97b43b0 commit 66fcde5

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@ The invocation event can be specified as one of the following values:
3535

3636
| value | native equivalent | description | iOS only? |
3737
|:------------:|:-------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------:|
38-
| 'shake' | IBGInvocationEventShake | Shaking the device while in any screen to show the feedback form. | |
39-
| 'button' | IBGInvocationEventFloatingButton | Shows a floating button on top of all views, when pressed it takes a screenshot. | |
40-
| 'screenshot' | IBGInvocationEventScreenshot | Taking a screenshot using the Home+Lock buttons while in any screen to show the feedback form, substituted with IBGInvocationEventShake on iOS 6.1.3 and earlier. ||
41-
| 'swipe' | IBGInvocationEventTwoFingersSwipeLeft | Swiping two fingers left while in any screen to show the feedback form. ||
42-
| 'none' | IBGInvocationEventNone | No event will be registered to show the feedback form, you'll need to code your own and call the method invoke. | |
38+
| 'shake' | InstabugInvocationEvent.SHAKE | Shaking the device while in any screen to show the feedback form. | |
39+
| 'button' | InstabugInvocationEvent.FLOATING_BUTTON | Shows a floating button on top of all views, when pressed it takes a screenshot. | |
40+
| 'screenshot' | InstabugInvocationEvent.SCREENSHOT_GESTURE | Taking a screenshot using the Home+Lock buttons while in any screen to show the feedback form, substituted with IBGInvocationEventShake on iOS 6.1.3 and earlier. ||
41+
| 'swipe' | InstabugInvocationEvent.TWO_FINGER_SWIPE_LEFT | Swiping two fingers left while in any screen to show the feedback form. ||
42+
| 'none' | InstabugInvocationEvent.NONE | No event will be registered to show the feedback form, you'll need to code your own and call the method invoke. | |
4343
Like the token, the value itself can be provided, or you can give an object with values according to platforms using the same syntax as above.
4444

4545
The final parameter to the activate method (besides success and error callback functions) is an optional object containing properties to set a variety of configurations. None of these configurations are required. See the table below for their specifications.
@@ -107,7 +107,7 @@ After you've initialized Instabug, you can call a variety of other methods on th
107107
| addFile* | Uploads file along upcoming reports | Path to desired file on device - can't use path of file relative to your application files. Can be specified as a string or an object with properties by platform. |||
108108
| addLog* | 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 clearLog(). Note: logs passed to this method are NOT printed to Logcat. | any string |||
109109
| clearLog | Clears Instabug internal log | none || |
110-
| changeInvocationEvent | Changes the event used to invoke Instabug SDK | 'shake', 'button', 'screenshot', 'swipe', 'pan', or 'none' (see first table on page) |||
110+
| changeInvocationEvent | Changes the event used to invoke Instabug SDK | 'shake', 'button', 'screenshot', 'swipe', or 'none' (see first table on page) |||
111111
| disable | Disables all Instabug functionality | none || |
112112
| enable | Enables all Instabug functionality | none || |
113113
| isEnabled | Returns true if Instabug is enabled, false if it's disabled | none || |

0 commit comments

Comments
 (0)