Skip to content

Calls⚓︎

Accounts⚓︎

Android iOS Description
AccountManager.getAccounts() NextAuth.accounts Retrieve a list of all accounts.
AccountManager.getAccountById() Retrieve a specific account by ID.
AccountManager.deleteAccount() NextAuth.deleteAccount() Delete an account.

App Login⚓︎

Android iOS Description
AppLogin.start() AppLogin.start() Start app login.
AppLogin.session Retrieve the app login session.
AppLogin.isLoggedIn() Check if the app login session is logged in.
AppLogin.hasStarted() Check if the app login session has been started.
AppLogin.getWebNonce() Retrieve the web nonce for the app login.
AppLogin.getUsername() Retrieve the username for the app login.
AppLogin.stop() AppLogin.stop() Log out of the app login.

History⚓︎

Android iOS Description
HistoryList.getList() NextAuth.history Retrieve all history, excluding active sessions and app logins.
HistoryList.getList(Date) NextAuth.history(after:) Retrieve all history after a certain date, excluding active sessions and app logins.
HistoryList.getList(int) NextAuth.history(for:) Retrieve all history for a specific account, excluding active sessions and app logins.
HistoryList.getRawList() NextAuth.rawHistory Retrieve all history.
HistoryList.getRawList(Date) NextAuth.rawHistory(after:) Retrieve all history after a certain date.
HistoryList.getRawList(int) NextAuth.rawHistory(for:) Retrieve all history for a specific account.

Note

The iOS Mobile SDK only introduced the raw history properties and calls in v1.0.2.

Push Messages⚓︎

Android iOS Description
NextAuth.processPushMessage() NextAuth.start(notification:) Process push message.
NextAuth.decryptPushMessage() Decrypt push message (without processing the push message).
NextAuth.retrieveMessages() NextAuth.retrieveMessages() Retrieve pending messages from the Message Center.
NextAuth.updatePushToken() NextAuth.updatePushToken() Update push token information.

Second Factor⚓︎

Android iOS Description
SFManager.canEnabledBiometrics() NextAuth.canEnableBiometrics() Check if biometrics can be enabled.
SFManager.hasEnabledBiometrics() NextAuth.hasEnabledBiometrics() Check if biometrics are enabled as second factor.
SFManager.sfInput() NextAuth.sfInput() Input PIN, biometrics or both.
SFManager.sfCancel() NextAuth.sfCancel() Cancel second factor input.
SFManager.sfBiometricsAdd() NextAuth.sfBiometricsAdd() Enable biometrics as second factor.
SFManager.sfBiometricsRemove() NextAuth.sfBiometricsRemove() Disable biometrics as second factor.
SFManager.sfChangePin() NextAuth.sfChangePIN() Change PIN.

PIN⚓︎

Android iOS Description
new PinContainer() PIN() Initialise a new PIN container, optionally include required length of the PIN.
PinContainer.addDigit() PIN.pushDigit() Appends a digit to the currently stored value.
PinContainer.removeDigit() PIN.popDigit() Removes the last digit from the currently stored value.
PinContainer.getLength() PIN.length Get the length of the currently stored value.
PinContainer.isComplete() Check if the currently stored value is of the required length.
PinContainer.isCommon() PIN.isCommon Check whether or not the currently stored value can be considered a commonly used PIN.
PinContainer.equals(PinContainer) PIN == PIN Check whether or not the stored values inside two PIN containers are the same.

Sessions⚓︎

Android iOS Description
SessionManager.getSessions() NextAuth.sessions Retrieve a list of all sessions.
SessionManager.getSession() Retrieve a specific session by ID.
SessionManager.isMobileSession() Check if the specific session was started on mobile.
SessionManager.start() NextAuth.start() Start a new session.
SessionManager.startUserInteraction() NextAuth.startUserInteraction() Start user interaction for a specific session.
SessionManager.setAccount() NextAuth.setAccount() Select an account to continue authentication for a specific session.
SessionManager.stop() NextAuth.stop() Stop a specific session.

User Interaction⚓︎

Android iOS Description
NextAuth.getUserInteraction() Method to retrieve the latest callback, for which NextAuth is currently waiting for user interaction (ConfirmEnrol,ConfirmLogin or SecondFactor), if any.

Tip

On Android, when your app goes to the background and the user opens your app again by pressing the app icon or notification, typically the Launcher activity is launched. By implementing this call in your Launcher activity, you can make sure that the user can continue their current nextAuth flow that requires user interaction.

QR Detection⚓︎

Android iOS Description
NextAuth.processQR() Detect QR code in an image, returning the data in the QR code.