Send GetSocial Notifications from Unity 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
    // The list of GetSocial user IDs whom we will send notification to
    List<string> receivers = ... ;
    
    // The content of the notification
    var notification = NotificationContent
                            .NotificationWithText("Notification text")
                            .WithTitle("Greetings!")
                            .WithAction(Action.builder("say_hello").build())
                            .WithMediaAttachment(MediaAttachment.Image(customImage));
    
    GetSocial.User.SendNotification(receivers, notification,
                            summary => Debug.Log("Sent " + summary.SuccessfullySentCount + " notifications"),
                            error => Debug.LogError("Failed to send notifications: " + error));
    

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 = new List<string> {
                    SendNotificationPlaceholders.Receivers.ReferredUsers,
                    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.

    1
    2
    NotificationContent notification = 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
    var notification = NotificationContent
                            .NotificationFromTemplate("template-name");
    

Action

To set an action to the notification click, use notification.WithAction(GetSocialAction action).

1
2
3
var action = GetSocialAction.CreateBuilder(GetSocialActionType.OpenInvite).build();
var 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
var notificationContent = NotificationContent.NotificationWithText("Add " + SendNotificationPlaceholders.CustomText.SenderDisplayName + " to friends")
                        .WithAction(Action.builder("add_friend").build())
                        .AddActionButton(ActionButton.create("Accept", ActionButton.ConsumeAction)
                        .AddActionButton(ActionButton.create("Decline", ActionButton.IgnoreAction);

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 = ... ;
var content = NotificationContent.NotificationWithText("Check this cool image!")
         .WithMediaAttachment(MediaAttachment.Image(customImage));

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.

  7. Now create and setup notification using GetSocial 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, onSuccess, onError);
    // 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.

Notification Sounds

Sound customization is supported via Templates only. But first you have to add it to your application:

  1. Prepare your audio files for both platfroms(or you can support it only for a single platform).

    • Android: It should not contain any special symbols or spaces in its name.
    • iOS: It should be in aiff, wav, or caf formats and not longer than 30 seconds. You can read more about this on the official Apple documentation in Preparing Custom Alert Sounds section.
  2. Add your files to the application.

    • Android: Put it into Assets/Plugins/Android/res/raw directory.
    • iOS: Put it into Assets/StreamingAssets directory.
  3. After file is added you should create a template on the Dashboard.

    • Android: Specify file name without extension in Android Sound configuration.
    • iOS: Set Data/Raw/filename.ext as iOS Sound configuration. Replace filename.ext with your custom sound file name with extension.
  4. Build the application and run it on a device.

  5. Send notification to the user authenticated on this device. You can send notification via Smart Targeting or SDK. When the notification arrives to the device you should hear custom sound instead of the default one. Make sure your device is not muted and volume is on.

Badges

You can send badges only to iOS users, on Android it will be ignored.

  1. Make sure you’ve completed setup guide for badges.
  2. Create badge:

    1. To send a specific value use Badge.SetTo(3) - this will set badge on the recepient side to 3.
    2. To increase/decrease badge value use Badge.IncreaseBy(1). For example if badge was 5, it will be set to 6 after this push notification arrives.
  3. Add badge to notification content: notificationContent.WithBadge(badge).

Example - send notification and increase badge by 3:

1
2
3
var notification = NotificationContent.NotificationWithText("You have 3 new messages!")
        .withBadge(Badge.IncreaseBy(3));
GetSocial.User.SendNotification(users, notification, onSuccess, onError);

Badge is cleared automatically when application is opened. If you want to clear a badge along with push notification, use SetTo with value 0.

Next Steps

Give us your feedback! Was this article helpful?

😀 🙁