Octopus SDK Flutter #

A Flutter plugin for integrating Octopus Community into your Flutter applications.

📖 Official Documentation: https://doc.octopuscommunity.com/

Note: This Flutter SDK is based on the official Octopus Community SDKs. For detailed information about Octopus features, authentication methods, and integration concepts, please refer to the official documentation. Some features of the native SDKs are not yet available.

Features #

• 🎨 Theme Customization: Colors, font sizes, and logos
• 📱 Cross-Platform: iOS and Android support
• 🖼️ Flexible UI: Embedded widget
• 🔧 Easy Integration: Simple API with comprehensive documentation
• 👤 User Management: Connect, disconnect, and manage user sessions and profile information
• 🎯 Complete SDK Lifecycle: Initialize, authenticate, display UI, and cleanup
• 🔔 Notification Badge: Reactive stream of unseen notification count
• 🧪 A/B Testing: Community access gating with reactive streams
• 🔗 URL Interception: Intercept and handle URLs tapped inside the community UI
• 🌍 Locale Override: Override the SDK UI language programmatically
• 📊 SDK Events: Typed event stream for analytics (content, interactions, navigation, gamification, etc.)

Installation #

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

dependencies:
  octopus_sdk_flutter: ^1.9.0

Then run:

flutter pub get

Testing the Example Project #

To test the example project, run the example app and follow the integration examples provided in the /example folder. You will need a sandbox community, an API Key and an SSO jwt secret.

Platform-Specific Configuration #

Android Configuration #

1. Update android/app/build.gradle

android {
    compileSdk 34
    
    defaultConfig {
        minSdkVersion 21
        targetSdkVersion 34
    }
    
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

2. Update MainActivity.kt

Important: You must update your android/app/src/main/kotlin/your/package/name/MainActivity.kt file to extend FlutterFragmentActivity instead of FlutterActivity:

package com.yourpackage.yourapp

import io.flutter.embedding.android.FlutterFragmentActivity

class MainActivity : FlutterFragmentActivity()

This is required for the Octopus SDK to work properly with the embedded widget functionality.

3. Add Internet Permission

In android/app/src/main/AndroidManifest.xml:

<manifest xmlns:android="http://schemas.android.com/apk/res/android">
    <uses-permission android:name="android.permission.INTERNET" />
    
    <application>
        <!-- Your existing configuration -->
    </application>
</manifest>

iOS Configuration #

1. Update ios/Podfile

# Minimum iOS version
platform :ios, '14.0'

# CocoaPods configuration
post_install do |installer|
  installer.pods_project.targets.each do |target|
    flutter_additional_ios_build_settings(target)
    
    # Required for Octopus SDK
    target.build_configurations.each do |config|
      config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '14.0'
      config.build_settings['ENABLE_USER_SCRIPT_SANDBOXING'] = 'NO'
    end
  end
end

2. Update ios/Runner/Info.plist

Add network permissions for API calls:

<dict>
    <!-- Your existing configuration -->
    
    <!-- Allow arbitrary loads for development -->
    <key>NSAppTransportSecurity</key>
    <dict>
        <key>NSAllowsArbitraryLoads</key>
        <true/>
    </dict>
</dict>

⚠️ gRPC-Swift / gRPC-Core naming conflict

If you depend on gRPC-Core, you may hit a naming conflict at build time because both pods resolve to gRPC. To fix:

1. Copy gRPC-Swift.podspec.json from the native SDK repo into your project ios/ folder.
2. In ios/Podfile, add: pod 'gRPC-Swift', :podspec => 'gRPC-Swift.podspec.json'.

Core SDK Functions #

The Octopus SDK Flutter provides four main functions to manage the complete lifecycle:

1. Initialize SDK #

Set up the SDK with your API key

2. Connect User #

Authenticate and connect a user to the Octopus Community

3. Show Octopus UI #

Display the Octopus Community interface (embedded)

4. Disconnect User #

Log out the current user and clean up the session

Quick Start Guide #

Step 1: Basic Setup #

import 'package:octopus_sdk_flutter/octopus_sdk_flutter.dart';

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

class _MyAppState extends State<MyApp> {
  final octopus = OctopusSDK();
  bool isInitialized = false;
  bool isUserConnected = false;
}

Step 2: Initialize SDK #

// Initialize SDK
await octopus.initialize(
  apiKey: 'your_api_key',
  appManagedFields: [], // Optional: e.g. [ProfileField.nickname, ProfileField.picture, ProfileField.bio]
);

Step 3 (optional): Connect User #

⚠️ Note: For security reasons, the jwt has to be generated on your backend. Never leave the sso secret inside your app code/build!

// Connect User
await octopus.connectUser(
  userId: 'unique_user_id',
  token: 'your_jwt_token_here', // Replace with actual token from your backend
  nickname: 'John Doe',              // Optional
  bio: 'Flutter developer',          // Optional  
  picture: 'https://example.com/avatar.jpg' // Optional: URL or base64
);

Step 4: Show Octopus UI #

Once the SDK is initialized, you can display the Octopus Community interface.

// Show Octopus UI - Embedded Widget
Container(
  width: double.infinity,
  height: 400,
  child: OctopusHomeScreen(
    navBarTitle: 'Embedded Community',
    navBarPrimaryColor: true,  // Use primary color for nav bar background
    theme: OctopusTheme(
      primaryMain: Colors.purple,
      fontSizeTitle1: 24,
      fontSizeBody1: 16,
    ),
    // see sample app in /example for examples on how to use the callback features
    onNavigateToLogin: () {
      // Handle navigation to login
      print('Navigate to login');
    },
    onModifyUser: (fieldToEdit) {
      // Handle user profile modification
      print('Modify user field: $fieldToEdit');
    },
  ),
)

Step 5: Disconnect User #

// Disconnect User 
await octopus.disconnectUser();

Complete Example #

Here's a complete working example that demonstrates all functions:

import 'package:flutter/material.dart';

import 'main_embedded.dart';
import 'main_modal.dart';
import 'package:octopus_sdk_flutter/octopus_sdk_flutter.dart';

void main() {
  runApp(const MainApp());
}

class MainApp extends StatelessWidget {
  const MainApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Octopus SDK - Embedded Mode',
      home: const MyApp(),
    );
  }
}

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  final octopus = OctopusSDK();
  bool isInitialized = false;
  bool isUserConnected = false;
  String status = 'Not initialized';
  
  @override
  void initState() {
    super.initState();
    initializeSDK();
  }
  
  // Initialize SDK
  Future<void> initializeSDK() async {
    setState(() => status = 'Initializing...');
    
    try {
      await octopus.initialize(
        apiKey: 'your_api_key',
        appManagedFields: [ProfileField.nickname, ProfileField.picture],
      );
      
      setState(() {
        isInitialized = true;
        status = 'SDK initialized - Ready to connect user';
      });
    } catch (e) {
      setState(() => status = 'Initialization error: $e');
    }
  }
  
  // Connect User
  Future<void> connectUser() async {
    setState(() => status = 'Connecting user...');
    
    try {
      final token = 'your_jwt_token_here'; // Replace with actual token from your backend
      
      await octopus.connectUser(
        userId: 'user123',
        token: token,
        nickname: 'John Doe'
      );
      
      setState(() {
        isUserConnected = true;
        status = 'User connected - Ready to show UI';
      });
    } catch (e) {
      setState(() => status = 'Connection error: $e');
    }
  }
  
  // Show UI
  Future<void> showOctopusUI() async {
    octopus.showOctopusHomeScreen(
      context,
      navBarTitle: 'Community',
      navBarPrimaryColor: true,
      theme: OctopusTheme(
        primaryMain: Colors.blue,
        fontSizeTitle1: 26,
      ),
    onNavigateToLogin: () {
      print('Navigate to login');
      // After user completes login, call octopus.connectUser() with the user's credentials
    },
      onModifyUser: (fieldToEdit) {
        print('Modify user field: $fieldToEdit');
      },
    );
  }
  
  // Disconnect User
  Future<void> disconnectUser() async {
    await octopus.disconnectUser();
    setState(() {
      isUserConnected = false;
      status = 'User disconnected';
    });
  }
  
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text('Octopus SDK Demo')),
      body: Padding(
        padding: EdgeInsets.all(16),
        child: Column(
          crossAxisAlignment: CrossAxisAlignment.stretch,
          children: [
            Text('Status: $status'),
            SizedBox(height: 20),
            
            ElevatedButton(
              onPressed: isInitialized && !isUserConnected ? connectUser : null,
              child: Text('2. Connect User'),
            ),
            
            ElevatedButton(
              onPressed: isUserConnected ? showOctopusUI : null,
              child: Text('3. Show Octopus UI'),
            ),
            
            ElevatedButton(
              onPressed: isUserConnected ? disconnectUser : null,
              child: Text('4. Disconnect User'),
            ),
          ],
        ),
      ),
    );
  }
}

Theme Customization #

The OctopusTheme class allows complete customization of the Octopus Community interface:

Colors #

final theme = OctopusTheme(
  primaryMain: Color(0xFF6200EA),           // Main brand color
  primaryLowContrast: Color(0x336200EA),   // Low contrast variant
  primaryHighContrast: Colors.white,       // High contrast variant
  onPrimary: Colors.white,                 // Content color on primary
);

Font Sizes #

final theme = OctopusTheme(
  fontSizeTitle1: 26,    // Main titles (default: 26)
  fontSizeTitle2: 20,    // Secondary titles (default: 20)
  fontSizeBody1: 17,     // Main body text (default: 17)
  fontSizeBody2: 14,     // Secondary body text (default: 14)
  fontSizeCaption1: 12,  // Main captions (default: 12)
  fontSizeCaption2: 10,  // Secondary captions (default: 10)
);

Custom Logo #

final theme = OctopusTheme(
  logoBase64: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...', // Full base64
  // or
  logoBase64: 'iVBORw0KGgoAAAANSUhEUgAA...', // Base64 without prefix
);

Complete Theme Example #

final customTheme = OctopusTheme(
  // Brand colors
  primaryMain: const Color(0xFF1976D2),
  primaryLowContrast: const Color(0xFF1976D2).withOpacity(0.12),
  primaryHighContrast: Colors.white,
  onPrimary: Colors.white,
  
  // Typography scale
  fontSizeTitle1: 32,
  fontSizeTitle2: 24,
  fontSizeBody1: 18,
  fontSizeBody2: 16,
  fontSizeCaption1: 14,
  fontSizeCaption2: 12,
  
  // Branding
  logoBase64: 'your_logo_base64_here',
);

API Reference #

OctopusSDK Methods #

initialize

Future<void> initialize({
  required String apiKey,
  List<ProfileField>? appManagedFields,
})

Parameters:

• apiKey (required): Your Octopus Community API key
• appManagedFields (optional): List of profile fields managed by your app instead of Octopus Community

appManagedFields Details: This parameter allows you to specify which user profile fields should be managed by your application rather than by Octopus Community. When a field is in this list, users will not be able to edit it directly in the Octopus Community interface. Instead, your app should handle editing these fields through the onModifyUser callback.

ProfileField enum values:

• ProfileField.nickname: User's display name
• ProfileField.picture: User's profile picture
• ProfileField.bio: User's biography/description

Example:

await octopus.initialize(
  apiKey: 'your-api-key',
  appManagedFields: [ProfileField.nickname, ProfileField.picture, ProfileField.bio],
);

If appManagedFields is empty or null, all fields will be managed by Octopus Community (default behavior).

connectUser

Future<void> connectUser({
  required String userId,
  required String token,
  String? nickname,
  String? bio,
  String? picture
})

OctopusHomeScreen Widget

OctopusHomeScreen({
  String? navBarTitle,              // Navigation bar title
  bool navBarPrimaryColor = false,  // Use primary color for nav bar
  bool showBackButton = true,       // Show back button (Android only)
  OctopusTheme? theme,              // Custom theme
  VoidCallback? onNavigateToLogin,  // Login navigation callback
  Function(String?)? onModifyUser,  // User modification callback
  UrlOpeningStrategy Function(String)? onNavigateToUrl,  // URL interception callback
})

Parameters:

• navBarTitle: Title text to display in the embedded view's navigation bar
• navBarPrimaryColor: Whether to use the primary theme color for the navigation bar background
• showBackButton: Whether to show the back button in the navigation bar (Android only)
• theme: Optional custom theme for colors, fonts, and logo
• onNavigateToLogin: Optional callback for login navigation
• onModifyUser: Optional callback for user profile modification
• onNavigateToUrl: Optional callback for URL interception. Return UrlOpeningStrategy.handledByApp if your app handles the URL, or UrlOpeningStrategy.handledByOctopus to let the SDK open it

Features:

• Embedded Widget: Integrates seamlessly into your Flutter UI
• Callback Support: Full callback support for navigation and user actions
• Cross-platform: Consistent behavior on iOS and Android

OctopusTheme Properties #

OctopusThemeMode Enum #

The OctopusThemeMode enum allows you to control the overall appearance of the Octopus interface:

enum OctopusThemeMode {
  /// Light theme mode - bright interface with dark text
  light,
  /// Dark theme mode - dark interface with light text
  dark,
}

Usage Examples:

// Light theme
final lightTheme = OctopusTheme(
  primaryMain: Colors.blue,
  themeMode: OctopusThemeMode.light,
);

// Dark theme
final darkTheme = OctopusTheme(
  primaryMain: Colors.blue,
  themeMode: OctopusThemeMode.dark,
);

// Auto theme (follows system preference)
final autoTheme = OctopusTheme(
  primaryMain: Colors.blue,
  // themeMode: null (default) - follows system theme
);

Theme Mode Behavior:

• OctopusThemeMode.light: Forces light theme regardless of system setting
• OctopusThemeMode.dark: Forces dark theme regardless of system setting
• null (default): Follows the system theme preference automatically

Available Methods #

Reactive Streams #

Available Widgets #

Converting Image to Base64 #

To use a custom logo, you need to convert your image to base64 format. Here's how to do it:

From Assets

import 'dart:convert';
import 'package:flutter/services.dart' show rootBundle;

class MyWidget extends StatefulWidget {
  @override
  _MyWidgetState createState() => _MyWidgetState();
}

class _MyWidgetState extends State<MyWidget> {
  String? logoBase64;

  @override
  void initState() {
    super.initState();
    loadLogo();
  }

  Future<void> loadLogo() async {
    final bytes = await rootBundle.load('assets/logo.png');
    setState(() {
      logoBase64 = base64Encode(bytes.buffer.asUint8List());
    });
  }

  @override
  Widget build(BuildContext context) {
    if (logoBase64 == null) {
      return CircularProgressIndicator();
    }

    final theme = OctopusTheme(
      logoBase64: logoBase64,
      primaryMain: Colors.blue,
      // ... other theme properties
    );

    return OctopusHomeScreen(theme: theme);
  }
}

From Network Image

import 'dart:convert';
import 'dart:typed_data';
import 'package:http/http.dart' as http;

Future<String> convertNetworkImageToBase64(String imageUrl) async {
  final response = await http.get(Uri.parse(imageUrl));
  if (response.statusCode == 200) {
    final bytes = response.bodyBytes;
    return base64Encode(bytes);
  } else {
    throw Exception('Failed to load image');
  }
}

// Usage
final logoBase64 = await convertNetworkImageToBase64('https://example.com/logo.png');
final theme = OctopusTheme(logoBase64: logoBase64);

From File

import 'dart:convert';
import 'dart:io';

Future<String> convertFileToBase64(String filePath) async {
  final file = File(filePath);
  final bytes = await file.readAsBytes();
  return base64Encode(bytes);
}

// Usage
final logoBase64 = await convertFileToBase64('/path/to/logo.png');
final theme = OctopusTheme(logoBase64: logoBase64);

Troubleshooting #

Common Issues #

iOS Build Issues

• Ensure iOS deployment target is 14.0 or higher
• Check that ENABLE_USER_SCRIPT_SANDBOXING is set to NO
• Run cd ios && pod install --repo-update

Android Build Issues

• Ensure minSdkVersion is 21 or higher
• Check that internet permission is added
• Clean and rebuild: flutter clean && flutter pub get

Authentication Issues

• Verify your API key is correct
• Check that JWT tokens are properly formatted

Network Issues

• Check internet connectivity
• Verify API endpoints are reachable
• Review network security settings (iOS ATS)

OctopusHomeScreen Widget #

The OctopusHomeScreen widget provides a simple way to integrate the native Octopus Community UI into your Flutter application.

Key Features:

• Embedded widget that integrates seamlessly into your Flutter UI
• Custom theme support for colors, fonts, and logo
• Callback support for login navigation and user profile edits
• Cross-platform: works on iOS and Android

import 'package:octopus_sdk_flutter/octopus_sdk_flutter.dart';

class MyWidget extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return OctopusHomeScreen(
      navBarTitle: 'My Community',
      showBackButton: false,
      onNavigateToLogin: () {
        // Handle login navigation
      },
      onModifyUser: (fieldToEdit) {
        // Handle profile edit request
      },
    );
  }
}

Available Parameters #

Usage Examples #

Example with Custom Theme

final customTheme = OctopusTheme(
  primaryMain: Colors.blue,
  primaryLowContrast: Colors.blue.withOpacity(0.2),
  primaryHighContrast: Colors.white,
  onPrimary: Colors.white,
  fontSizeTitle1: 24,
  fontSizeBody1: 16,
  logoBase64: myLogoBase64,
);

OctopusHomeScreen(
  navBarTitle: 'Community',
  theme: customTheme,
  navBarPrimaryColor: true,
  showBackButton: false,
)

Example with Callbacks

OctopusHomeScreen(
  navBarTitle: 'Community',
  showBackButton: true,
  onBack: () {
    Navigator.of(context).pop();
  },
  onNavigateToLogin: () {
    // Handle navigation to login screen
    Navigator.of(context).push(
      MaterialPageRoute(builder: (context) => LoginPage()),
    );
  },
  onModifyUser: (fieldToEdit) {
    // Handle profile modification request
    print('User wants to edit: $fieldToEdit');
  },
  loadingWidget: Center(
    child: Column(
      mainAxisAlignment: MainAxisAlignment.center,
      children: [
        CircularProgressIndicator(),
        SizedBox(height: 16),
        Text('Loading your community...'),
      ],
    ),
  ),
)

Example with Custom Error Widget

OctopusHomeScreen(
  navBarTitle: 'Community',
  showError: true,
  errorWidget: Center(
    child: Column(
      mainAxisAlignment: MainAxisAlignment.center,
      children: [
        Icon(Icons.wifi_off, size: 64, color: Colors.grey),
        SizedBox(height: 16),
        Text('No connection'),
        SizedBox(height: 8),
        Text('Please check your internet connection'),
      ],
    ),
  ),
)

Advanced Error Widget Customization

You can create highly customized error widgets with interactive elements:

OctopusHomeScreen(
  navBarTitle: 'Community',
  errorWidget: Container(
    padding: EdgeInsets.all(24),
    decoration: BoxDecoration(
      color: Colors.grey[100],
      borderRadius: BorderRadius.circular(12),
    ),
    child: Column(
      mainAxisSize: MainAxisSize.min,
      children: [
        Icon(
          Icons.error_outline,
          size: 48,
          color: Colors.orange,
        ),
        SizedBox(height: 16),
        Text(
          'Something went wrong',
          style: TextStyle(
            fontSize: 18,
            fontWeight: FontWeight.bold,
          ),
        ),
        SizedBox(height: 8),
        Text(
          'We couldn\'t load the community right now.',
          textAlign: TextAlign.center,
          style: TextStyle(color: Colors.grey[600]),
        ),
        SizedBox(height: 16),
        Row(
          mainAxisAlignment: MainAxisAlignment.spaceEvenly,
          children: [
            ElevatedButton.icon(
              onPressed: () {
                // Custom retry logic
                print('Retry pressed');
              },
              icon: Icon(Icons.refresh),
              label: Text('Retry'),
            ),
            TextButton.icon(
              onPressed: () {
                // Custom help logic
                print('Help pressed');
              },
              icon: Icon(Icons.help_outline),
              label: Text('Help'),
            ),
          ],
        ),
      ],
    ),
  ),
)

Branded Error Widget

Create error widgets that match your app's branding:

OctopusHomeScreen(
  navBarTitle: 'Community',
  theme: OctopusTheme(
    primaryMain: Colors.blue,
    // ... other theme properties
  ),
  errorWidget: Container(
    padding: EdgeInsets.all(32),
    child: Column(
      mainAxisAlignment: MainAxisAlignment.center,
      children: [
        // Your app logo
        Image.asset(
          'assets/logo.png',
          height: 64,
          width: 64,
        ),
        SizedBox(height: 24),
        Text(
          'Connection Issue',
          style: TextStyle(
            fontSize: 20,
            fontWeight: FontWeight.bold,
            color: Colors.blue, // Use your brand color
          ),
        ),
        SizedBox(height: 12),
        Text(
          'Please check your internet connection and try again.',
          textAlign: TextAlign.center,
          style: TextStyle(
            fontSize: 16,
            color: Colors.grey[600],
          ),
        ),
        SizedBox(height: 24),
        ElevatedButton(
          onPressed: () {
            // Custom retry action
          },
          style: ElevatedButton.styleFrom(
            backgroundColor: Colors.blue, // Your brand color
            foregroundColor: Colors.white,
            padding: EdgeInsets.symmetric(horizontal: 32, vertical: 12),
          ),
          child: Text('Try Again'),
        ),
      ],
    ),
  ),
)

Example in TabBar

TabBarView(
  children: [
    // Other content...
    OctopusHomeScreen(
      navBarTitle: 'Community',
      showBackButton: false,
    ),
  ],
)

Example in BottomNavigationBar

IndexedStack(
  index: _currentIndex,
  children: [
    // Other content...
    OctopusHomeScreen(
      navBarTitle: 'Community',
      showBackButton: false,
    ),
  ],
)

Error Handling #

The OctopusHomeScreen widget automatically handles errors and displays a default error widget with a "Retry" button. You can customize this behavior:

OctopusHomeScreen(
  errorWidget: Center(
    child: Column(
      children: [
        Icon(Icons.wifi_off, size: 64),
        Text('No connection'),
        ElevatedButton(
          onPressed: () => setState(() {}),
          child: Text('Retry'),
        ),
      ],
    ),
  ),
)

Important Notes #

• The widget works on Android and iOS
• On iOS, navBarTitle completely replaces the logo
• On Android, navBarTitle can be displayed alongside the logo
• The showBackButton parameter only affects Android
• Make sure the SDK is initialized before using the widget

Notification Badge Count #

Listen to the unseen notification count to display a badge in your UI:

OctopusSDK.notSeenNotificationsCount.listen((count) {
  print('Unseen notifications: $count');
  // Update your badge UI
});

// Force refresh from server
await octopus.updateNotSeenNotificationsCount();

Community Access / A/B Testing #

Use hasAccessToCommunity to gate community features:

OctopusSDK.hasAccessToCommunity.listen((hasAccess) {
  if (hasAccess) {
    // Show community tab
  } else {
    // Hide community tab
  }
});

// Override the cohort attribution
await octopus.overrideCommunityAccess(true);

// Track for analytics only (does not change actual access)
await octopus.trackCommunityAccess(true);

URL Interception #

Intercept URLs tapped inside the community UI:

OctopusHomeScreen(
  onNavigateToUrl: (url) {
    if (url.contains('myapp.com/profile')) {
      // Handle internally
      Navigator.of(context).pushNamed('/profile');
      return UrlOpeningStrategy.handledByApp;
    }
    // Let the SDK open it in the default browser
    return UrlOpeningStrategy.handledByOctopus;
  },
)

Locale Override #

Override the language used by the Octopus SDK UI:

// Force French
await octopus.overrideDefaultLocale(const Locale('fr'));

// Force American English
await octopus.overrideDefaultLocale(const Locale('en', 'US'));

// Reset to system default
await octopus.overrideDefaultLocale(null);

Custom Analytics #

Track custom events that are merged into Octopus analytics reports:

// Track with properties
await octopus.trackCustomEvent('purchase', {
  'product_id': '123',
  'price': '9.99',
  'currency': 'EUR',
});

// Track without properties
await octopus.trackCustomEvent('app_opened');

All property values must be strings.

SDK Events #

Listen to typed SDK events for analytics or custom behavior:

OctopusSDK.events.listen((event) {
  switch (event) {
    case PostCreatedEvent():
      print('Post created: ${event.postId}');
    case ScreenDisplayedEvent():
      print('Screen displayed: ${event.screen}');
    case SessionStartedEvent():
      print('Session started: ${event.sessionId}');
    // ... handle other events
    default:
      break;
  }
});

Available event types:

Examples #

Check the /example folder for complete implementation examples:

• Basic Integration: Simple setup with default theme
• Custom Theme: Advanced theming with custom colors and fonts
• SSO Authentication: Complete SSO flow with JWT token integration
• Embedded Widgets: Usage of OctopusHomeScreen widgets with callbacks

Support #

For issues, questions, or contributions:

• 📧 Email: support@octopuscommunity.com
• 📖 Official Documentation: https://doc.octopuscommunity.com/
• 📖 Flutter SDK Documentation: This README

License #

This project is licensed under the Octopus Community Mobile SDK License Agreement - see the LICENSE file for details.