Android Push Message Integration

1

Connect Firebase Project

To use push messages in an Android app, you need to configure the integration between the Hackle Workspace and a Firebase project.

For details, refer to Android FCM Integration.

2

Integrate Firebase Cloud Messaging SDK

Complete the Android app setup by following the Firebase SDK Integration Guide and the Firebase Cloud Messaging Installation Guide.

3

Integrate with Hackle SDK

Add the Hackle SDK dependency and initialize the SDK by following the SDK Integration guide.

The push token is automatically registered when the app launches.

Once the SDK integration is complete, push tokens are automatically collected and push message reception and click handling become available.

4

Test Push Message

Check Token

• You can check the token set on the Android device via the Check User Identifier guide.

• You can check the Android push token assigned to a specific user via the User Profile guide.

Send Test

• Follow the Push Message Test Send Guide to verify the push message on an Android device.

5

Receive Push Message

When a push message is received, an icon is displayed in the status bar and notification center.

• On Samsung Galaxy Android smartphones, the app icon is displayed.

• On standard Android smartphones or simulators, a white circle icon is displayed.

• If you have configured a push message icon change, the changed icon is displayed.

Deep Link Navigation

Hackle push messages support deep link navigation when tapped.

When the corresponding activity is opened via a push message, you can retrieve the deep link information using the method below.

For more details about Flutter deep links, refer to the Flutter Deep Linking Guide.

Change Push Message Icon

This feature is supported in Flutter SDK 2.22.0 and above.

Due to Google's policy, icons with color cannot be set as push icons on standard Android smartphones.

Hackle push messages support changing the push icon. By assigning a resource to a reserved key in AndroidManifest.xml, you can change the push icon using local resources within the app.

Image and color resources to be used for the push icon must be added to Android Resources.

For details about small_icon, large_icon, and color, refer to the Android Push Design Guide.

key	Description
io_hackle_android_default_notification_small_icon	Sets the small icon.
io_hackle_android_default_notification_large_icon	Sets the large icon.
io_hackle_android_default_notification_color	Sets the small icon background color.

Example

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools">
    <uses-permission android:name="android.permission.POST_NOTIFICATIONS"/>
    <application
        android:label="flutter_app"
        android:name="${applicationName}"
        android:icon="@mipmap/ic_launcher">

       ...
       <meta-data
            android:name="io_hackle_android_default_notification_small_icon"
            android:resource="@drawable/ic_push_small"/>

       <meta-data
            android:name="io_hackle_android_default_notification_large_icon"
            android:resource="@drawable/ic_push_large"/>

       <meta-data
            android:name="io_hackle_android_default_notification_color"
            android:resource="@color/pie" />
       ...
    </application>
</manifest>

Modify Push Message Icon from Dashboard

If a push icon is configured in the Dashboard, it modifies the large icon of the push.

If a push icon is set using local resources and a push icon is also sent from the Dashboard, the icon configured in the Dashboard is used.

Push Channel Support

This feature is supported in Flutter SDK 2.23.0 and above.

With Hackle push messages, you can receive pushes on channels pre-declared within the app. If a push is received with a channel ID that does not exist in the app, it is received on the default channel provided by Hackle.

For detailed instructions on adding push channels to your app, refer to the Android Developer Documentation.

If you want to show a notification popup when a push is received, as on iOS, set the channel importance to IMPORTANCE_HIGH.

Example

The following is an example of creating a channel in the onCreate function of the MainActivity class.

import android.content.Intent
import android.os.Bundle
import android.util.Log
import android.app.NotificationChannel
import android.app.NotificationManager
import android.content.Context
import android.os.Build
import androidx.annotation.RequiresApi
import io.flutter.embedding.android.FlutterActivity


class MainActivity: FlutterActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
            createNotificationChannel(applicationContext, "importance", "importance", NotificationManager.IMPORTANCE_HIGH)
        }
    }

    @RequiresApi(Build.VERSION_CODES.O)
    private fun createNotificationChannel(context: Context, channelId: String, channelName: String, importance: Int) {
        val notificationManager = context.getSystemService(Context.NOTIFICATION_SERVICE) as NotificationManager
        if (notificationManager.getNotificationChannel(channelId) != null) {
            return
        }

        val channel = NotificationChannel(
            channelId,
            channelName,
            importance
        )
        notificationManager.createNotificationChannel(channel)
    }
}