Page Comparison

...

• notificationSmallIcon: Int

• notificationSmallIconDarkMode: Int

• isNotificationLargeIcon: Boolean

• notificationLargeIcon: Int

• notificationLargeIconDarkMode

• notificationPushIntent: String

• notificationChannelName: String

• notificationColor: String

An example use that includes all parameters is below:

...

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

...

...

...

Getting Push Notification Permission(Android 13 or higher)

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

android {
    compileSdkVersion "33"

    defaultConfig {
        targetSdkVersion "33"
    }
}

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

Kotlin

RelatedDigital.requestNotificationPermission(activity)

Java

...

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

--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.
RelatedDigital.setIsPushNotification() metodu aracılığıyla Push Notification Modülü etkinleştirildiğinde, cihaza ait token bilgisi RMC veri tabanına yazılır. Bir token; kullanıcı uygulamada oturum açana kadar “anonim” yani hiç bir kullanıcı ile eşleştirilmeden kaydedilir. Bu token ın bir kullanıcıyla eşleştirilebilmesi için uygulamada oturum açılmış olması ve SDK tarafından bu token ın sahibini tanımlayıcı bir bilginin (KEY_ID yada EMAIL) RMC'ye gönderilmesi gerekir. Bu bilgiler push mesajı payload unda "extra" : {} bloğunda yer alır. 

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.

...

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

IYS E-Mail Registration (For Turkey)

Kotlin

...

...

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.

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

IYS E-Mail Registration (For Turkey)

Kotlin

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

  override fun fail(errorMessage: String?) {
    Log.e("IYS Kaydı", "Fail : $errorMessage")
  }
}

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

...

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) {
        val bundle = intent.extras
        if (bundle != null) {
            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
                ..
            } else {
                // It shows that a carousel notification is came and the user clicked on an item
                val itemClickedUrl = bundle.getString("CarouselItemClickedUrl")
                if (itemClickedUrl != null && itemClickedUrl != "") {
                    //Direct the user to the related page - itemClickedUrl
                    ..
                }
            }
        }
    }
}

...

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

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

Bildirim Sesi Ayarlama

...

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

Bu adımdan sonra ses dosyasının ismini uzantısız olarak RMC panelinde Ayarlar / Kampanya Ayarları / Push Uygulamaları / Android Uygulamanız / Özel Ses Dosyası kısmına eklemeniz gerekmektedir.

...

Ciroların Panele Yansıması

Gelen bildirimlere tıklandıktan sonra yapılan satın alımların RMC panelinde Ciro alanına yansıması için:

Mobil bildirim kampanyası ekranında bulunan Özel Parametreler alanına utm parametrelerini girmelisiniz.
Örn: utm_medium=apppush;utm_source=related;utm_campaign=campaign_name

...

utm_campaign her seferinde farklı olması gerektiği için oluşturduğunuz push kampanyasının ID’sini değişken olarak kullanabilirsiniz. Bunun için <##CAMP_ID##> değişkenini isteğe bağlı bir şekilde kullanabilirsiniz.

1. Image Removed

Geçmiş Bildirim Mesajları

Son 30 gün içerisinde gönderilmiş bildirim mesajlarına aşağıdaki gibi erişebilirsiniz.

Mesajlar tarihe göre sıralanmıştır. Son gelen mesaj listenin ilk başında gösterilir.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

1. 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

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

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

RelatedDigital.setNotificationLoginID("user_id", context)

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

val pushMessageInterface: PushMessageInterface = object : PushMessageInterface {
  override fun success(pushMessages: List<Message>) {
    // Make your pushMessagesimplementation değişkeniniby kullanarakusing geliştirmenizipushMessages yapabilirsinizhere:
  }

  override fun fail(errorMessage: String) {
    Log.e("GeçmişPast BildirimlerNotifications", errorMessage)
  }
}

RelatedDigital.getPushMessagesgetPushMessagesWithID(activity, pushMessageInterface)

...

PushMessageInterface pushMessageInterface = new PushMessageInterface() {
  @Override
  public void success(List<Message> pushMessages) {
    /// pushMessages değişkenini kullanarak geliştirmenizi yapabilirsiniz Make your implementation by using pushMessages here:
  }

  @Override
  public void fail(String errorMessage) {
    Log.e("GeçmişPast BildirimlerNotifications", errorMessage)
  }
};

RelatedDigital.getPushMessagesgetPushMessagesWithID(activity, pushMessageInterface);

...

Push Message Content

Ekstra Notlar

EXTERNAL_STORAGE İzinleri

...

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:

RelatedDigital.clearBadgeCount(context);

RelatedDigital.clearBadgeCount(context)

Extra Notes

EXTERNAL_STORAGE Permissions

You should add the line below into AndroidManifest.xml file under <application tag if you use WRITE_EXTERNAL_STORAGE and READ_EXTERNAL_STORAGE permissions in your application.

android:requestLegacyExternalStorage="true"

...

PUSH_SUBSCRIPTION_PERMISSION_ENABLED

Push uygulamasında login olan üyelerin direkt olarak Euromessage üye paneline aktarılması isteniyorsa; RMC Support ekibinden If you want to transfer the logged-in users in your push application to Euromessage user panel directly, you can ask RMS Support Team to enable PUSH_SUBSCRIPTION_PERMISSION_ENABLED flag inin açılması talep edilmelidir.

Example Application

RelatedDigital Example Application