feeddo_flutter 0.0.5

Feeddo Flutter SDK - AI-powered customer support and feedback widget for Flutter apps

Feeddo Flutter SDK

AI-powered customer support and feedback widget for Flutter applications. Automatically collects device information and manages end users.

Features

✅ End User Management: Create and update end users with comprehensive information
✅ Automatic Device Info: Auto-collects platform, device model, OS version, app version
✅ Backend User ID Management: User IDs generated and managed by Feeddo backend
✅ Data Persistence: All user data saved to SharedPreferences automatically
✅ Custom Attributes: Store custom key-value pairs for user segmentation
✅ In-App Notifications: Instagram-style notifications for unread messages
✅ Real-time Updates: WebSocket-based message notifications
✅ Cross-Platform: Works on iOS, Android, Web, macOS, Windows, Linux
✅ Type Safe: Full TypeScript-like type safety with Dart
✅ Geo Detection: Country and locale automatically detected from IP address by backend

Installation

Add this to your package's pubspec.yaml file:

dependencies:
  feeddo_flutter: ^0.0.1

Then run:

flutter pub get

Quick Start

1. Initialize Feeddo

import 'package:feeddo_flutter/feeddo_flutter.dart';

// Initialize Feeddo - notifications are automatically handled!
final result = await Feeddo.init(
  apiKey: 'your-api-key',
  context: context, // Optional: pass context to enable notifications
  userName: 'John Doe',
  email: '[e-mail]',
  isInAppNotificationOn: true, // Default is true - automatically shows notifications
  theme: FeeddoTheme.dark(),
);

// That's it! Notifications will automatically show for:
// - Unread messages on init
// - New messages from WebSocket

2. Initialize Without Notifications

// If you don't want notifications, just omit the context
final result = await Feeddo.init(
  apiKey: 'your-api-key',
  userName: 'John Doe',
  email: '[e-mail]',
);

3. Open Support Widget

// Open Feeddo support screen
Feeddo.show(context, theme: FeeddoTheme.dark());

4. Clean Up (Optional)

// When user logs out
Feeddo.dispose();

In-App Notifications

Feeddo includes Instagram-style in-app notifications that work automatically!

Simple Setup:

final result = await Feeddo.init(
  apiKey: 'your-key',
  context: context, // Just pass context!
  isInAppNotificationOn: true, // That's all you need!
);

Features:

• 🎨 Beautiful slide-in notification banners
• 📬 Automatically shows unread messages on init
• ⚡ Automatically shows new WebSocket messages
• 🎯 Tap to open conversation
• ⏱️ Auto-dismiss after 5 seconds
• 🎨 Dark/light theme support
• 🚀 Zero configuration required!

📖 Read the full Notification Guide →
⚡ Quick Reference →

API Reference

FeeddoClient

Main client for interacting with Feeddo services.

Constructor

FeeddoClient({
  required String appId,        // Your Feeddo app ID
  String apiUrl = 'https://api.feeddo.dev',  // API base URL
})

Methods

initializeUser()

Initialize or update a user session. Automatically collects device information and manages user ID via SharedPreferences.

Future<String> initializeUser({
  String? externalUserId,                  // Your system's user ID
  String? userName,                        // User's display name
  String? email,                          // User's email
  String? userSegment,                    // Custom user segment
  String? subscriptionStatus,             // Subscription status
  Map<String, dynamic>? customAttributes, // Custom data
})

Returns: User ID (String)

Behavior:

• First call: Creates new user, backend generates ID, saves to SharedPreferences
• Subsequent calls: Loads ID from SharedPreferences, updates user data
• User ID is automatically managed - no need to store it yourself

Example:

// First call - creates user
final userId = await feeddo.initializeUser(
  externalUserId: 'user-456',
  userName: 'Jane Doe',
  email: '[e-mail]',
);

// Later - updates user (reuses stored ID)
await feeddo.initializeUser(
  externalUserId: 'user-456',
  userName: 'Jane Smith',  // Updated
);

clearUser()

Clear the current user session and remove from SharedPreferences.

Future<void> clearUser()

Throws: StateError if no user is initialized

Example:

await feeddo.clearUser();
print('User session cleared');

Automatically Collected Information

The SDK automatically collects device information:

Field	Description	Example
platform	Platform type	ios, android, web, desktop
deviceModel	Device model	iPhone 14, Pixel 7, macOS MacBookPro
osVersion	OS version	iOS 17.0, Android 13 (SDK 33)
appVersion	Your app version	1.2.3

Note: country and locale are automatically detected by the backend from the user's IP address, so you don't need to collect them manually.

Complete Example

import 'package:flutter/material.dart';
import 'package:feeddo_flutter/feeddo_flutter.dart';

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  late final FeeddoClient _feeddo;

  @override
  void initState() {
    super.initState();
    
    // Initialize Feeddo
    _feeddo = FeeddoClient(appId: 'your-app-id');
    
    // Initialize user
    _initializeUser();
  }

  Future<void> _initializeUser() async {
    try {
      final userId = await _feeddo.initializeUser(
        externalUserId: 'user-123',
        userName: 'John Doe',
        email: '[e-mail]',
        subscriptionStatus: 'free',
        customAttributes: {
          'signupDate': DateTime.now().toIso8601String(),
        },
      );
      print('User initialized: $userId');
    } on FeeddoApiException catch (e) {
      print('Failed to initialize user: ${e.message}');
    }
  }

  @override
  void dispose() {
    _feeddo.dispose();
    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('My App')),
        body: Center(child: Text('Hello Feeddo!')),
      ),
    );
  }
}

Best Practices

1. Initialize Early

Initialize the user as early as possible in your app lifecycle.

2. Persist User ID

Store the user ID locally for subsequent app launches using SharedPreferences or similar.

3. Update on Profile Changes

Update user info when they modify their profile.

4. Handle Errors Gracefully

Always handle API errors with try-catch blocks.

5. Custom Attributes for Segmentation

Use custom attributes for user segmentation and analytics.

File Structure

feeddo_flutter/
├── lib/
│   ├── feeddo_flutter.dart              # Main entry point
│   └── src/
│       ├── feeddo_client.dart           # Main client class
│       ├── models/
│       │   └── end_user.dart            # EndUser model
│       ├── services/
│       │   └── api_service.dart         # API service
│       └── utils/
│           └── device_info_helper.dart  # Device info helper
├── example/
│   └── lib/
│       └── main.dart                    # Example app
└── README.md

Platform Support

Platform	Supported	Auto Device Info
iOS	✅ Yes	✅ Yes
Android	✅ Yes	✅ Yes
Web	✅ Yes	✅ Yes
macOS	✅ Yes	✅ Yes
Windows	✅ Yes	✅ Yes
Linux	✅ Yes	✅ Yes

Dependencies

• http: ^1.2.0 - HTTP client
• device_info_plus: ^10.1.0 - Device information
• package_info_plus: ^8.0.0 - Package/app information

License

See LICENSE file.

Support

For issues and questions, visit feeddo.dev