intercom_flutter

Flutter wrapper for Intercom Android and iOS projects.

Usage

Import package:intercom_flutter/intercom_flutter.dart and use the methods in Intercom class.

Example:

import 'package:intercom_flutter/intercom_flutter.dart';

void main() async {
    await Intercom.initialize('appIdHere', iosApiKey: 'iosKeyHere', androidApiKey: 'androidKeyHere');
    runApp(App());
}

class App extends StatelessWidget {

    @override
    Widget build(BuildContext context) {
        return FlatButton(
            child: Text('Open Intercom'),
            onPressed: () async {
                await Intercom.displayMessenger();
            },
        );
    }
}

See Intercom Android and iOS package documentation for more information.

Android

Permissions:

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

Optional permissions:

<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.VIBRATE"/>

Enable AndroidX + Jetifier support in your android/gradle.properties file (see example app):

android.useAndroidX=true
android.enableJetifier=true

Push notifications in combination with FCM

This plugin works in combination with the firebase_messaging plugin to receive Push Notifications. To set this up:

First, implement firebase_messaging and check if it works: https://pub.dev/packages/firebase_messaging#android-integration
Then, add the Firebase server key to Intercom, as described here: https://developers.intercom.com/installing-intercom/docs/android-fcm-push-notifications#section-step-3-add-your-server-key-to-intercom-for-android-settings (you can skip 1 and 2)
Add the following to your AndroidManifest.xml file, so incoming messages are handled by Intercom:

    <service
        android:name="io.maido.intercom.PushInterceptService"
        android:enabled="true"
        android:exported="true">
        <intent-filter>
          <action android:name="com.google.firebase.MESSAGING_EVENT" />
        </intent-filter>
    </service>

just above the closing </application> tag.

Ask FireBaseMessaging for the FCM token that we need to send to Intercom, and give it to Intercom (so Intercam can send push messages to the correct device):

final FirebaseMessaging _firebaseMessaging = FirebaseMessaging();
token = await _firebaseMessaging.getToken();

Intercom.sendTokenToIntercom(token);

Now, if either FireBase direct (e.g. by your own backend server) or Intercom sends you a message, it will be delivered your Android phone.

Firebase Background Messages

If you are handling background messages in firebase_messaging you need to do some extra work for everything to work together:

Remove the above mentioned <service android:name="io.maido.intercom.PushInterceptService" ... from your AndroidManifest.xml.
In your background messages handler, pass the relevant messages to Intercom:

import 'package:intercom_flutter/intercom_flutter.dart' show Intercom;

Future<dynamic> backgroundMessageHandler(Map<String, dynamic> message) async {
    final data = (message['data'] as Map).cast<String, dynamic>();

    if (await Intercom.isIntercomPush(data)) {
        await Intercom.handlePush(data);
        return;
    }

    // Here you can handle your own background messages
}

iOS

Make sure that you have a NSPhotoLibraryUsageDescription entry in your Info.plist.

Important!

To make this library work properly use IntercomAutoIntegratePushNotifications set to false in your Info.plist. (method swizzling turned off)

If you have already implemented notifications in your project, you can skip this section.

If you haven't implemented any kind of push notifications in your project, you'll need to follow this steps:

Add Capability Push Notifcations in your mobile application (https://developer.apple.com/documentation/xcode/adding_capabilities_to_your_app?language=objc).
Request notifications permissions. This library allows you to request all (badge, alert, sound) at once by using Intercom.requestIosNotificationPermissions(). It will return Future<bool> if user allows the requested permissions.
Add this code to your AppDelegate (before return statement):

Swift

DispatchQueue.main.async {
  application.registerForRemoteNotifications()
}

Objective-C

dispatch_async(dispatch_get_main_queue(), ^{
  [application registerForRemoteNotifications];
});

Sending device token to Intercom.

When device token is generated on native side, the plugin will store it. You can pass onMessage parameter to the initialize method. This method will be called when device token is generated.

Intercom.initialize("APP_ID",
    iosApiKey: "IOS_TOKEN",
    androidApiKey: "ANDROID_TOKEN", onMessage: (Map<String, dynamic> data) {
  print("[Intercom] On message: $data");
  if (data["method"] == "iosDeviceToken") {
    String token = data["token"];
    // You can call this below method here, since we know token is ready
    // Intercom.registerIosTokenToIntercom(); OR
    // Intercom.sendTokenToIntercom(token);
  }
});

There are two ways to register device token.

You can call Intercom.sendTokenToIntercom(token) when you obtain iOS token
You can call Intercom.registerIosTokenToIntercom() when you are sure that token is already generated on native side.

You can listen for token in onMessage method described above
You can check the token using Intercom.getIosToken() at runtime - it will return the previously generated token or null

pawlowskim/intercom_flutter