- 23 Oct 2024
- 1 Minute to read
- DarkLight
Exposed APIs of the Orchestration SDK: Notification Registration
- Updated on 23 Oct 2024
- 1 Minute to read
- DarkLight
New APIs are created for Swift users of the iOS SDK. For more information, refer to the Xcode API documentation on NotificationRegistrationParameters and NotificationRegistrationDelegate.
The Customer Mobile Application can initialize a notification registration process by calling the startNotificationRegistration method of the Orchestrator object.
A NotificationRegistrationParams object must be provided as an input parameter of the startNotificationRegistration method; this NotificationRegistrationParams object must be initiated with the following parameters:
User identifier. A string which uniquely identifies the user on the OneSpan Trusted Identity platform.
Notification identifier. Uniquely identifies an app on a given device in the context of push-notification-based authentication. Defined by the notification service (i.e. Apple or Google).
An object implementing the NotificationRegistrationCallback interface.
The NotificationRegistrationCallback interface is used by the Orchestration SDK to interact with the Customer Mobile Application during the notification registration process. It exposes the following methods:
onNotificationRegistrationStepComplete: Called when a step of the notification registration process is complete. The provided orchestration command must be sent to the server.
onNotificationRegistrationSuccess: Called upon successful notification registration.
For more information about this feature, see Notification registration.