Skip to content

Send GetSocial Notifications from Android SDK

Prerequisite

Send Notifications

You can send GetSocial Notification to any user in you application. To send notification you have to:

  1. Create a list of receivers. The list should contain GetSocial user IDs.
  2. Create a notification content.
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
// The list of GetSocial user IDs whom we will send notification to
List<String> receivers = ... ;

// The content of the notification
MediaAttachment media = ... ; // Create and instance of MediaAttachment from image or video
Action action = ... ; // Create an Action instance
NotificationContent notificationContent = NotificationContent
        .notificationWithText("Notification text")
        .withTitle("Greetings!")
        .withTemplateName("template-name")
        .withAction(action)
        .withMediaAttachment(media);

GetSocial.User.sendNotification(receivers, notificationContent, new Callback<NotificationsSummary>() {
    @Override
    public void onSuccess(NotificationsSummary result) {
        Log.d("GetSocial", "Successfully sent "  + result.getSuccessfullySentCount() + " notifications!");
    }

    @Override
    public void onFailure(GetSocialException exception) {
        Log.d("GetSocial", "Failed to send notification, error: " + exception.getMessage());
    }
});
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
// The list of GetSocial user IDs whom we will send notification to
var receivers: Array<String> = ...

// The content of the notification
val media : MediaAttachment = ... // Create and instance of MediaAttachment from image or video
val action : Action = ... // Create an Action instance
val notificationContent = NotificationContent
    .notificationWithText("Notification text")
    .withTitle("Greetings!")
    .withTemplateName("template-name")
    .withAction(action)
    .withMediaAttachment(media)

GetSocial.User.sendNotification(receivers, notificationContent, object : Callback<NotificationsSummary>{
    override fun onSuccess(result: NotificationsSummary) {
        println("Successfully sent ${result.successfullySentCount} notifications!")
    }

    override fun onFailure(exception: GetSocialException) {
        println("Failed to send notification, error: ${exception.message}")
    }
})

Receivers

  • Receivers list can not be empty.
  • It may contain up to 25 unique user IDs and one or many placeholders from SendNotificationPlaceholders.Receivers.

    1
    2
    3
    4
    5
    List<String> receivers = Arrays.asList(
          SendNotificationPlaceholders.Receivers.REFERRED_USERS,
          SendNotificationPlaceholders.Receivers.REFERRER,
          "[put user 1 id here]",
          "[put user 2 id here]");
    
    1
    2
    3
    4
    5
    val receivers = listOf(
        SendNotificationPlaceholders.Receivers.REFERRED_USERS,
        SendNotificationPlaceholders.Receivers.REFERRER,
        "[put user 1 id here]",
        "[put user 2 id here]")
    
  • If you will send more that 25 user IDs - method will fail and notification will not be sent.

  • If you mentioned one user twice or user is in two or more placeholder groups - the notification will be sent only once.
  • If our service can not send the notification to one or many users, it will be delivered to all other users. You can check the number of successfully sent notifications in the response.

Notification Content

There are two ways to create a notification content:

  1. Create all the content on the client side. You can customize notification text (mandatory), title, configure notification click action and attach media or add action buttons.

    1
    2
    NotificationContent notificationContent = NotificationContent
        .notificationWithText("Notification text");
    
    1
    2
    val notificationContent = NotificationContent
        .notificationWithText("Notification text")
    
  2. Use templates provided by GetSocial or create your custom template on the GetSocial Dashboard. You can override any content in the template dynamically on the client side.

    1
    2
    NotificationContent notificationContent = NotificationContent
        .notificationFromTemplate("template-name");
    
    1
    2
    val notificationContent = NotificationContent
        .notificationFromTemplate("template-name")
    

Action

To set an action to the notification click, use notification.withAction(Action action).

1
2
3
Action action = Action.builder(ActionTypes.OPEN_INVITES).build();
NotificationContent notificationContent = NotificationContent.notificationWithText("Invite friends!")
                        .withAction(action);
1
2
3
val action = Action.builder(ActionTypes.OPEN_INVITES).build()
val notificationContent = NotificationContent.notificationWithText("Invite friends!")
    .withAction(action)

Read how to create actions.

Action Buttons

To add an action button use notification.addActionButton(ActionButton button) or notification.addActionButtons(List<ActionButton> actionButtons) to add multiple buttons at once.

1
2
3
4
NotificationContent notificationContent = NotificationContent.notificationWithText("Add " + SendNotificationPlaceholders.CustomText.SENDER_DISPLAY_NAME + " to friends")
                        .withAction(Action.builder("add_friend").build())
                        .addActionButton(ActionButton.create("Accept", ActionButton.CONSUME_ACTION)
                        .addActionButton(ActionButton.create("Decline", ActionButton.IGNORE_ACTION);
1
2
3
4
5
val notificationContent = NotificationContent
    .notificationWithText("Add ${SendNotificationPlaceholders.CustomText.SENDER_DISPLAY_NAME} to friends")
    .withAction(Action.builder("add_friend").build())
    .addActionButton(ActionButton.create("Accept", ActionButton.CONSUME_ACTION))
    .addActionButton(ActionButton.create("Decline", ActionButton.IGNORE_ACTION))

Media Attachment

It’s possible to send image and video content in notification. To set image or video use NotificationContent.withMediaAttachment():

1
2
3
MediaAttachment attachment = ... ;
NotificationContent notificationContent = NotificationContent.notificationWithText("Check this cool image!")
                        .withMediaAttachment(attachment);
1
2
3
val attachment : MediaAttachment = ...
val notificationContent = NotificationContent.notificationWithText("Check this cool image!")
    .withMediaAttachment(attachment)

Check full Media Attachment guide to learn about supported image, GIF and video formats and limitations.

Notification Templates

To create a template for notifications:

  1. Login to the GetSocial Dashboard.

  2. Go to the Notifications section → Templates tab.

  3. Press New Template button.

    GetSocial Dashboard - Create New Template

  4. Create a new template by giving a unique name and meaningful description.

  5. Setup the notification content. You can add translations, emojis, default placeholders (Sender/Receiver display name) or custom placeholders that can be replaced on the SDK. Also you can set the fallback value for each placeholder which will be used if it wasn’t sent from the SDK side.

  6. To check the list of your custom templates switch to Custom tab using radio button.

Now create and setup notification using GetSocial Android SDK:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
// Text for the template "new_level_achieved" on the Dashboard:
// "Your friend [SENDER_DISPLAY_NAME] just reached [USER_LEVEL] lvl! Try to beat his score!"

NotificationContent notification = NotificationContent.notificationFromTemplate("new_level_achieved");
... // set up your notification
notification.addTemplatePlaceholder("USER_LEVEL", "7"); // add replacement for your placeholders without brackets

GetSocial.User.sendNotification(users, notification, callback);
// Your recipients will receive text:
// "Your friend John Doe just reached 7 lvl! Try to beat his score!"
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
// Text for the template "new_level_achieved" on the Dashboard:
// "Your friend [SENDER_DISPLAY_NAME] just reached [USER_LEVEL] lvl! Try to beat his score!"

val notificationContent = NotificationContent.notificationFromTemplate("new_level_achieved")
... // set up your notification
notificationContent.addTemplatePlaceholder("USER_LEVEL", "7")  // add replacement for your placeholders without brackets

GetSocial.User.sendNotification(users, notificationContent, callback)
// Your recipients will receive text:
// "Your friend John Doe just reached 7 lvl! Try to beat his score!"

[SENDER_DISPLAY_NAME] is automatically replaced with sender display name. You can check all possible placeholders in SendNotificationPlaceholders.CustomText.

Next Steps

Give us your feedback! Was this article helpful?

😀 🙁