Flutter package

ovok_flutter is the package Flutter apps depend on. ovok_sdk is the pure-Dart API client; ovok_flutter sits on top of it and adds Flutter-only modules, including the questionnaire form and Bluetooth runtime. Both follow the @ovok/native/next contract, with Dart names.

What it adds over ovok_sdkCopy Anchor Link

Its library re-exports every public symbol of ovok_sdk unchanged and adds Flutter-specific widgets. Ovok, its namespaces, Page and the OvokException classes are the same types under either import. The ovok_flutter reference lists each re-exported symbol and links to its page.

Depend on ovok_flutter in a Flutter app so Flutter modules arrive without changing your imports. Servers, command-line tools and other Dart-only projects depend on ovok_sdk alone and never pull in Flutter.

InstallCopy Anchor Link

flutter pub add ovok_flutter

It requires Dart 3.6 or later and pulls in the matching ovok_sdk. Do not add ovok_sdk separately; import one library:

import 'package:ovok_flutter/ovok_flutter.dart';

Set up a clientCopy Anchor Link

Create one Ovok client per tenant when the app starts and keep it for the app's lifetime. The client keeps the signed-in session in an OvokSecureStore; the Get started guide shows an adapter for flutter_secure_storage.

import 'package:flutter/material.dart';
import 'package:flutter_secure_storage/flutter_secure_storage.dart';
import 'package:ovok_flutter/ovok_flutter.dart';

final navigatorKey = GlobalKey<NavigatorState>();

final ovok = Ovok(
  baseUrl: 'https://api.sandbox.ovok.com',
  tenantCode: 'your-tenant',
  secureStore: SecureStore(const FlutterSecureStorage()),
  onUnauthenticated: (reason) =>
      navigatorKey.currentState?.pushNamedAndRemoveUntil('/sign-in', (_) => false),
);

void main() => runApp(MaterialApp(navigatorKey: navigatorKey, home: const HomePage()));

onUnauthenticated runs when the server refuses the refresh token and the session is cleared, so the app can return to its sign-in screen. Pass the client to the widgets that need it the way your app shares other services, for example through a provider or constructor arguments.

FeaturesCopy Anchor Link