VaultMobileSDK  18R3
iOS framework for Vault API
Classes | Typedefs
VEVVaultAuth.h File Reference

Go to the source code of this file.

Classes

class  VEVVault
 An object type that refers to a particular Vault. VEVVaultAuth::currentUser tracks the authenticated user's list of available vaults and several methods throughout VaultMobileSDK require a VEVVault parameter as a means of specifying a Vault to apply operations to. More...
 
class  VEVUser
 An object type that refers to a Vault user. This is used primarily to track information about the currently authenticated user. More...
 
protocol  <VEVPasscodeManagerDelegate >
 The delegate to notify of events sent from VEVVaultAuth's lock screen view. More...
 
class  VEVVaultAuth
 A singleton class that manages Vault authentication. More...
 

Typedefs

typedef void(^ VEVVaultAuthLoginResultHandler) (VEVUser *_Nullable user, NSError *_Nullable error)
 The block type used to call back to the application after a login attempt has succeeded or failed. More...
 
typedef void(^ VEVVaultAuthRefreshUserResultHandler) (VEVUser *_Nullable user, NSError *_Nullable error)
 The block type used to call back to the application when refreshing the current user's information from Vault. More...
 
typedef void(^ VEVVaultAuthLogoutHandler) (VEVUser *user)
 The block type used to call back to the application when the user is logged out. More...
 

Detailed Description

Typedef Documentation

◆ VEVVaultAuthLoginResultHandler

typedef void(^ VEVVaultAuthLoginResultHandler) (VEVUser *_Nullable user, NSError *_Nullable error)

The block type used to call back to the application after a login attempt has succeeded or failed.

Parameters
userThe current user object if authenticated, or nil.
errorThe error object in the event an error occurred during login.
See also
VEVVaultAuth:authenticateWithHandler.

◆ VEVVaultAuthRefreshUserResultHandler

typedef void(^ VEVVaultAuthRefreshUserResultHandler) (VEVUser *_Nullable user, NSError *_Nullable error)

The block type used to call back to the application when refreshing the current user's information from Vault.

Parameters
userThe user object representing the current user or nil if the user has logged out.
errorThe error object in the event an error occurred refreshing the current user's vaults.

◆ VEVVaultAuthLogoutHandler

typedef void(^ VEVVaultAuthLogoutHandler) (VEVUser *user)

The block type used to call back to the application when the user is logged out.

Parameters
userThe user object representing the user that was logged out.