octokan_sdk 0.1.2

octokan in-app support chat for Flutter (iOS and Android). One call to configure, one widget to show.

octokan_sdk

In-app support chat for Flutter (iOS and Android). Messages from your users land in your Octokan inbox, and your replies appear in the app within seconds.

Quickest setup

From your Flutter project's folder (needs Node.js):

npx @octokan/cli init <app key> <backend url>

Both values are on the Install page of your Octokan dashboard. The command adds this package to pubspec.yaml, creates lib/octokan_setup.dart, calls it from main() and runs flutter pub get.

Manual setup

flutter pub add octokan_sdk

import 'package:octokan_sdk/octokan_sdk.dart';

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await Octokan.configure(appId: 'app_xxxxxxxxxxxx', baseUrl: 'https://YOUR-BACKEND');
  runApp(const MyApp());
}

Show the chat anywhere:

OctokanChatButton(label: 'Chat with us')   // a ready-made button
Octokan.open(context);                      // from your own button
OctokanChat()                               // embed the page yourself

API

Octokan.configure(appId:, baseUrl:)	call once before runApp
Octokan.identify(id:, email:, name:)	show who is writing (optional)
Octokan.reset()	call on sign-out
Octokan.deleteMyData()	lets a person erase their own chat

Nothing is sent or stored until the person opens the chat. Messages queue while offline and send themselves later. The title, color and welcome text come from your dashboard, so changing them needs no app release.

Testing without the stores

A simulator, emulator or a phone connected over USB is enough. See the testing guide in the Octokan docs.