Zendesk-Messaging for Flutter developer

Yii Chen

Last update: Nov 10, 2022

Related tags

SDK android dart chat ios zendesk messaging flutter customer-service

Overview

Zendesk Messaging

Messaging is a "user-based" chat

Live Chat is a "session-based" chat

Better UI (Native)
Chat history
Answer Bot

Setup

1. Enable agent work-space

2. Enable Messaging

3. Add channel and get key

How to use?

Initialize

 final String androidChannelKey = '';
 final String iosChannelKey = '';

  @override
  void initState() {
    super.initState();
    ZendeskMessaging.initialize(
      androidChannelKey: androidChannelKey,
      iosChannelKey: iosChannelKey,
    );
  }

just use initialize() one time

Show

ZendeskMessaging.show();

You can use in onTap()

Weak

Authentication：Currently does not support. Unable to automatically set user information for users you know, users must enter their own name, email, etc.
Tag：Currently does not support. There is no way to help users with additional information like Chat.
Attachment file：Currently does not support. The official said it will be launched in the future.
Chat room closed：An agent can not reply to a customer at any time. if the customer is not active in the foreground, the room will be closed automatically. It is inconvenient to track chat history.

Future Function

Push Notifications

Link

About Me

Medium：Yii Chen
Youtube：Yii
Email：[email protected]

Comments

Feature - Support user authentication

This PR is still in WIP but it will add authentication support for Zendesk (fix #1)

[x] Android support [x] iOS support [x] Documentation

Authentication

Usage with helpers :

Future<ZendeskLoginResponse> login() async {
   final String jwt = await ...; // get your JWT
   return ZendeskMessaging.loginUser(jwt: jwt);
}

Future<void> logout() async {
   return ZendeskMessaging.logoutUser();
}

Usage with default methods and callbacks :

Future<void> login() async {
   final String jwt = await ...; // get your JWT
   await ZendeskMessaging.loginUserCallbacks(
      jwt: jwt, 
      onSuccess: (id, externalId) {
          // handle success
      }, 
      onFailure: () {
          // handle failure
      },
   );
}

Future<void> logout() async {
   await ZendeskMessaging.logoutUserCallbacks(
      onSuccess: () {
          // handle success
      }, 
      onFailure: () {
          // handle failure
      },
   );
}

Observers

I added some channel methods to be able to watch for success/failure. I updated the example too to display them.

You can attach a global observer to catch messages from native platforms :


ZendeskMessaging.setMessageHandler((type, arguments) {
     // type is an enum, see ZendeskMessagingMessageType
});

opened by tspoke 6

No such module 'ZendeskSDKMessaging' : flutter 3.0, ios 10

Hi @chyiiiiiiiiiiii thank you for this plugin, however I'm facing a No such module 'ZendeskSDKMessaging' issue while building for ios. Using zendesk_messaging: ^0.0.3 and xcode 13. Please help.

opened by DennisMuchiri 5
Upgrade to Zendesk 2.6.0

Hi @chyiiiiiiiiiiii ,

This PR upgrade the project to 2.6.0.

I changed the version number to match the Zendesk version (easier to understand). There is a previous commit with a rollback due to incompatibilities which seems to be fixed in 2.6.0.

Could you create a new version on pubdev with tag=2.6.0 ?

Thanks for your review !

opened by tspoke 2
v2.7.0 sdk upgrade

iOS minimum OS version is 11: https://developer.zendesk.com/documentation/zendesk-web-widget-sdks/sdks/ios/getting_started/#ensure-you-meet-the-minimum-supported-ios-version

2.8.0 is the newest version: https://developer.zendesk.com/documentation/zendesk-web-widget-sdks/sdks/ios/release_notes/

I wasn't able to get the example app to compile on version 2.8.0. Both iOS and android work on version 2.7.0

opened by VictorUvarov 1
upgrade to v2.8.0

iOS minimum OS version is 11: https://developer.zendesk.com/documentation/zendesk-web-widget-sdks/sdks/ios/getting_started/#ensure-you-meet-the-minimum-supported-ios-version

2.8.0 is the newest version: https://developer.zendesk.com/documentation/zendesk-web-widget-sdks/sdks/ios/release_notes/

opened by VictorUvarov 1
User Authentication

Hi,

I'm opening this issue because Zendesk released the authentication for the new Messaging SDK (https://developer.zendesk.com/documentation/zendesk-web-widget-sdks/sdks/android/advanced_integration/#authentication)

It could be great to implement it in this package too :)

opened by tspoke 0
kotlin.UninitializedPropertyAccessException: lateinit property coroutineScope has not been initialized

Hi @chyiiiiiiiiiiii, thanks for the plugin. I have a problem on Android, when starting typing on Android, the app is crashed and returns this error: kotlin.UninitializedPropertyAccessException: lateinit property coroutineScope has not been initialized Version: 2.6.0+1

opened by gprtskh 0