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

PushNotificationBuilder

open class PushNotificationBuilder

Builder class responsible for producing Notifications.

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
private open var amlbCookie: String
Link copied to clipboard
private open var approved: Boolean
Link copied to clipboard
private open var challenge: String
Link copied to clipboard
private open var contextInfo: String
Link copied to clipboard
private open var customPayload: String
Link copied to clipboard
private open var mechanism: Mechanism
Link copied to clipboard
private open var mechanismUID: String
Link copied to clipboard
private open var message: String
Link copied to clipboard
private open var messageId: String
Link copied to clipboard
private open var numbersChallenge: String
Link copied to clipboard
private open var pending: Boolean
Link copied to clipboard
private open var pushType: PushType
Link copied to clipboard
private open var timeAdded: Calendar
Link copied to clipboard
private open var timeExpired: Calendar
Link copied to clipboard
private open var ttl: Long

Functions

Link copied to clipboard
protected open fun build(): PushNotification
Build the notification.
Link copied to clipboard
open fun setAmlbCookie(amlbCookie: String): PushNotification.PushNotificationBuilder
Set the he AM load balance cookie with this notification.
Link copied to clipboard
open fun setApproved(approved: Boolean): PushNotification.PushNotificationBuilder
Sets whether the authentication the notification is related to was approved.
Link copied to clipboard
open fun setChallenge(challenge: String): PushNotification.PushNotificationBuilder
Set the challenge that was sent with this notification.
Link copied to clipboard
open fun setContextInfo(contextInfo: String): PushNotification.PushNotificationBuilder
Sets context information for this notification.
Link copied to clipboard
open fun setCustomPayload(customPayload: String): PushNotification.PushNotificationBuilder
Sets custom attributes associated with this notification.
Link copied to clipboard
open fun setMechanismUID(mechanismUID: String): PushNotification.PushNotificationBuilder
Sets the mechanism unique Id.
Link copied to clipboard
open fun setMessage(message: String): PushNotification.PushNotificationBuilder
Sets the message that was received with this notification.
Link copied to clipboard
open fun setMessageId(messageId: String): PushNotification.PushNotificationBuilder
Sets the message id that was received with this notification.
Link copied to clipboard
open fun setNumbersChallenge(numbersChallenge: String): PushNotification.PushNotificationBuilder
Sets the numbers used in the Push challenge.
Link copied to clipboard
open fun setPending(pending: Boolean): PushNotification.PushNotificationBuilder
Sets whether the authentication the notification is related to has been handled.
Link copied to clipboard
open fun setPushType(pushType: String): PushNotification.PushNotificationBuilder
Sets the type of Push notification.
Link copied to clipboard
open fun setTimeAdded(timeAdded: Calendar): PushNotification.PushNotificationBuilder
Sets the date that the notification was received.
Link copied to clipboard
open fun setTimeExpired(timeExpired: Calendar): PushNotification.PushNotificationBuilder
Sets the date that the notification will automatically fail.
Link copied to clipboard
open fun setTtl(ttl: Long): PushNotification.PushNotificationBuilder
Sets the time to live for the notification.