Flutter Developer Documentation

Current version: 0.12.0

Flutter SDK supports following platforms:

• Flutter
  • Android
  • iOS

Other platforms supported:

• Android
• iOS
• React Native

Soon-supported platforms:

• Ionic
• Cordova

Installation

Add the plugin to pubspec.yaml file

• Open your Flutter project's pubspec.yaml file.
• Under the dependencies section, add flutter_fullview:

dependencies:
  flutter_fullview: ^latest_version

• Save the file and run: flutter pub get

Configuration

iOS Requirements

• Minimum platform :ios, '15.0' in your Podfile.
• Add the following permissions in your app's xcodeproject Info.plist, if you don't already have them:
  • NSMicrophoneUsageDescription
    • NSCameraUsageDescription
    • UIBackgroundModes voip

Android Requirements

• Gradle plugin to be at least version 8.5
• Set minSDKVersion of the Android build to be 27 (or higher)
• Enable jetifier in gradle.properties
• Change MainActivity to inherit from FlutterFragmentActivity instead of FlutterActivity

Usage

Add import 'package:flutter_fullview/flutter_fullview.dart'; and then use the different functions in ** FullviewSDK** to configure and start the SDK.

A minimal implementation looks like the following:

import 'package:flutter_fullview/flutter_fullview.dart';
import 'package:flutter_fullview/flutter_fullview_region.dart';

// ...

final _flutterFullviewPlugin = FlutterFullview();

try {
  await _flutterFullviewPlugin.attach(); // Ideally this should be run as soon as the app starts.
} catch (e, stackTrace) {
  log("An error occurred", error: e, stackTrace: stackTrace, name: "Example");
}

try {
  await _flutterFullviewPlugin.register(
    region: <FullviewRegion>, 
    organisationId: '<String>', 
    userId: '<String>', 
    deviceId: '<String>', 
    name: '<String>', 
    email: '<String>'
  );
} catch (e) {
  log("An error occurred while starting SDK", error: e, name: "Example");
}

Note: device_id must be a correct unique UUID.

And use _flutterFullviewPlugin.logout() to disconnect and disable the SDK.

Additional features usage

• Data Redaction
• Screen Sharing (additional configuration required for iOS)

Fullview SDK API

• Future<void> attach()

  Attaches fullview SDK to the host app. Should be called as soon as the app starts.

• Future<void> register({ required FullviewRegion region, required String organisationId, required String userId, required String deviceId, required String name, required String email, })

  Registers user to be available in Fullview.

• Future<void> logout()

  Logs out the current user from Fullview.

• Future<void> requestCoBrowse()

  Puts the user into a waiting queue requesting help from agents.

• Future<void> cancelCoBrowseRequest()

  Remove the user from the waiting queue.

• Future<int> getPositionInCoBrowseQueue()

  Position in the request cobrowse queue. 0 if there's no request/queue.

• Future<FullviewState> getState()

  Current state of the SDK. Used to update the UI if necessary.