pingonemfa/com.pingidentity.pingonemfa.push/PushNotification

PushNotification

data class PushNotification(val id: String = UUID.randomUUID().toString(), val notificationObject: NotificationObject, val title: String?, val message: String?) : Parcelable

Wrapper model for a PingOne MFA push authentication request.

Produced by com.pingidentity.pingonemfa.commons.PingOneMFA.processRemoteNotification from an incoming FCM com.google.firebase.messaging.RemoteMessage. All user-facing operations (approve, deny) are exposed as suspend functions that return Result.

Constructors

PushNotification

constructor(id: String = UUID.randomUUID().toString(), notificationObject: NotificationObject, title: String?, message: String?)

constructor(parcel: Parcel)

Restores a PushNotification from a Parcel. Used internally by CREATOR; not intended for direct use.

Types

CREATOR

object CREATOR : Parcelable.Creator<PushNotification>

Properties

val id: String

Wrapper-generated unique identifier for this push request.

message

val message: String?

Notification body extracted from the FCM data payload, or null if absent.

notificationObject

val notificationObject: NotificationObject

title

val title: String?

Notification title extracted from the FCM data payload, or null if absent.

Functions

approveNotification

suspend fun approveNotification(context: Context, authenticationMethod: String, numberChallenge: Int? = null): Result<Unit>

Approves this push authentication request.

denyNotification

suspend fun denyNotification(context: Context): Result<Unit>

Denies this push authentication request.

describeContents

open override fun describeContents(): Int

No file descriptors are contained in this parcel.

getNumbersChallenge

fun getNumbersChallenge(): IntArray?

Returns the server-provided number options for a PushType.CHALLENGE push, or null when free-form digit entry is expected instead.

getPushType

fun getPushType(): PushType

Returns the PushType that describes the interaction model required by this push. UI components should switch on this to decide which approval flow to present.

isCancelAuthentication

fun isCancelAuthentication(): Boolean

Returns true when the server has canceled this authentication request — for example, because the user approved it on another device.

writeToParcel

open override fun writeToParcel(parcel: Parcel, flags: Int)

Flattens this object into a Parcel. Fields are written in the same order they are read in the Parcel constructor.