Page Comparison

Table of Contents

Customization of the Notification Area

...

notificationSmallIcon: Int
notificationSmallIconDarkMode: Int
isNotificationLargeIcon: Boolean
notificationLargeIcon: Int
notificationLargeIconDarkMode
notificationPushIntent: String
notificationChannelName: String
notificationColor: String

Optional Parameters	Description
`notificationSmallIcon`	For entering the icon that is going to be shown in the status bar and the left top corner of the notification area. You should enter the ID of a resource in your project. Default Value : Application icon
`notificationSmallIconDarkMode`	For entering the `notificationSmallIcon` value when the device is in dark theme mode. Default Value : Application icon
`isNotificationLargeIcon`	For determining if there is going to be a large icon in the right of the notification area. Default Value : false (no large icon)
`notificationLargeIcon`	For entering the large icon that is going to be shown in the right of the notification area. You should enter the ID of a resource in your project. Default Value : Application icon (if `isNotificationLargeIcon` is true)
`notificationLargeIconDarkMode`	For entering the `notificationLargeIcon` value when the device is in dark theme mode. Default Value : Application icon (if `isNotificationLargeIcon` is true)
`notificationPushIntent`	For entering the activity that is going to be triggered when the notification is clicked. You should enter the full path of the activity. Default Value : launcher activity
`notificationChannelName`	For entering the name of the notification channel. Default Value : Application name
`notificationColor`	For entering the accent color value that is going to be used in the notification area.
`notificationPriority`	For setting the priority of the notification.(For heads-up notifications, the priority must be set to HIGH)

An example use that includes all parameters is below:

...

Code Block

language	java

RelatedDigital.setIsPushNotificationEnabled(
  context,
  true,
  "googleAppAliasValue",
  "huaweiAppAliasValue",
  token,
  R.drawable.text_icon,
  R.drawable.text_icon_dark_mode,
  true,
  R.mipmap.ic_launcher,
  R.mipmap.ic_launcher,
  "com.relateddigital.androidexampleapp.PushNotificationActivity",
  "relateddigital-android-test",
  "#d1dbbd"
);

Token-User Match

The information about the user can be sent in signUp/Login stage or after to our servers. If there is a user in the server whose information is the same, the related token will be matched to this user.

After sending the mandatory and optional parameters, you should call sync() method.

Kotlin

...

language	kotlin

...

Getting Push Notification Permission(Android 13 or higher)

Validate your SDK versions. Compile and target SDK version should be at least 33.

Code Block

language	groovy

android {
    compileSdkVersion "33"

    defaultConfig {
        targetSdkVersion "33"
    }
}

Use the below RelatedDigital method to trigger the native prompt to request push notification permission.

Kotlin

Code Block

language	kotlin

RelatedDigital.requestNotificationPermission(activity)

Java

Code Block

language

...

kotlin

RelatedDigital.

...

requestNotificationPermission(activity);

Token-User Match

The information about the user can be sent in signUp/Login stage or after to our servers. If there is a user in the server whose information is the same, the related token will be matched to this user.

After sending the mandatory and optional parameters, you should call sync() method.

Kotlin

Code Block

language	kotlin

--Mandatory parameters--
RelatedDigital.setEmail(context, "test@euromsg.com")
RelatedDigital.setRelatedDigitalUserId(context, "testRelatedDigitalUserId")

--Optional parameters--
RelatedDigital.setEmailPermit(context, EmailPermit.ACTIVE)
RelatedDigital.setGsmPermit(context, GsmPermit.ACTIVE)
RelatedDigital.setTwitterId(context, "testTwitterId")
RelatedDigital.setFacebookId(context, "testFacebookId")

...


RelatedDigital.setPhoneNumber(context, "testPhoneNumber")

...


RelatedDigital.setUserProperty(context, "instagram", "testInstagramId")

...



RelatedDigital.sync(context)

...

When Push Notification Module is enabled via RelatedDigital.setIsPushNotification(), the token information is written to RMC servers. This token is saved as "anonymous". In order to match this token with a user, an identifier information for the user (KEY_ID or EMAIL) should be sent to RMC.

In order the data that you sent to be loaded to RMC panel correctly, you should use the same reference value (KEY_ID* veya E-Mail) that you use in your RMC account when sending data via mobile channel.

*KEY_ID: It is the ID that you use to make a user unique in your system like CRM id, userId, customerId, accountId.

...

Code Block

language	json

"extra" : {
  "email" : "test@euromsg.com",
  "keyID" : "testRelatedDigitalUserId"
}

IYS E-Mail Registration (For Turkey)

Kotlin

...

language	kotlin

...

Java

Code Block

language	java

--Mandatory parameters--
RelatedDigital.setEmail(context, "test@euromsg.com");
RelatedDigital.setRelatedDigitalUserId(context, "testRelatedDigitalUserId");

--Optional parameters--
RelatedDigital.setEmailPermit(context, EmailPermit.ACTIVE);
RelatedDigital.setGsmPermit(context, GsmPermit.ACTIVE);
RelatedDigital.setTwitterId(context, "testTwitterId");
RelatedDigital.setFacebookId(context, "testFacebookId");
RelatedDigital.setPhoneNumber(context, "testPhoneNumber");
RelatedDigital.setUserProperty(context, "instagram", "testInstagramId");

RelatedDigital.sync(context);

When Push Notification Module is enabled via RelatedDigital.setIsPushNotification(), the token information is written to RMC servers. This token is saved as "anonymous". In order to match this token with a user, an identifier information for the user (KEY_ID or EMAIL) should be sent to RMC.

In order the data that you sent to be loaded to RMC panel correctly, you should use the same reference value (KEY_ID* veya E-Mail) that you use in your RMC account when sending data via mobile channel.

*KEY_ID: It is the ID that you use to make a user unique in your system like CRM id, userId, customerId, accountId.

Code Block

language	json

"extra" : {
  "email" : "test@euromsg.com",

...

"keyID"

...

Java

...

language	java

...

: "testRelatedDigitalUserId"
}

IYS E-Mail Registration (For Turkey)

Kotlin

Code Block

language	kotlin

val callback: EuromessageCallback = object : EuromessageCallback {
  override fun success() {
    Log.i("IYS Kaydı", "Successful");
  }

  @Override
  public voidoverride fun fail(errorMessage: String errorMessage?) {
    Log.e("IYS Kaydı", "Fail : $errorMessage" + errorMessage);
  }
};

RelatedDigital.registerEmail(
  context = context,
  "email = "test@euromsg.com",
  emailPermit = EmailPermit.ACTIVE,
  isCommercial = false,
  callback = callback
);

Java

Info
If your customer is a corporate, you should send isCommercial parameter as true.

Info
If you do not see a user match in RMC, please get in contact with RMC support team and ask to activate the FLAG of the related appKey.

Push Notification Click Report and Directing

When the user clicks on the notification the activity that you entered via RelatedDigital.setPushIntent() is going to be launched. You should send the click report and direct the user to the related page here in onNewIntent().

Kotlin

override fun onNewIntent(intent: Intent?) { super.onNewIntent(intent) if (intent != null

Code Block

language	kotlin

Code Block

language	java

EuromessageCallback callback = new EuromessageCallback() {
  @Override
  public void success() {
    Log.i("IYS Kaydı", "Successful");
  }

  @Override
  public void fail(String errorMessage) {
    Log.e("IYS Kaydı", "Fail : val" bundle+ = intent.extraserrorMessage);
  }
};

RelatedDigital.registerEmail(
  context,
if (bundle != null) {
 "test@euromsg.com",
  EmailPermit.ACTIVE,
  false,
        val message = intent.extras!!.getSerializable("message") as Message?
            if (message != null) {
                //Send the click report
                RelatedDigital.sendPushNotificationOpenReport(this, message)
                //Direct the user to the related page - message.url
                ..
callback
);

Info
If your customer is a corporate, you should send isCommercial parameter as true.

Info
If you do not see a user match in RMC, please get in contact with RMC support team and ask to activate the FLAG of the related appKey.

Push Notification Click Report and Directing

When the user clicks on the notification, the activity that you entered via RelatedDigital.setPushIntent() is going to be launched. You should send the click report and direct the user to the related page here in onNewIntent().

Kotlin

Code Block

language	kotlin

override fun onNewIntent(intent: Intent?) {
    super.onNewIntent(intent)
    if (intent != null) {
        val bundle = }intent.extras
else {       if (bundle != null) {
     // It shows that a carousel notification isval camemessage and the user clicked on an item= intent.extras!!.getSerializable("message") as Message?
            if (message != null) {
     val itemClickedUrl = bundle.getString("CarouselItemClickedUrl")        //Send the click report
     if (itemClickedUrl != null && itemClickedUrl != "") {   RelatedDigital.sendPushNotificationOpenReport(this, message)
                //Direct the user to the related page - itemClickedUrlmessage.url
                ..
   ..         } else {
     }           // It shows }that a carousel notification is came and the user }clicked on an item
 } }

Java

Code Block

language	java

@Override protected void onNewIntent(Intent intent) {     super.onNewIntent(intent);    val if(intentitemClickedUrl != nullbundle.getString("CarouselItemClickedUrl")
{         Bundle bundle = intent.getExtras();    if (itemClickedUrl != null  if (bundle&& itemClickedUrl != null"") {
             Message message = (Message) intent.getExtras().getSerializable("message");   //Direct the user to the related page - itemClickedUrl
 if(message != null) {                ..
//Send the click report             }
   RelatedDigital.sendPushNotificationOpenReport(this, message);        }
        //Direct}
the user to the related page - message.url
  }
}

Java

Code Block

language	java

@Override
protected void onNewIntent(Intent intent) {
       super.onNewIntent(intent);
     ..
 if(intent != null) {
        Bundle bundle } else {= intent.getExtras();
        if (bundle != null) {
    // It shows that a carousel notification is cameMessage andmessage the= user clicked on an item(Message) intent.getExtras().getSerializable("message");
                 String itemClickedUrl = bundle.getString("CarouselItemClickedUrl");
if(message != null) {
               if(itemClickedUrl != null && !itemClickedUrl.equals("")) { //Send the click report
                RelatedDigital.sendPushNotificationOpenReport(this, message);
                //Direct the user to the related page - itemClickedUrlmessage.url
                ..
         ..   } else {
            }    // It shows that a carousel notification is came }and the user clicked on an item
  }     }
}

Info
You should check the pro-guard issues in your project if you get notification in debug mode but not in release mode.

proguard-rules.pro 'ya aşağıdaki kodları ekleyebilirsiniz;

Code Block
-keep class com.relateddigital.*{;}

Custom Notification Sound

You should add the sound files that is going to be used into your project first.

res/raw/my_custom_sound.mp3

After that, go to RMC panel Settings / Campaign Settings / Push Applications / Your Android Application / Custom Sound File

You should enter the name of the sound file without extension to this field.

...

Campaign Revenue on the Panel

In order to see the revenue as a result of a notification campaign on RMC:

You should enter the utm parameters onto the field of Custom Parameters when creating a push notification campaign.

Example: utm_medium=apppush;utm_source=related;utm_campaign=campaign_name

Info
You can use the campaign ID as utm_campaign since it has to be different each time. For this, you can use <##CAMP_ID##> variable.

Image Removed

Push Message History

You can have the push messages sent in the last 30 days as shown below.

The messages are ordered according to date. The latest message sent is going to be at the beginning of the list.

Kotlin

Code Block

language	kotlin

val pushMessageInterface: PushMessageInterface = object : PushMessageInterface {
  override fun success(pushMessages: List<Message>) {
    // You can write your code here by using pushMessages
  }

  override fun fail(errorMessage: String) {
    Log.e("Past Notifications", errorMessage)
  }
}

RelatedDigital.getPushMessages(activity, pushMessageInterface)

Java

Code Block

language	java

PushMessageInterface pushMessageInterface = new PushMessageInterface() {
  @Override
  public void success(List<Message> pushMessages         String itemClickedUrl = bundle.getString("CarouselItemClickedUrl");
                if(itemClickedUrl != null && !itemClickedUrl.equals("")) {
                    //Direct the user to the related page - itemClickedUrl
                    ..
                }
            }
        }
    }
}

Info
You should check the pro-guard issues in your project if you get notification in debug mode but not in release mode.

proguard-rules.pro 'ya aşağıdaki kodları ekleyebilirsiniz;

Code Block
-keep class com.relateddigital.*{;}

Custom Notification Sound

You should add the sound files that is going to be used into your project first.

res/raw/my_custom_sound.mp3

After that, go to RMC panel Settings / Campaign Settings / Push Applications / Your Android Application / Custom Sound File

You should enter the name of the sound file without extension to this field.

...

Campaign Revenue on the Panel

In order to see the revenue as a result of a notification campaign on RMC:

You should enter the utm parameters onto the field of Custom Parameters when creating a push notification campaign.

Example: utm_medium=apppush;utm_source=related;utm_campaign=campaign_name

Info
You can use the campaign ID as utm_campaign since it has to be different each time. For this, you can use <##CAMP_ID##> variable.

Image Added

Push Message History

You can have the anonymous push messages sent in the last 30 days as shown below.

The messages are ordered according to date. The latest message sent is going to be at the beginning of the list.

Kotlin

Code Block

language	kotlin

val pushMessageInterface: PushMessageInterface = object : PushMessageInterface {
  override fun success(pushMessages: List<Message>) {
    // You can write your code here by using pushMessages
  }

  @Overrideoverride fun  public void fail(StringerrorMessage: errorMessageString) {
    Log.e("Past Notifications", errorMessage)
  }
};

RelatedDigital.getPushMessages(activity, pushMessageInterface);

Push Message Content

...

Veri Tipi

...

Değişken

...

Açıklama

...

String

...

mediaUrl

...

Photo, video url

...

String

...

altUrl

...

Alternate URL

...

String

...

campaignId

...

Campaign ID

...

String

...

pushId

...

Notification ID

...

String

...

url

...

Campaign URL

...

String

...

message

...

Notification Message

...

String

...

title

...

Notification Title

...

String

...

sound

...

Notification Sound

...

PushType

...

pushType

...

Notification Type

...

Map<String, String>

...

params

...

Java

Code Block

language	java

PushMessageInterface pushMessageInterface = new PushMessageInterface() {
  @Override
  public void success(List<Message> pushMessages) {
    // You can write your code here by using pushMessages
  }

  @Override
  public void fail(String errorMessage) {
    Log.e("Past Notifications", errorMessage)
  }
};

RelatedDigital.getPushMessages(activity, pushMessageInterface);

If you want to save and get the notifications based on user IDs you must set the userID value (email, telephone number, etc) after the user logins in your application via the method below:

Kotlin

Code Block

language	kotlin

RelatedDigital.setNotificationLoginID("user_id", context)

Java

Code Block

language	java

RelatedDigital.setNotificationLoginID("user_id", context);

After setting the userID like the one above, the notifications will be saved with that user ID. You can get the notifications sent to the user who is logged-in in your application by using the getPushMessagesWithID() method:

Kotlin

Code Block

language	kotlin

val pushMessageInterface: PushMessageInterface = object : PushMessageInterface {
  override fun success(pushMessages: List<Message>) {
    // Make your implementation by using pushMessages here:
  }

  override fun fail(errorMessage: String) {
    Log.e("Past Notifications", errorMessage)
  }
}

RelatedDigital.getPushMessagesWithID(activity, pushMessageInterface)

Java

Code Block

language	java

PushMessageInterface pushMessageInterface = new PushMessageInterface() {
  @Override
  public void success(List<Message> pushMessages) {
    // Make your implementation by using pushMessages here:
  }

  @Override
  public void fail(String errorMessage) {
    Log.e("Past Notifications", errorMessage)
  }
};

RelatedDigital.getPushMessagesWithID(activity, pushMessageInterface);

Push Message Content

Veri Tipi	Değişken	Açıklama
String	mediaUrl	Photo, video url
String	altUrl	Alternate URL
String	campaignId	Campaign ID
String	pushId	Notification ID
String	url	Campaign URL
String	message	Notification Message
String	title	Notification Title
String	sound	Notification Sound
PushType	pushType	Notification Type
Map<String, String>	params	Custom Parameters

Application Badge Count

The number of the notifications that come from Related Digital is shown on the application icon if the user chooses showing it as number. In order to clear this number when the application is opened, you should call clearBadgeCount() method as below:

Code Block
RelatedDigital.clearBadgeCount(context);

Code Block
RelatedDigital.clearBadgeCount(context)

Info
It is recommended to call the method above in onCreate() method of MainApplication and MainActivity classes so that when the application is opened the number gets cleared. Besides, it should be called in onNewIntent() method of the activity that the user will be directed to when he/she clicks on the notification.

Extra Notes

EXTERNAL_STORAGE Permissions

...

Versions Compared

Old Version 9

New Version Current

Key

Customization of the Notification Area

Token-User Match

Getting Push Notification Permission(Android 13 or higher)

Token-User Match

IYS E-Mail Registration (For Turkey)

IYS E-Mail Registration (For Turkey)

Push Notification Click Report and Directing

Push Notification Click Report and Directing

Custom Notification Sound

Campaign Revenue on the Panel

Push Message History

Custom Notification Sound

Campaign Revenue on the Panel

Push Message History

Push Message Content

Push Message Content

Application Badge Count

Extra Notes

EXTERNAL_STORAGE Permissions