forgerock-authenticator

4.4.0

forgerock-authenticator/org.forgerock.android.auth/PushNotification

PushNotification

open class PushNotification : ModelObject<T>

PushNotification is a model class which represents a message that was received from an external source. A notification could be raised against any mechanism. Currently used by Push mechanism.

Constructors

PushNotification

private constructor(mechanismUID: String, messageId: String, message: String, challenge: String, amlbCookie: String, timeAdded: Calendar, timeExpired: Calendar, ttl: Long, approved: Boolean, pending: Boolean, customPayload: String, numbersChallenge: String, contextInfo: String, pushType: PushType)

Creates the PushNotification object with given data

Types

PushNotificationBuilder

open class PushNotificationBuilder

Builder class responsible for producing Notifications.

Properties

val amlbCookie: String

The AM load balance cookie

private open var approved: Boolean

Determines if the PushNotification has been approved by the user.

val challenge: String

Base64 challenge that was sent with this notification

val contextInfo: String

The context information to this notification.

val customPayload: String

The JSON String containing the custom attributes added to this notification

Unique identifier for PushNotification object associated with the mechanism

val mechanismUID: String

Unique identifier of the Mechanism associated with this PushNotification

val message: String

Message that was received with this notification

val messageId: String

Message Identifier that was received with this notification

numbersChallenge

private val numbersChallenge: String

The numbers used in the push challenge

private open var pending: Boolean

Determines if the PushNotification has been interacted with the user.

private open var pushMechanism: PushMechanism

The mechanism associated with this notification

val pushType: PushType

The type of push notification

private val TAG: String

val timeAdded: Calendar

Date that the notification was received

val timeExpired: Calendar

Date that the notification has expired

Time to live for the notification

Functions

fun accept(@NonNull listener: FRAListener<Void>)

Accepts the push authentication request.

fun accept(@NonNull challengeResponse: String, @NonNull listener: FRAListener<Void>)

Accepts the push notification request with the challenge response.

fun accept(title: String, subtitle: String, allowDeviceCredentials: Boolean, @NonNull activity: FragmentActivity, @NonNull listener: FRAListener<Void>)

Accepts the push notification request with Biometric Authentication.

open fun builder(): PushNotification.PushNotificationBuilder

Returns a builder for creating a PushNotification.

open fun compareTo(another: PushNotification): Int

fun deny(@NonNull listener: FRAListener<Void>)

Deny any type of push authentication request.

open fun deserialize(jsonString: String): PushNotification

Deserializes the specified Json into an object of the PushNotification object.

open fun equals(o: Any): Boolean

open fun getDate(milliSeconds: Long): Calendar

Return date from milliseconds.

getNumbersChallenge

open fun getNumbersChallenge(): Array<Int>

Get numbers used for push challenge

getPushMechanism

open fun getPushMechanism(): PushMechanism

Gets the mechanism object associated with the notification.

open fun hashCode(): Int

open fun isApproved(): Boolean

Determine whether the authentication the notification is related to succeeded.

fun isExpired(): Boolean

Determine if the notification has expired.

open fun isPending(): Boolean

Determines if the PushNotification has been interacted with by the user.

open fun matches(other: PushNotification): Boolean

Returns true if the two objects would conflict if added to a storage system.

performAcceptDenyAsync

open fun performAcceptDenyAsync(approved: Boolean, listener: FRAListener<Void>)

open fun serialize(): String

Serializes the T object into its equivalent Json representation.

open fun setApproved(approved: Boolean)

Set if the authentication succeeded.

open fun setPending(pending: Boolean)

Set if the authentication is pending.

setPushMechanism

open fun setPushMechanism(mechanism: Mechanism)

Sets the mechanism object associated with the notification.

open fun toJson(): String

Creates a JSON string representation of T object.