SalesforceSDK/com.salesforce.androidsdk.push/PushMessaging

PushMessaging

This class provides utility functions related to push notifications, such as methods for registration, unregistration, and storage and retrieval of push notification registration information from a private shared preference file.

Properties

reRegistrationRequested

@JvmStatic

var reRegistrationRequested: Boolean

UNREGISTERED_ATTEMPT_COMPLETE_EVENT

const val UNREGISTERED_ATTEMPT_COMPLETE_EVENT: String

UNREGISTERED_EVENT

const val UNREGISTERED_EVENT: String

Functions

clearRegistrationInfo

@JvmStatic

fun clearRegistrationInfo(context: Context, account: UserAccount?)

Clears the stored registration information.

clearSFDCRegistrationInfo

fun clearSFDCRegistrationInfo(context: Context, account: UserAccount?)

Clears the stored SFDC device ID.

getAppNameForFirebase

fun getAppNameForFirebase(context: Context): String

Get the app unique name for firebase

getDeviceId

@JvmStatic

fun getDeviceId(context: Context, account: UserAccount?): String?

Returns the SFDC registration ID for the specified user account.

getNotificationsTypes

@JvmStatic

fun getNotificationsTypes(userAccount: UserAccount): NotificationsTypesResponseBody?

Returns Salesforce notifications types for the provided user account.

getRegistrationId

@JvmStatic

fun getRegistrationId(context: Context, account: UserAccount?): String?

Returns the current registration ID, or null, if registration hasn't taken place yet.

isInProgress

fun isInProgress(context: Context, account: UserAccount?): Boolean

Returns whether push notification registration/un-registration is in progress.

isRegistered

@JvmStatic

fun isRegistered(context: Context, account: UserAccount?): Boolean

Returns whether the specified user account is currently registered or not.

isRegisteredWithSFDC

fun isRegisteredWithSFDC(context: Context, account: UserAccount?): Boolean

Returns whether the user account is registered with SFDC or not.

onPushReceiverSetup

@JvmStatic

fun onPushReceiverSetup(context: Context)

@JvmStatic

fun register(context: Context, account: UserAccount?)

@JvmStatic

fun register(context: Context, account: UserAccount?, recreateKey: Boolean)

Initiates push registration, if the application is not already registered. Otherwise, this method initiates registration/re-registration to the SFDC endpoint, in order to keep it alive, or to register a new account that just logged in.

registerSFDCPush

@JvmStatic

fun registerSFDCPush(context: Context, account: UserAccount?)

Initiates push registration against the SFDC endpoint.

setLastRegistrationTime

fun setLastRegistrationTime(context: Context, lastRegistrationTime: Long, account: UserAccount?)

Sets the last time SFDC registration was successful for the specified user account.

setRegistrationId

@JvmStatic

fun setRegistrationId(context: Context, registrationId: String?, account: UserAccount?)

Stores the GCM registration ID, and resets back off time.

setRegistrationInfo

@JvmStatic

fun setRegistrationInfo(context: Context, registrationId: String?, deviceId: String?, account: UserAccount?)

Stores the current registration information, and resets the backoff time.

unregister

@JvmStatic

fun unregister(context: Context, account: UserAccount?, isLastAccount: Boolean)

Performs SFDC un-registration from push notifications for the specified user account. Performs GCM un-registration only if this is the last account being logged out.