moe-push-firebase/com.moengage.firebase/MoEFireBaseHelper

MoEFireBaseHelper

class MoEFireBaseHelper

Helper class for MoEngage Firebase Module.

Author

Umang Chamaria

Since

9.4.00

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
fun addInstallationIdListener(listener: InstallationIdAvailableListener)

Register a listener to receive a callback whenever a Firebase Installation Id is available.

Link copied to clipboard
fun addNonMoEngagePushListener(listener: NonMoEngagePushListener)

Register a listener to receive a callback whenever a push is received which isn't from MoEngage.

Link copied to clipboard
fun addTokenListener(listener: TokenAvailableListener)

Register a listener to receive a callbacks whenever a token is generated or updated.

Link copied to clipboard
fun generatePushToken(listener: OnFcmRegistrationCompleteListener)

Generates Push Token.

Link copied to clipboard
@JvmOverloads
@WorkerThread
fun getInstallationId(context: Context, workspaceId: String? = null): String?

Get saved Firebase Installation Id(if any) for the account configured as default.

Link copied to clipboard
fun getPushToken(context: Context): String?

Get saved Push Token(if any) for the account configured as default.

fun getPushToken(context: Context, appId: String): String?

Get saved Push Token(if any) for the given account.

Link copied to clipboard
@JvmOverloads
fun passInstallationId(context: Context, installationId: String, workspaceId: String? = null): MoETask<FirebaseInstallationIdResult>

Helper API to pass a Firebase Installation Id to the MoEngage platform for the account configured as default.

Link copied to clipboard
fun passPushPayload(context: Context, payload: Bundle): MoETask<PushBundlePayloadResult>
fun passPushPayload(context: Context, payload: Map<String, String>): MoETask<PushMapPayloadResult>

Pass the payload received from FCM to the MoEngage SDK for showing Push Notification.

Link copied to clipboard
fun passPushToken(context: Context, token: String): MoETask<PushTokenResult>
fun passPushToken(context: Context, token: String, appId: String): MoETask<PushTokenResult>

Helper API to pass the push token to the MoEngage platform.

Link copied to clipboard
fun registerForInstallationId(context: Context)

API to register for a Firebase Installation Id. Call this API only if you are delaying the SDK initialisation else this is not required.

Link copied to clipboard
fun registerForToken(context: Context)

API to register for FCM Token. Call this API only if you are delaying the SDK initialisation else this is not required.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Generated by Dokka
© 2026 Copyright