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.

AppLogin⚓︎

Android iOS Description
AppLogin.start() AppLogin.start() Start AppLogin.
AppLogin.getSession() AppLogin.session Retrieve the AppLogin session.
AppLogin.stop() AppLogin.stop() Log out of the AppLogin.

Data⚓︎

Android iOS Description
DataService.getData() NextAuth.getData() Get data from the back-end Data Service for a given payload.

Flows⚓︎

Android iOS Description
FlowManager.start(byte[]) FlowService.start() Start a flow based on a QR code.
FlowManager.start(Uri) Start a flow based on a URI.
FlowManager.cancel() FlowService.cancel() Cancel the flow.
FlowManager.confirmSession() FlowService.confirmSession() Confirm the session (enrol).
FlowManager.confirmSession(Account) FlowService.confirmSession(with:) Confirm the session (login).
FlowManager.confirmTransaction(boolean) FlowService.confirmTransaction() Confirm the transaction.
FlowManager.inputSecondFactor() FlowService.inputSecondFactor() Provide the second factor: PIN, biometrics, or both.
FlowManager.getCryptoObject() Get the BiometricPrompt.CryptoObject.
FlowManager.getFlow() Get the currently active flow.
FlowService.flowPublisher Combine Publisher issuing Flow instances.

History⚓︎

Android iOS Description
HistoryList.getList() NextAuth.history Retrieve all history, excluding active sessions and AppLogins.
HistoryList.getList(Date) NextAuth.history(after:) Retrieve all history after the specified date, excluding active sessions and AppLogins.
HistoryList.getList(int) NextAuth.history(for:) Retrieve all history for the specified account, excluding active sessions and AppLogins.
HistoryList.getRawList() NextAuth.rawHistory Retrieve all history.
HistoryList.getRawList(Date) NextAuth.rawHistory(after:) Retrieve all history after the specified date.
HistoryList.getRawList(int) NextAuth.rawHistory(for:) Retrieve all history for the specified account.

Push Messages⚓︎

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

PIN⚓︎

Android iOS Description
new PinContainer() PIN() Initialise a new PIN container, optionally specifying the required length of the PIN.
PinContainer.pushDigit() PIN.pushDigit() Append a digit to the currently stored value.
PinContainer.popDigit() PIN.popDigit() Remove the last digit from the currently stored value.
PinContainer.reset() PIN.reset Reset the PIN container.
PinContainer.getLength() PIN.length Get the length of the currently stored value.
PinContainer.getRequiredLength() PIN.requiredLength Get the required length of the currently stored value.
PinContainer.isComplete() PIN.isComplete Return true if the currently stored value is of the required length.
PinContainer.isCommon() PIN.isCommon Return true if the currently stored value can be considered a commonly used PIN.
PinContainer.isZero() PIN.isZero Return true if the currently stored value is zero.
PinContainer.equals(PinContainer) PIN == PIN Return true if the stored values inside two PIN containers are the same.

QR Detection⚓︎

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

Reset⚓︎

Android iOS Description
NextAuth.reset() NextAuth.reset() Reset the state of the Mobile SDK and irreversibly remove all accounts, sessions, and history.

Second Factor⚓︎

Android iOS Description
SecondFactorManager.canChangePin() NextAuth.canChangePin() Check if the PIN can be changed.
SecondFactorManager.canEnabledBiometrics() NextAuth.canEnableBiometrics() Check if biometrics can be enabled.
SecondFactorManager.hasEnabledBiometrics() NextAuth.hasEnabledBiometrics() Check if biometrics are enabled as a second factor.
SecondFactorManager.sfBiometricsAdd() NextAuth.sfBiometricsAdd() Start a flow to enable biometrics as a second factor.
SecondFactorManager.sfBiometricsRemove() NextAuth.sfBiometricsRemove() Start a flow to disable biometrics as a second factor.
SecondFactorManager.sfChangePin() NextAuth.sfChangePIN() Start a flow to change the PIN.

Sessions⚓︎

Android iOS Description
SessionManager.getSessions() NextAuth.sessions Retrieve a list of all sessions.
SessionManager.getSession() Retrieve a specific session by ID.
SessionManager.isMobileSession() Return true if the specific session was started on the mobile device.
SessionManager.getToken() NextAuth.getToken() Request an upstream token.
SessionManager.stop() NextAuth.stop() Stop a specific session.

Transactions⚓︎

Android iOS Description
TransactionManager.create() NextAuth.create() Create a transaction signing flow (client-initiated) for the given transaction and given account.