Self-Managed Integration

To make integrations easier the PushSDK automatically includes an extension of the FirebaseMessagingService class. However, you may have your own service and need to forward calls to the PushSDK in several scenarios including:

• Conflicts with other SDKs

• Conflicting third party development solutions

• Our messaging service conflicts with your existing architecture

We suggest that you only consider a self-managed integration if you need to customize the integration with FirebaseMessaging. If you choose to use a self-managed integration you will need to ensure that any new releases to the PushSDK do not add additional methods that must be called manually.

Integrating Your Own Messaging Service

First you will want to remove the service automatically added by the PushSDK and add your own to the app manifest file.

AndroidManifest.xml

<manifest 
    ...
    xmlns:tools="http://schemas.android.com/tools"
>
    <!-- Remove the PushSDK messaging service -->
    <service
        android:name="com.pushly.android.PNMessagingService"
        tools:node="remove" />

    <!-- Add your own messaging service -->
    <service
        android:name=".MyMessageService"
        android:exported="false">
        <intent-filter>
            <action android:name="com.google.firebase.MESSAGING_EVENT" />
        </intent-filter>
    </service>
</manifest>

Once you have added your own messaging service you'll also be required to place calls to the PushSDK to invoke the methods that are no longer automatically handled. If you do not implement all of the following methods the PushSDK may not function properly.

The methods you must call manually are:

• onNewToken(token: String)

• onMessageReceived(message: RemoteMessage)

Messaging Service Example

Kotlin

override fun onNewToken(token: String) {
    super.onNewToken(token)
    PushSDK.handleOnNewToken(token)
}

override fun onMessageReceived(message: RemoteMessage) {
    super.onMessageReceived(message)
    PushSDK.handleOnMessageReceived(message)
}

Java

@Override
public void onNewToken(@NonNull String token) {
    super.onNewToken(token);
    PushSDK.handleOnNewToken(token);
}

@Override
public void onMessageReceived(@NonNull RemoteMessage message) {
    super.onMessageReceived(message);
    PushSDK.handleOnMessageReceived(message);
}