GetSocial Notifications on Android

Prerequisite

Setup Android Push Notifications

GetSocial supports sending push notifications via Firebase Cloud Messaging (FCM) or Google Cloud Messaging (GCM).

  1. Follow FCM official guide (or GCM official guide) to setup push notifications in your app.

    CDM Permissions for GCM

    If you are using Google Cloud Messaging for Push Notifications, don’t forget to add CDM permissions to your AndroidManifest.xml:

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    <application ...>
        ...
        <permission
            android:name="${applicationId}.permission.C2D_MESSAGE"
            android:protectionLevel="0x2" />
        <uses-permission
            android:name="android.permission.WAKE_LOCK" />
        <uses-permission
            android:name="com.google.android.c2dm.permission.RECEIVE" />
        <uses-permission
            android:name="${applicationId}.permission.C2D_MESSAGE" />
    </application>
    
  2. Login to the GetSocial Dashboard.

  3. Go to the “App settings” section → “Notifications” tab.
  4. Enable Android notifications by clicking on the switch and fill in “API Key” and “Sender ID” values.

    You can find “API Key” (Server key) and “Sender ID” in your application settings in Firebase developer console.

    GetSocial Dashboard - Enable Push Notifications

  5. Select what kind of notifications users will receive:

    GetSocial Dashboard - Notifications Type

  6. Press “Save” button in the bottom right corner.

Enable/disable GetSocial Notifications on the Client Side

By default GetSocial SDK automatically register at push server, and the user will start receiving push notifications.

To prevent auto registration and register for push notifications manually:

  1. Add autoRegisterForPush property to the GetSocial configuration in the Android application build.gradle:

    1
    2
    3
    4
    getsocial {
        ...
        autoRegisterForPush false
    }
    
  2. To start receiving GetSocial push notifications call:

    1
    GetSocial.registerForPushNotification();
    

If you’re not using GetSocial Gradle Plugin check how to disable auto registration for push notifications in the Manual Integration Guide.

Handle Click on Push Notifications

Select Activity to Open

By default, click on the GetSocial notification will start launcher activity. If you want to open other activity on notification click, add the <intent-filter> with action getsocial.intent.action.NOTIFICATION_RECEIVE to the activity that should be opened:

1
2
3
4
5
6
7
<activity ...>
    ...
    <intent-filter>
        <action android:name="getsocial.intent.action.NOTIFICATION_RECEIVE"/>
        <category android:name="android.intent.category.DEFAULT"/>
    </intent-filter>
</activity>

GetSocial UI

If you are using GetSocial UI, SDK will open respective view on click on the GetSocial notification. For instance, if someone liked your activity or commented under your activity, this activity will be shown on GetSocial notification click.

Important

If GetSocial View is opened automatically by GetSocial UI, you can not set the custom title, UiActionListener, action button handler, etc. In this case, we recommend you to override the default behavior and open GetSocial View by yourself.

Notification Listener

You can customize the default behavior and handle clicks on GetSocial notifications on your own. Also, you can listen for GetSocial notifications when an application is running in the foreground when the notification was received. To do so, set the NotificationListener in onCreate method of your Application or Activity:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
GetSocial.setNotificationListener(new NotificationListener() {

    public boolean onNotificationReceived(Notification notification, boolean wasClicked) {
        if (!wasClicked) {
            return false;
        }
        boolean isHandled = handleNotification(notification);
        return isHandled;
    }

});

wasClicked parameter is true when the application was opened by push notification click or false if the application was in the foreground when the notification was received.
In the example above return a boolean: true, if notification is handled by your method handleNotification(notification), or false if it is not. If you return false, SDK will handle the notification.

For example, if you want to prevent of showing GetSocial Activity Feed UI on notification click:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
boolean handleNotification(Notification notification) {
    switch (notification.getAction()) {
        case Notification.Type.OPEN_ACTIVITY:
            // add custom logic here
            Log.i("GetSocial", "Activity Notification received");
            return true;

        default:
            return false;
    }
}

Tip

If you are not using GetSocial UI, we recommend to handle notifications by yourself - better user experience would be to react to notification actions.

Show Notifications In Foreground

If you want to show GetSocial notifications while app is in foreground - set foregroundNotifications to true in the GetSocial configuration in your build.gradle:

1
2
3
4
getsocial {
    ...
    foregroundNotifications true
}

If you’re not using GetSocial Gradle Plugin check how to enable foreground notifications in the Manual Integration Guide.

If foregroundNotifications is set to true:

  • Notifications will be shown when your application is in foreground.
  • NotificationListener will be called after clicking on the notification; parameter wasClicked will be true.

Get Notifications

To be sure your users didn’t miss any important(or not) notifications, you can query GetSocial notifications and show it to your user inside the app. Or send it once again as local notification. Or handle it in any other convenience method.

Query

You have two types of queries: NotificationQuery and NotificationsCountQuery to get notifications list and notifications count respectively.
Notification can differ by a read status - be read or unread. Also each notification has type, it is one of Notification.NotificationType constants.
To query notifications by a read status, use one of static factory methods read(), unread() or readAndUnread().
By default notifications of all types are queries. Also you can explicitly call ofAllTypes() to be sure that all types are queries. To specify a list of types you’re interested in call method ofTypes(Notification.NotificationType... types) and pass one or few types you want to query.

Notifications Count

To get the count of notifications use GetSocial.User.getNotificationsCount(query, callback) method. For example, to get a number of all unread notifications for current user:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
NotificationsCountQuery query = NotificationsCountQuery.unread().ofAllTypes();
GetSocial.User.getNotificationsCount(query, new Callback<Integer>() {
    @Override
    public void onSuccess(Integer count) {
        Log.d("Notifications", "Unread notifications count: " + count);
    }

    @Override
    public void onFailure(GetSocialException exception) {
        Log.e("Notifications, "Failed to get notifications count: " + exception);
    }
});

Notifications List

Similar to notifications count you can fetch a list of notifications using GetSocial.User.getNotifications(query, callback) mehtod:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
NotificationsQuery query = NotificationsQuery.unread().ofAllTypes();
GetSocial.User.getNotifications(query, new Callback<List<Notification>>() {
    @Override
    public void onSuccess(List<Notification> notifications) {
        showNotifications(notifications);
    }

    @Override
    public void onFailure(GetSocialException exception) {
        Log.e("Notifications, "Failed to get notifications: " + exception);
    }
});

Read And Unread Notifications

All the notifications that are sent to a user are unread. The only exception is notifications that was clicked by a user - such becomes read automatically.

If you want to set notification read or unread use GetSocial.User.setNotificationsRead(notificationIds, isRead, callback) method:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
List<Notification> notificationsToBeRead = ...;
List<String> notificationIds = new ArrayList<String>();
for (Notification notification : notificationsToBeRead) {
    notificationIds.add(notification.getId());
}
boolean markAsRead = true;
GetSocial.User.setNotificationsRead(notificationIds, markAsRead, new CompletionCallback() {
    @Override
    public void onSuccess() {
        Log.d("Notifications, "Successfully changed notifications status");
    }
    @Override
    public void onFailure(GetSocialException exception) {
        Log.e("Notifications, "Failed to change notifications status: " + exception);
    }
});

You can mark just one notification using Collections.singletonList(notification.getId()).

Disable Push Notifications For User

If you don’t want to send notifications to a user, use GetSocial.User.setPushNotificationsEnabled(false, callback). Notifications will still appear in the notification center. To enable it back use GetSocial.User.setPushNotificationsEnabled(true, callback).

To check current setting value use GetSocial.User.isPushNotificationsEnabled(callback).

Customize Notification Icon

By default, GetSocial SDK will use application icon as the notification icon.

There are two ways to customize the icon. The first option is to put an image with name getsocial_notification_icon into res/drawable folder.

If you want to use an existing icon for notifications, you can set the resource name in the Android Manifest. For instance to use ic_notification_custom.png from res/drawable:

1
2
3
4
5
6
7
<application ... >
    ...
    <meta-data
        android:name="im.getsocial.sdk.NotificationIcon"
        android:resource="@drawable/ic_notification_custom" />
    ...
</application>

As a result all notifications coming from GetSocial SDK will use custom icon:

Customized Notification Icon

Also, you can customize large notification icon using manifest. To use ic_large_notification_icon.png from res/drawable:

1
2
3
4
5
6
7
<application ... >
    ...
    <meta-data
        android:name="im.getsocial.sdk.LargeNotificationIcon"
        android:resource="@drawable/ic_large_notification_icon" />
    ...
</application>

Customized Notification Icon

Next Steps

Give us your feedback! Was this article helpful?

😀 🙁