#import <Foundation/Foundation.h>
|
| enum | GDReAuthResult {
GDReAuthResultSuccess,
GDReAuthResultErrorFailedAuth,
GDReAuthResultErrorUserCancelled,
GDReAuthResultErrorExpired,
GDReAuthResultErrorInProgress,
GDReAuthResultErrorNotSupported,
GDReAuthResultErrorInvalidRequest,
GDReAuthResultErrorUnknown
} |
| | BlackBerry reauthentication result type. More...
|
| |
| enum | GDReAuthType {
GDReAuthTypeNone,
GDReAuthTypeNoPassword,
GDReAuthTypePassword,
GDReAuthTypeBiometric,
GDReAuthTypeGracePeriod,
GDReAuthTypeTrustedAuthenticator
} |
| | BlackBerry reauthentication result type. More...
|
| |
◆ GDReAuthResult
Use constants in this enumeration to get the Reauthentication result with the NSNotification. getReauthenticationResult: (GDAuthenticationManager) function always returns one of these values.
| Enumerator |
|---|
| GDReAuthResultSuccess | Reauthentication has been successful.
|
| GDReAuthResultErrorFailedAuth | Reauthentication failed due to incorrect credential.
|
| GDReAuthResultErrorUserCancelled | Reauthentication was cancelled by the user.
|
| GDReAuthResultErrorExpired | Reauthentication request expired as the user didn't respond.
|
| GDReAuthResultErrorInProgress | Reauthentication is already in use. The user needs to cancel or complete the previous request to proceed with a new one.
|
| GDReAuthResultErrorNotSupported | Reauthentication is not supported yet. In certain situations, when an application uses Authentication Delegation, the other BlackBerry Dynamics application used for authentication may be based on an older runtime version which doesn't support this feature. The application developer should consider such case and provide correct error handling mechanism for this Result type.
|
| GDReAuthResultErrorInvalidRequest | Reauthentication request contains invalid parameters.
|
| GDReAuthResultErrorUnknown | Reauthentication request failed for unknown reason.
|
◆ GDReAuthType
Use constants in this enumeration to get the Reauthentication type which was used for reauthentication. One of the following will be returned. The next getReauthenticationType: (GDAuthenticationManager) function always returns one of these values.
| Enumerator |
|---|
| GDReAuthTypeNone | None. Default value which will be used by default when reauthentication request returns with error.
|
| GDReAuthTypeNoPassword | User is not required to set a password by policy. The user has just acknowledged the request without providing a credential.
|
| GDReAuthTypePassword | User authenticated with a password.
|
| GDReAuthTypeBiometric | User authenticated with biometrics.
|
| GDReAuthTypeGracePeriod | User has recently authenticated within the grace period.
|
| GDReAuthTypeTrustedAuthenticator | User has authenticated with the help of a Trusted Authenticator Application.
|
◆ GDReAuthenticationResultNotification
| NSString* const _Nonnull GDReAuthenticationResultNotification |
The name of the notification for which to register an observer.
UserInfo dictionary from GDReAuthenticationResultNotification contains the following:
- token - specific request token, enables the caller to associate an event with a specific call to the interface (as interface will synchronously return with a token for that call)
- result - denotes whether user was successfully authenticated and provides details of any error. See GDReAuthResult.
- authType - indicates how user was authenticated. See GDReAuthType.
To get the reauthenticate results from the notification, use these convenient methods from GDAuthenticationManager:
- getReauthenticationToken
- getReauthenticationResult
- getReauthenticationType
