Flutter for Android

You can set up mobile apps to work with Contact Center AI Platform (CCAI Platform) in a number of ways, including with Flutter. This page shows you how to integrate the Android SDK into an Android app using Flutter.

Before you begin

Before following the instructions on this page, you must first follow the instruction in Integrate using Flutter .

Integrate the SDK into an Android app

To integrate the SDK into an Android app, follow these steps:

In the android/build.gradle file in your Flutter example directory, update minSdkVersion to 21 or later.

In the android/src/main/AndroidManifest.xml file, add the following:

 <application>  
<activity  
android:name = 
 "co.ujet.android.activity.UjetActivity" 
  
android:exported = 
 "true" 
>  
<intent-filter>  
<action  
android:name = 
 "android.intent.action.VIEW" 
/>  
<category  
android:name = 
 "android.intent.category.DEFAULT" 
/>  
<category  
android:name = 
 "android.intent.category.BROWSABLE" 
/>  
<!--  
TODO:  
Change  
to  
your  
custom  
URL  
scheme.  
Config  
from  
Portal > 
Developer  
Settings > 
Mobile  
App > 
Enable  
Send  
SMS  
to  
Download  
App > 
Android  
App > 
URL  
-->  
<data  
android:host = 
 "co.ujet.flutter_example_app" 
  
android:path = 
 "/smartchannel" 
  
android:scheme = 
 "ujet" 
  
/>  
</intent-filter>  
</activity>  
<meta-data  
android:name = 
 "co.ujet.android.companyKey" 
  
android:value = 
 "@string/ujet_company_key" 
/>  
<meta-data  
android:name = 
 "co.ujet.android.companyName" 
  
android:value = 
 "@string/ujet_company_name" 
/>  
<meta-data  
android:name = 
 "co.ujet.android.subdomain" 
  
android:value = 
 "@string/ujet_subdomain" 
/>  
<meta-data  
android:name = 
 "co.ujet.android.companyUrl" 
  
android:value = 
 "@string/ujet_company_url" 
/>
</application>

In the <application> tag, update the android:name value to .Application , as in the following code sample:

 <!--Change  
the  
value  
of  
android:name  
to  
.Application  
-->
<application  
android:name = 
 ".Application" 
  
android:label = 
 "Demo Application" 
  
android:icon = 
 "@mipmap/ic_launcher" 
>

Update android/build.gradle , as in the following code sample:

 allprojects  
 { 
  
repositories  
 { 
  
google () 
  
mavenCentral () 
  
maven  
 { 
  
url  
 "https://sdk.ujet.co/android/" 
  
 } 
  
 } 
 }

Update android/app/build.gradle , as in the following code sample:

 dependencies  
 { 
  
//  
Use  
UJET  
SDK  
version  
 2 
.6.0  
or  
latest  
to  
support  
recent  
push  
notification  
changes.  
def  
 ujetSdkVersion 
  
 = 
  
 "x.y.z" 
  
implementation  
 "co.ujet.android:ujet-android: 
 $ujetSdkVersion 
 " 
  
implementation  
 "co.ujet.android:cobrowse: 
 $ujetSdkVersion 
 " 
 }

Update res/values/strings.xml , as in the following code sample. Create this if it doesn't exist.

 <resources>  
<string  
 name 
 = 
 "ujet_company_key" 
>YOUR_COMPANY_KEY</string>  
<string  
 name 
 = 
 "ujet_company_name" 
>YOUR_COMPANY_NAME</string>  
<!--  
If  
your  
tenant  
/  
portal  
url  
ends  
with  
 "ujet.co" 
  
 then 
  
 set 
  
ujet_subdomain  
string  
only  
 ( 
ignore  
ujet_company_url ) 
,  
otherwise  
 set 
  
ujet_company_url  
only  
 ( 
ignore  
ujet_subdomain ) 
  
following  
below  
instructions.  
-->  
<!--  
To  
get  
subdomain,  
extract  
string  
content  
between  
 'https://' 
  
and  
first  
 '.' 
  
of  
your  
tenant/portal  
URL.  
Example,  
If  
your  
tenant  
url  
is  
https://XXX.YYY.ZZZ/  
 then 
  
subdomain  
will  
be  
XXX  
-->  
<string  
 name 
 = 
 "ujet_subdomain" 
>YOUR_SUBDOMAIN</string>  
<!--  
Use  
tenant  
url  
as  
company  
url  
here,  
it  
should  
be  
 in 
  
format  
of  
https://XXX.YYY.ZZZ/api/v2  
 ( 
here  
XXX  
should  
match  
with  
your  
subdomain ) 
  
-->  
<string  
 name 
 = 
 "ujet_company_url" 
>YOUR_COMPANY_URL</string>
</resources>

Create a Firebase project or, if you already have one, register this app. Download the google-service.json file and put it in your project in the following directory: example/android/app/ .

Register the module

To register the module, open MainActivity.kt and initialize UJETModule , as in the following code sample:

 class  
MainActivity  
:  
FlutterActivity () 
  
 { 
  
override  
fun  
configureFlutterEngine ( 
@NonNull  
flutterEngine:  
FlutterEngine ) 
  
 { 
  
super.configureFlutterEngine ( 
flutterEngine ) 
  
//Register  
and  
Initialize  
UJETModule  
UJETModule.init ( 
flutterEngine.dartExecutor.binaryMessenger,  
applicationContext ) 
  
 } 
 }

Set up Android push notifications

Follow these steps if you want to integrate push notifications natively. Be sure that you have copied and pasted the firebase directory into your android project as directed in Integrate the SDK into an Android app .

To set up Android push notifications, follow these steps:

Add a firebase dependency for push notifications in your app-level build.gradle file, as in the following code sample:

 dependencies  
 { 
  
implementation  
platform ( 
 "com.google.firebase:firebase-bom:32.8.0" 
 ) 
  
implementation  
 'com.google.firebase:firebase-messaging' 
 }

Update AndroidManifest.xml , as in the following code sample:

 <application>  
<service  
android:name = 
 ".firebase.MyFirebaseMessagingService" 
  
android:exported = 
 "false" 
>  
<intent-filter>  
<action  
android:name = 
 "com.google.firebase.MESSAGING_EVENT" 
  
/>  
</intent-filter>  
</service>
</application>

Add a google-services plugin at the root level of your project in build.gradle , as in the following code sample:

 plugins  
 { 
  
id  
 'com.google.gms.google-services' 
  
version  
 '4.3.8' 
  
apply  
 false 
 }

Add a google-services plugin at the app level of your project in build.gradle , as in the following code sample:

 plugins  
 { 
  
id  
 "com.android.application" 
  
id  
 "kotlin-android" 
  
id  
 "dev.flutter.flutter-gradle-plugin" 
  
id  
 'com.google.gms.google-services' 
  
//  
google-services  
plugin }

Create MyFirebaseMessagingService that implements FirebaseMessagingService , as in the following code sample:

 class  
MyFirebaseMessagingService:  
FirebaseMessagingService () 
  
 { 
  
private  
var  
firebaseTokenManager:  
FirebaseTokenManager?  
 = 
  
null  
override  
fun  
onCreate () 
  
 { 
  
super.onCreate () 
  
 firebaseTokenManager 
  
 = 
  
FirebaseTokenManager ( 
this ) 
  
 } 
  
override  
fun  
onNewToken ( 
token:  
String ) 
  
 { 
  
firebaseTokenManager?.updateToken ( 
token ) 
  
 } 
  
override  
fun  
onMessageReceived ( 
message:  
RemoteMessage ) 
  
 { 
  
 if 
  
 ( 
Ujet.canHandlePush ( 
message.data )) 
  
 { 
  
Log.d ( 
 "Firebase" 
,  
 "Handle the push message by UJET" 
 ) 
  
 } 
  
 else 
  
 { 
  
//  
Handle  
your  
notifications  
 } 
  
 } 
  
 }

Create FirebaseTokenManager , as in the following code sample:

   
class  
FirebaseTokenManager ( 
context:  
Context ) 
  
 { 
  
private  
val  
 sharedPreferences 
  
 = 
  
context.getSharedPreferences ( 
 " 
 ${ 
 context 
 .packageName 
 } 
 _preferences" 
,  
Context.MODE_PRIVATE ) 
  
private  
var  
token:  
String?  
 = 
  
null  
fun  
getToken () 
:  
String?  
 { 
  
 token 
  
 = 
  
sharedPreferences.getString ( 
 "firebaseToken" 
,  
null ) 
  
 if 
  
 ( 
 token 
  
 == 
  
null ) 
  
 { 
  
FirebaseMessaging.getInstance () 
.token.addOnCompleteListener  
 { 
  
task:  
Task<String?>  
->  
 if 
  
 ( 
!task.isSuccessful  
 || 
  
task.result  
 == 
  
null ) 
  
 { 
  
 return 
@addOnCompleteListener  
 } 
  
 token 
  
 = 
  
task.result  
updateToken ( 
token ) 
  
 } 
  
 } 
  
 return 
  
token  
 } 
  
fun  
updateToken ( 
token:  
String? ) 
  
 { 
  
sharedPreferences  
.edit () 
  
.putString ( 
 "firebaseToken" 
,  
token ) 
  
.apply () 
  
 } 
  
 }

Flutter for Android Stay organized with collections Save and categorize content based on your preferences.

Before you begin

Integrate the SDK into an Android app

Register the module

Set up Android push notifications

Flutter for Android