An Android and iOS SDK port of Zendesk for Flutter

Android min SDK 16 and iOS min OS Version 10.0

Easy and fast to use

Setup ( yourdomain - your company zendesk domain)

• AccountKey - https://yourdomain.zendesk.com/chat/agent#home > Profile Picture > Check Connection

• AppId - https://yourdomain.zendesk.com/agent/admin/mobile_sdk

• ClientId - https://yourdomain.zendesk.com/agent/admin/mobile_sdk (for Answer SDK)

• zendeskUrl - https://yourdomain.zendesk.com/agent/admin/mobile_sdk (for Answer SDK)

• Update Cocoapods to latest version

Initialize the Zendesk SDK

await Zendesk2.instance.init(accountKey, appId);

final z = Zendesk2.instance; // general Zendesk

// initialize the Chat SDK
await z.initChatSDK(accountKey, appId); 

// initialize the Answer SDK
await z.initAnswerSDK(accountKey, clientId, zendeskUrl); 

// initialize the Chat SDK
await z.initChatSDK(); 

final zChat = Zendesk2Chat.instance; // Zendesk Chat Providers
final zAnswer = Zendesk2Answer.instance; // Zendesk Answer Providers

How to use - Chat SDK V2

/// Zendesk Chat instance
Zendesk2Chat zChat = Zendesk2Chat.instance;

/// Optional Visitor Info information
await zChat.setVisitorInfo(
    name: name,
    email: email,
    phoneNumber: phoneNumber,
  );

/// Very important, for custom UI, prepare Stream for ProviderModel
await zChat.startChatProviders();

/// Get the updated provider Model (LOGS, AGENTS, etc)
_subscriptionProviderModel = zChat.providersStream.listen((providerModel) {
  _providerModel = providerModel;
});

/// Get the updated connection status
_subscriptionConnectionStatus = zChat.connectionStatusStream.listen((connectionStatus) {
  _connectionStatus = connectionsStatus;
});

/// Get the updated current chat settings (sendingle enabled, file limite, compatible formats)
_subscriptionChatSettingsStream = zChat.chatSettingsStream.listen((chatSettingsModel) {
  _chatSettingsModel = chatSettingsModel;
});

/// Get the current account status (online or offline)
_subscriptionIsOnlineStream = zChat.chatIsOnlineStream.listen((isOnline) {
  _isOnline = isOnline;
});

/// It is also important to disconnect and reconnect 
/// and when the app enters and exits background, 
/// to do this you can simply calll
await zChat.disconnect();
/// or
await zChat.connect(); 

/// After you release resources
await zChat.dispose();

How to use - Answer SDK

/// String query
await zAnswer.query(query);

// Stream subscrition resulting on query success
_subscription = zAnswer.providersDeflection.listen((answerProviderModel) {
      /// this stream retrieve all Answer data from the SDK
      /// in ONE unique reliable object :)
      _answerProviderModel = answerProviderModel;
      }
    );

Push Notifications

To configure chat notifications, you will need to do the following configuration per platform

iOS

Inside your AppDelegate.swift import the ChatSDK as

import ChatProvidersSDK

Add the following method

  override func application(
    _ application: UIApplication, 
    didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data
  ) {
      // You might already have this if you are using firebase messaging
      // Messaging.messaging().apnsToken = deviceToken  
      
      Chat.registerPushToken(deviceToken)
  }

Android

Using FCM messaging, get your FCM token and register it as follows:

Zendesk2Chat zChat = Zendesk2Chat.instance;
await zChat.registerFCMToken(fcmToken);

(calling this function has no effect on iOS)

To display the notifications, you will need to register your own FirebaseMessagingService as a service inside the application. You can follow the Firebase Android Docs for this. An example file that you can copy and customize can be found in the main github repo. Overally you will add the file to your application and register the service as follows:

<service
    android:name="{your package name}"
    android:stopWithTask="false">
    <intent-filter>
        <action android:name="com.google.firebase.MESSAGING_EVENT" />
    </intent-filter>
</service>