Skip to content

Commit 43b4e52

Browse files
HeshamMegidHeshamMegid
authored
Updates APIs in README (#48)
1 parent 8c01320 commit 43b4e52

File tree

1 file changed

+78
-35
lines changed

1 file changed

+78
-35
lines changed

‎README.md‎

Lines changed: 78 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ A Flutter plugin for [Instabug](https://instabug.com/).
66

77
## Available Features
88

9-
| Feature | Status |
10-
|:----------------:|:------:|
11-
| [Bug Reporting](https://instabug.com/bug-reporting) | ⚙️ |
12-
| [Crash Reporting](https://instabug.com/crash-reporting) | ❌ |
13-
| [In-App Chat](https://instabug.com/in-app-chat) | ❌ |
14-
| [In-App Surveys](https://instabug.com/in-app-surveys) | ❌ |
9+
| Feature | Status |
10+
|:---------------------------------------------------------:|:-------:|
11+
| [Bug Reporting](https://instabug.com/bug-reporting) | ⚙️ |
12+
| [Crash Reporting](https://instabug.com/crash-reporting) | ❌ |
13+
| [In-App Chat](https://instabug.com/in-app-chat) | ❌ |
14+
| [In-App Surveys](https://instabug.com/in-app-surveys) | ⚙️ |
1515
| [Feature Requests](https://instabug.com/feature-requests) | ❌ |
1616

1717
* ✅ Stable
@@ -20,35 +20,78 @@ A Flutter plugin for [Instabug](https://instabug.com/).
2020

2121
### APIs
2222

23-
The table below contains a list of APIs we're planning to implement for our 1.0 release. We'll add the Dart API methods as we implement them.
24-
25-
26-
27-
| API Method | Native Equivalent (Android/iOS) |
28-
|------------|-----------------------------------------------------------------------------------------------------------------------------------------|
29-
| `Instabug.start(String token, List<InvocationEvent> invocationEvents)` | `new Instabug.Builder(this, "APP_TOKEN").build()`<br>`+ [Instabug startWithToken:invocationEvents:]` |
30-
|`Instabug.showWelcomeMessageWithMode(WelcomeMessageMode welcomeMessageMode)`| `Instabug.showWelcomeMessage(WelcomeMessage.State state)`<br>`+ [Instabug showWelcomeMessageWithMode:]` |
31-
|`Instabug.identifyUserWithEmail(String email, [String name])`| `Instabug.identifyUser(String username, String email)`<br>`+ [Instabug identifyUserWithEmail:name:]` |
32-
|`Instabug.logOut()`| `Instabug.logoutUser()`<br>`+ [Instabug logOut]` |
33-
|`Instabug.setLocale(Locale locale)`| `Instabug.setLocale(Locale locale)`<br>`+ [Instabug setLocale:]` |
34-
|`Instabug.setColorTheme(ColorTheme colorTheme)`| `Instabug.setColorTheme(InstabugColorTheme theme)`<br>`+ [Instabug setColorTheme:]` |
35-
|`Instabug.appendTags(List<String> tags)`| `Instabug.addTags(String... tags)`<br>`+ [Instabug appendTags:]` |
36-
|`Instabug.resetTags()`| `Instabug.resetTags()`<br>`+ [Instabug resetTags]` |
37-
|`Instabug.getTags()`| `Instabug.getTags()`<br>`+ [Instabug getTags]` |
38-
|`Instabug.setStringForKey(String value, String key)`| `Instabug.setCustomTextPlaceHolders(InstabugCustomTextPlaceHolder placeholder)`<br>`+ [Instabug setValue:forStringWithKey:]` |
39-
|`Instabug.setUserAttributeWithKey(String value, String key)`| `Instabug.setUserAttribute(String key, String value)`<br>`+ [Instabug setUserAttribute:withKey:]` |
40-
|`Instabug.getUserAttributeForKey(Sring Key)`| `Instabug.getUserAttribute(String key)`<br>`+ [Instabug userAttributeForKey:]` |
41-
|`Instabug.removeUserAttributeForKey(String key)`| `Instabug.removeUserAttribute(String key)`<br>`+ [Instabug removeUserAttributeForKey:]` |
42-
|`Instabug.getUserAttributes()`| `Instabug.getAllUserAttributes()`<br>`+ [Instabug userAttributes:]` |
43-
|`Instabug.logUserEventWithName(String name)`| `Instabug.logUserEvent(String name)`<br>`+ [Instabug logUserEventWithName:]` |
44-
|`Instabug.show()`| `Instabug.show()`<br>`+ [Instabug show]` |
45-
|`Instabug.invokeWithMode(InvocationMode invocationMode, [List<InvocationOption> invocationOptions])`| `BugReporting.invoke(InvocationMode mode, @InvocationOption int... options)`<br>`+ [IBGBugReporting invokeWithMode:options:]` |
46-
|`Instabug.logDebug(String message)`| `InstabugLog.d(String message)`<br>`+ [IBGLog logDebug:]` |
47-
|`Instabug.logVerbose(String message)`| `InstabugLog.v(String message)`<br>`+ [IBGLog logVerbose:]` |
48-
|`Instabug.logInfo(String message)`| `InstabugLog.i(String message)`<br>`+ [IBGLog logInfo:]` |
49-
|`Instabug.logWarn(String message)`| `InstabugLog.w(String message)`<br>`+ [IBGLog logWarn:]` |
50-
|`Instabug.logError(String message)`| `InstabugLog.e(String message)`<br>`+ [IBGLog logError:]` |
51-
|`Instabug.clearAllLogs(String message)`| `Instabug.clearLogs()`<br>`+ [IBGLog clearAllLogs:]` |
23+
The section below contains the APIs we're planning to implement for our 1.0 release across different classes. We'll add the Dart API methods as we implement them.
24+
25+
#### `Instabug`
26+
27+
| API Method | Native Equivalent (Android/iOS) |
28+
|----------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------|
29+
| `start(String token, List<InvocationEvent> invocationEvents)` | `new Instabug.Builder(this, "APP_TOKEN").build()`<br>`+ startWithToken:invocationEvents:` |
30+
| `showWelcomeMessageWithMode(WelcomeMessageMode welcomeMessageMode)` | `showWelcomeMessage(WelcomeMessage.State state)`<br>`+ showWelcomeMessageWithMode:` |
31+
| `identifyUserWithEmail(String email, [String name])` | `identifyUser(String username, String email)`<br>`+ identifyUserWithEmail:name:` |
32+
| `logOut()` | `logoutUser()`<br>`+ logOut` |
33+
| `setLocale(Locale locale)` | `setLocale(Locale locale)`<br>`+ setLocale:` |
34+
| `setColorTheme(ColorTheme colorTheme)` | `setColorTheme(InstabugColorTheme theme)`<br>`+ setColorTheme:` |
35+
| `appendTags(List<String> tags)` | `addTags(String... tags)`<br>`+ appendTags:` |
36+
| `resetTags()` | `resetTags()`<br>`+ resetTags` |
37+
| `getTags()` | `getTags()`<br>`+ getTags` |
38+
| `setStringForKey(String value, String key)` | `setCustomTextPlaceHolders(InstabugCustomTextPlaceHolder placeholder)`<br>`+ setValue:forStringWithKey:` |
39+
| `setUserAttributeWithKey(String value, String key)` | `setUserAttribute(String key, String value)`<br>`+ setUserAttribute:withKey:` |
40+
| `getUserAttributeForKey(Sring Key)` | `getUserAttribute(String key)`<br>`+ userAttributeForKey:` |
41+
| `removeUserAttributeForKey(String key)` | `removeUserAttribute(String key)`<br>`+ removeUserAttributeForKey:` |
42+
| `getUserAttributes()` | `getAllUserAttributes()`<br>`+ userAttributes:` |
43+
| `logUserEventWithName(String name)` | `logUserEvent(String name)`<br>`+ logUserEventWithName:` |
44+
| `show()` | `show()`<br>`+ show` |
45+
| | `setSessionProfilerState(Feature.State state)`<br>`sessionProfilerEnabled` |
46+
| | `setPrimaryColor(@ColorInt int primaryColorValue)`<br>`tintColor` |
47+
| | `onReportSubmitHandler(Report.OnReportCreatedListener listener)`<br>`willSendReportHandler`. |
48+
| | `setUserData(String userData)`<br>`userData` |
49+
| | `show()`<br>`+ show` |
50+
| | `addFileAttachment(Uri fileUri, String fileNameWithExtension)`<br>`+ addFileAttachmentWithURL:` |
51+
| | `addFileAttachment(byte[] data, String fileNameWithExtension)` `+ addFileAttachmentWithData:` |
52+
| | `clearFileAttachment()`<br>`+ clearFileAttachments` |
53+
| | `setWelcomeMessageState(WelcomeMessage.State welcomeMessageState)`<br>`welcomeMessageMode` |
54+
55+
#### `BugReporting`
56+
57+
| API Method | Native Equivalent (Android/iOS) |
58+
|---------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|
59+
| `invokeWithMode(InvocationMode invocationMode, [List<InvocationOption> invocationOptions])` | `invoke(InvocationMode mode, @InvocationOption int... options)`<br>`+ invokeWithMode:options:` |
60+
| | `setState(Feature.State state)`<br>`enabled` |
61+
| | `setOnInvokeCallback(OnInvokeCallback onInvokeCallback)`<br>`willInvokeHandler` |
62+
| | `setOnDismissCallback(OnSdkDismissCallback onSdkDismissedCallback)`<br>`didDismissHandler` |
63+
| | `setInvocationEvents(InstabugInvocationEvent... invocationEvents)`<br>`invocationEvents` |
64+
| | `setAttachmentTypesEnabled(boolean initial, boolean extra, boolean gallery, boolean recording)`<br>`enabledAttachmentTypes` |
65+
| | `setReportTypes(@BugReporting.ReportType int... types)`<br>`promptOptionsEnabledReportTypes` |
66+
| | `setExtendedBugReportState(ExtendedBugReport.State state)`<br>`extendedBugReportMode` |
67+
| | `setOptions(@Option int... options)`<br>`bugReportingOptions`
68+
| | `show(@BugReporting.ReportType int type)`<br>`+ showWithReportType:options:`
69+
70+
#### `InstabugLog`
71+
72+
| API Method | Native Equivalent (Android/iOS) |
73+
|-----------------------------------------------|--------------------------------------------------------------|
74+
| `logDebug(String message)` | `d(String message)`<br>`+ logDebug:` |
75+
| `logVerbose(String message)` | `v(String message)`<br>`+ logVerbose:` |
76+
| `logInfo(String message)` | `i(String message)`<br>`+ logInfo:` |
77+
| `logWarn(String message)` | `w(String message)`<br>`+ logWarn:` |
78+
| `logError(String message)` | `e(String message)`<br>`+ logError:` |
79+
| `clearAllLogs(String message)` | `clearLogs()`<br>`+ clearAllLogs:` |
80+
81+
#### `Surveys`
82+
83+
| API Method | Native Equivalent (Android/iOS) |
84+
|-----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|
85+
| | `setState(Feature.State state)`<br>`enabled` |
86+
| | `setAutoShowingEnabled(boolean isAutoShowingEnabled)`<br>`autoShowingEnabled` |
87+
| | `getAvailableSurveys()`<br>`+ availableSurveys` |
88+
| | `setOnShowCallback(OnShowCallback onShowCallback)`<br>`willShowSurveyHandler` |
89+
| | `setOnDismissCallback(OnDismissCallback onDismissCallback)`<br>`didDismissSurveyHandler` |
90+
| | `setShouldShowWelcomeScreen(boolean shouldShow)`<br>`shouldShowWelcomeScreen` |
91+
| | `showSurveyIfAvailable()`<br>`+ showSurveyIfAvailable` |
92+
| | `showSurvey(String token)`<br>`+ showSurveyWithToken:` |
93+
| | `setThresholdForReshowingSurveyAfterDismiss(int sessionsCount, int daysCount)`<br>`+ setThresholdForReshowingSurveyAfterDismiss:daysCount:` |
94+
| | `hasRespondToSurvey(String token)`<br>`+ hasRespondedToSurveyWithToken:` |
5295

5396
## Integration
5497

0 commit comments

Comments
 (0)