https://github.com/fullstorydev/fullstory-flutter

Fullstory for Flutter mobile apps. Fullstory provides insightful analytics and near-magical session replay for web and mobile apps.
https://github.com/fullstorydev/fullstory-flutter

Last synced: 3 months ago
JSON representation

Fullstory for Flutter mobile apps. Fullstory provides insightful analytics and near-magical session replay for web and mobile apps.

• Host: GitHub
• URL: https://github.com/fullstorydev/fullstory-flutter
• Owner: fullstorydev
• License: apache-2.0
• Created: 2024-09-19T20:56:43.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-01-10T20:20:33.000Z (over 1 year ago)
• Last Synced: 2025-01-10T20:33:31.406Z (over 1 year ago)
• Language: Dart
• Homepage: https://pub.dev/packages/fullstory_flutter
• Size: 3.77 MB
• Stars: 1
• Watchers: 4
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Fullstory Flutter Package

[![.github/workflows/ci.yml](https://github.com/fullstorydev/fullstory-flutter/actions/workflows/ci.yml/badge.svg)](https://github.com/fullstorydev/fullstory-flutter/actions/workflows/ci.yml)

Fullstory's Flutter package exposes access to the Fullstory Native Mobile SDK from within a Flutter app. This plug-in is intended to be used in conjunction with [Fullstory for Mobile Apps](https://www.fullstory.com/mobile-apps/).

⚠️ This is a preview release, some breaking changes are possible before the 1.0.0 release.

## Quick Links

- [Getting Started guide](https://help.fullstory.com/hc/en-us/articles/27461129353239)

- [Usage examples](https://github.com/fullstorydev/fullstory-flutter/tree/main/example/lib)

- [Fullstory API](https://developer.fullstory.com/mobile/flutter/)

- [Email us](mailto:mobile-support@fullstory.com)

## What's supported

Most non-visual Fullstory APIs are supported:

- `FS.event(String name, [Map properties = const {}])`

- `FS.page(String pageName, {Map? properties})` → `FSPage`

- `FS.log({FSLogLevel level = FSLogLevel.info, required String message})`

- `FS.identify(String uid, [Map? userVars])`

- `FS.setUserVars(Map userVars)`

- `FS.anonymize()`

- `FS.shutdown()`

- `FS.restart()`

- `FS.setStatusListener(FSStatusListener? listener)`

- `FS.currentSession` → `Future`

- `FS.currentSessionURL({bool now = false})` → `Future`

- `FS.fsVersion` → `Future`

- `FS.resetIdleTimer()`

- `FS.consent({bool consented})`

- `FS.networkEvent({String url, String method, int? statusCode, int? durationMs, int? requestSize, int? responseSize})`

- `FS.crashEvent({String name, Object? exception, StackTrace? stackTrace,})`

- `FS.captureErrors({void Function(Object? exception, StackTrace? stack)? errorHandler})`

Additionally, interceptors are available to autocapture network requests with

popular libraries using `FSInterceptor`, and page navigation can be captured

with `FSNavigatorObserver`.

Visual session replay is not currently supported, but is planned for a future release.

## Getting Started

See [Getting started with Fullstory for Flutter Mobile Apps](https://help.fullstory.com/hc/en-us/articles/27461129353239)

Also see our [example app](https://github.com/fullstorydev/fullstory-flutter/tree/main/example) for working API usage examples.