|
1 | | -# instabug_flutter |
| 1 | +# Instabug for Flutter |
2 | 2 |
|
3 | | -A new flutter plugin project. |
| 3 | +A Flutter plugin for [Instabug](https://instabug.com/). |
4 | 4 |
|
5 | | -## Getting Started |
| 5 | +⚠️ This plugin is currently under active development and is not ready for production use yet. If you'd like to give us [feedback](https://github.com/Instabug/Instabug-Flutter/issues) or create a [pull request](https://github.com/Instabug/Instabug-Flutter/pulls), we would highly appreciate it! |
6 | 6 |
|
7 | | -This project is a starting point for a Flutter |
8 | | -[plug-in package](https://flutter.io/developing-packages/), |
9 | | -a specialized package that includes platform-specific implementation code for |
10 | | -Android and/or iOS. |
| 7 | +## Available Features |
11 | 8 |
|
12 | | -For help getting started with Flutter, view our |
13 | | -[online documentation](https://flutter.io/docs), which offers tutorials, |
14 | | -samples, guidance on mobile development, and a full API reference. |
| 9 | +| Feature | Status | |
| 10 | +|:----------------:|:------:| |
| 11 | +| Bug Reporting | ⚙️ | |
| 12 | +| Crash Reporting | ❌ | |
| 13 | +| In-App Chat | ❌ | |
| 14 | +| In-App Surveys | ❌ | |
| 15 | +| Feature Requests | ❌ | |
| 16 | + |
| 17 | +* ✅ Stable |
| 18 | +* ⚙️ Under active development |
| 19 | +* ❌ Unavailable |
| 20 | + |
| 21 | +### APIs |
| 22 | + |
| 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 | +| Dart API Method | Android Equivalent | iOS Equivalent | |
| 26 | +|------------|---------------------------------------------------------------------------------|-------------------------------------------------| |
| 27 | +| | `new Instabug.Builder(this, "APP_TOKEN").build()` | `+ [Instabug startWithToken:invocationEvents:]` | |
| 28 | +| | `Instabug.showWelcomeMessage(WelcomeMessage.State state)` | ` + [Instabug showWelcomeMessageWithMode:]` | |
| 29 | +| | `Instabug.identifyUser(String username, String email)` | `+ [Instabug identifyUserWithEmail:name:]` | |
| 30 | +| | `Instabug.logoutUser()` | `+ [Instabug logOut]` | |
| 31 | +| | `Instabug.setLocale(Locale locale)` | `+ [Instabug setLocale:]` | |
| 32 | +| | `Instabug.setColorTheme(InstabugColorTheme theme)` | `+ [Instabug setColorTheme:]` | |
| 33 | +| | `Instabug.addTags(String... tags)` | `+ [Instabug appendTags:]` | |
| 34 | +| | `Instabug.resetTags()` | `+ [Instabug resetTags]` | |
| 35 | +| | `Instabug.getTags()` | `+ [Instabug getTags]` | |
| 36 | +| | `Instabug.setCustomTextPlaceHolders(InstabugCustomTextPlaceHolder placeholder)` | `+ [Instabug setValue:forStringWithKey:]` | |
| 37 | +| | `Instabug.setUserAttribute(String key, String value)` | `+ [Instabug setUserAttribute:withKey:]` | |
| 38 | +| | `Instabug.getUserAttribute(String key)` | `+ [Instabug userAttributeForKey:]` | |
| 39 | +| | `Instabug.removeUserAttribute(String key)` | `+ [Instabug removeUserAttributeForKey:]` | |
| 40 | +| | `Instabug.getAllUserAttributes()` | `+ [Instabug userAttributes:]` | |
| 41 | +| | `Instabug.logUserEvent(String name)` | `+ [Instabug logUserEventWithName:]` | |
| 42 | +| | `BugReporting.invoke()` | `+ [IBGBugReporting invoke]` | |
| 43 | +| | `BugReporting.invoke(InvocationMode mode,@InvocationOption int... options)` | `+ [IBGBugReporting invokeWithMode:options:] | |
| 44 | +| | `InstabugLog.d(String message)` | `+ [IBGLog log:]` | |
| 45 | +| | `InstabugLog.v(String message)` | `+ [IBGLog logVerbose:]` | |
| 46 | +| | `InstabugLog.d(String message)` | `+ [IBGLog logDebug:]` | |
| 47 | +| | `InstabugLog.i(String message)` | `+ [IBGLog logInfo:]` | |
| 48 | +| | `InstabugLog.w(String message)` | `+ [IBGLog logWarn:]` | |
| 49 | +| | `InstabugLog.e(String message)` | `+ [IBGLog logError:]` | |
| 50 | +| | `Instabug.clearLogs()` | `+ [IBGLog clearAllLogs:]` | |
0 commit comments