Skip to main content

Flutter SDK installation

The Relavoi Flutter SDK ships as relavoi_flutter, a hybrid plugin: it is pure Dart for HTTP, WebSocket, and push, and drops to platform channels only for native call detection (iOS/Android) and the Android overlay permission. One dependency covers both platforms.

Requirements​

  • Flutter: 3.10 or newer
  • Dart: 3.0 or newer
  • Android: minSdk 24 (Android 7.0 Nougat)
  • iOS: 15.0 or newer

Add the dependency​

The published package is the simplest path. In your app's pubspec.yaml:

dependencies:
  relavoi_flutter: ^0.1.0

Then fetch it:

flutter pub get

Git dependency​

To track the SDK ahead of a pub.dev release, or to pin to an internal branch, use the Git form instead:

dependencies:
  relavoi_flutter:
    git:
      url: https://github.com/cicanda/relavoi-flutter-sdk.git
      ref: main

firebase_messaging is pulled in transitively for the push module — you do not add it yourself. See Push notifications for the Firebase project setup that push additionally requires.

Android configuration​

Confirm your android/app/build.gradle sets the minimum SDK to 24 or higher:

android {
  defaultConfig {
    minSdkVersion 24
  }
}

Declare the required permissions in android/app/src/main/AndroidManifest.xml, inside the <manifest> element:

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.READ_PHONE_STATE" />

INTERNET covers all REST and WebSocket traffic. READ_PHONE_STATE backs native call detection for the verification banner.

:::warning Runtime permission still required Declaring READ_PHONE_STATE in the manifest is necessary but not sufficient. On API 23+ your app must also request it at runtime. The SDK exposes Relavoi.instance.verification.hasPhoneStatePermission() to check the grant — see Verification. :::

iOS configuration​

No extra permissions are needed. Native call detection on iOS uses CXCallObserver, which requires no user prompt and no Info.plist entry. Set the platform floor in ios/Podfile:

platform :ios, '15.0'

Then install pods:

cd ios && pod install

Verify the install​

Drop a quick check into main() before runApp:

import 'package:relavoi_flutter/relavoi_flutter.dart';

void main() {
  // Before initialize() this is false; it flips to true once you call
  // Relavoi.initialize(...).
  debugPrint('Relavoi initialized? ${Relavoi.isInitialized}');
  runApp(const MyApp());
}

If the import resolves and this prints without an error, the plugin is wired up. Continue with Initialization.