SDKs

An app sends reports to the Heardfix back office through an SDK. Start with the concepts of the SDKs (app key, endpoint, authentication, kinds, offline queue of the Flutter SDK), then follow the guide of your SDK.

SDK Platforms Package Guide
Flutter iOS, Android Dart heardfix 0.2.0 Flutter guide
Web module Websites Script widget.js, served by the back office Web module guide

Flutter web is not supported yet: the plugin does not build for the web. A website uses the web module. The matrix below covers the Flutter SDK, the web module guide lists its own features.

Support matrix

Feature Flutter iOS Flutter Android
Report a problem, suggest an improvement Yes Yes
Screenshot of the current screen Yes Yes
Photos from the gallery Yes Yes
Edit a photo before sending: crop, hide, draw, text Yes Yes
Shake to report Yes Yes
Offline queue Yes Yes
Technical log and caught errors Yes Yes
Sentry and Crashlytics correlation Yes Yes
French and English texts, other languages from the app Yes Yes
Firebase App Check App Attest, DeviceCheck Play Integrity
Key only authentication, without Firebase Yes Yes
Minimum versions Flutter 3.41, Dart 3.11 Flutter 3.41, Dart 3.11

Writing an SDK guide

Every SDK guide follows the same plan, so a developer who read one finds their way in the next:

  1. Requirements: platforms, minimum versions, what to get from the back office.
  2. Install: the package.
  3. Initialise: App Check, then the SDK, then what wraps the app.
  4. Platform setup: permissions and files per platform.
  5. Entry points: the buttons that open the report form, and the other ways in.
  6. Verify: send a report and see it in the back office.
  7. Troubleshooting: by symptom, with its cause and its fix.
  8. App Store and Play Store: what leaves the device, for the store declarations.
  9. Reference: everything else, feature by feature.

What every SDK shares goes in concepts.md, never in a guide.