PushMechanism (forgerock-authenticator 3.3.3 API)

java.lang.Object
- org.forgerock.android.auth.Mechanism
- - org.forgerock.android.auth.PushMechanism

All Implemented Interfaces:

java.lang.Comparable<Mechanism>
```
public class PushMechanism
extends Mechanism
```
Represents an instance of a Push authentication mechanism. Associated with an Account.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class PushMechanism.PushBuilder
Builder class responsible for building a Push mechanism.

Field Summary
- Fields inherited from class org.forgerock.android.auth.Mechanism
  OATH, PUSH

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static PushMechanism.PushBuilder`	`builder()`	Returns a builder for creating the Push Mechanism.
`static PushMechanism`	`deserialize(java.lang.String jsonString)`	Deserializes the specified Json into an object of the `PushMechanism` object.
`java.util.List<PushNotification>`	`getAllNotifications()`	Get all of the notifications that belong to this Push mechanism.
`java.util.List<PushNotification>`	`getPendingNotifications()`	Get pending notifications that belong to this Push mechanism.
`java.lang.String`	`toJson()`	Creates a JSON string representation of `ModelObject` object.

Methods inherited from class org.forgerock.android.auth.Mechanism
compareTo, equals, getAccountName, getId, getIssuer, getMechanismUID, getTimeAdded, getType, hashCode, matches

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getAllNotifications
```
public java.util.List<PushNotification> getAllNotifications()
```
    Get all of the notifications that belong to this Push mechanism.
    
    Returns:
    
    The list of notifications.
  - getPendingNotifications
```
public java.util.List<PushNotification> getPendingNotifications()
```
    Get pending notifications that belong to this Push mechanism.
    
    Returns:
    
    The list of notifications.
  - toJson
```
public java.lang.String toJson()
```
    Creates a JSON string representation of ModelObject object. Sensitive information are not exposed.
    
    Specified by:
    
    toJson in class Mechanism
    
    Returns:
    
    a JSON string object
  - deserialize
```
public static PushMechanism deserialize(java.lang.String jsonString)
```
    Deserializes the specified Json into an object of the PushMechanism object.
    
    Parameters:
    
    jsonString - the json string representing the object to be deserialized
    
    Returns:
    
    an PushMechanism object from the string. Returns null if jsonString is null, if jsonString is empty or not able to parse it.
  - builder
```
public static PushMechanism.PushBuilder builder()
```
    Returns a builder for creating the Push Mechanism.
    
    Returns:
    
    The PushMechanism builder.