Flutter SDK

Reset the current user identity and clear persisted identity data. Reverts the SDK to anonymous mode. User identity is preserved across stopSession() — use resetUser() after logout.

await Encatch.resetUser();

Wipes all persisted SDK data and resets in-memory state. Stronger than resetUser() — also clears session-stopped state and device preferences. The SDK remains initialized; call identifyUser afterward.

await Encatch.clearAll();

// In your screen's widget tree:
SingleChildScrollView(
  child: Column(
    children: [
      // ... content above ...
      EncatchInlineForm(
        formId: 'your-form-slug', // exact match; omit for wildcard
        enabled: ModalRoute.of(context)?.isCurrent ?? true,
      ),
      // ... content below ...
    ],
  ),
)

Then trigger the form from anywhere:

await Encatch.showForm('your-form-slug');

When showForm is called, the SDK resolves the presenter in this order:

1. Exact match — first registered EncatchInlineForm whose formId matches the payload wins.
2. Wildcard — first registered EncatchInlineForm with no formId catches anything not exact-matched.
3. Modal fallback — EncatchWebView shows the form as the default overlay when no inline slot is registered or none match.

A background tab with EncatchInlineForm mounted will intercept showForm calls even when it is not visible. To prevent this:

Option A — pass enabled from ModalRoute:

EncatchInlineForm(
  formId: 'your-form-slug',
  enabled: ModalRoute.of(context)?.isCurrent ?? true,
)

Option B — only mount EncatchInlineForm on the active route (e.g. using IndexedStack with conditional rendering).

Option C — bottom tabs with GoRouter StatefulShellRoute: Offstage tab branches often do not rebuild when the shell index changes, so ModalRoute.of(context)?.isCurrent can stay stale. Sync the active tab index with an InheritedNotifier (or similar) and pass enabled: activeTabIndex == myTabIndex to each inline slot. The encatch-flutter-tester sample app demonstrates this with ShellTabIndexScope and EncatchInlineForm(enabled: isActive).

When enabled: false the slot is unregistered, so showForm falls through to the modal or another active slot.

The WebView's internal scroll is disabled. The host SingleChildScrollView (or CustomScrollView) provides scrolling. The widget height grows automatically via form:resize messages from the web form.

SingleChildScrollView(
  child: Column(
    children: [
      EncatchInlineForm(formId: 'my-form'),
    ],
  ),
)

The host app controls keyboard avoidance. Wrap the scroll view in MediaQuery inset handling or use Scaffold's resizeToAvoidBottomInset to slide content above the keyboard.

Add usage descriptions to ios/Runner/Info.plist when forms include video/audio capture:

<key>NSCameraUsageDescription</key>
<string>Encatch forms use the camera to record video responses.</string>
<key>NSMicrophoneUsageDescription</key>
<string>Encatch forms use the microphone to record audio and video responses.</string>

No other iOS setup is required. The SDK uses flutter_inappwebview, which handles WebView media permission requests once these keys are present.

Add permissions to android/app/src/main/AndroidManifest.xml:

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />

INTERNET is required for API calls and the form WebView. The other three permissions are required when forms include video/audio capture questions (video_audio).

The SDK grants WebView media permission requests automatically, but Android still requires runtime approval before the camera or microphone can be used. Request them at startup (Android only):

import 'package:flutter/foundation.dart';
import 'package:permission_handler/permission_handler.dart';

Future<void> requestEncatchMediaPermissions() async {
  if (kIsWeb || defaultTargetPlatform != TargetPlatform.android) return;

  final statuses = await [
    Permission.camera,
    Permission.microphone,
  ].request();

  if (statuses[Permission.camera] != PermissionStatus.granted ||
      statuses[Permission.microphone] != PermissionStatus.granted) {
    // Handle denied permissions — recording questions will not work
  }
}

Add permission_handler to your app for this pattern — it is not a dependency of encatch_flutter.