Instructions to upgrade to iOS SDK version to 6.x
When upgrading from a version 5.x SDK to version 6.x, several changes have to be applied in your application.
Note: Starting from this version we removed the leading zeros from our versioning scheme. So the SDK uses the standard
major.minor.patch
versioning scheme.
Removed API's
ONGUserClient
enrollForMobileAuthentication:
andstoreDevicePushTokenInSession:
==> removed in favour forenrollForMobileAuth:
andenrollForPushMobileAuthWithDeviceToken:completion
. You can now enroll for mobile authentication without enrolling for push mobile authentication. Enrollment for push requires enrollment for mobile authentication to be done first.ONGMobileAuthEnrollmentErrorMissingDevicePushToken
==> the error is no longer returned
ONGPublicCommons
- file removedONGSDKInitializationException
==> removed in favour forNSInternalInconsistencyException
isEnrolledForMobileAuth
==>isUserEnrolledForMobileAuth:
isEnrolledForPushMobileAuth
==>isUserEnrolledForPushMobileAuth:
Removed deprecated API's
ONGUserClient
handleApplicationURL:
==>respondWithURL:challenge:
method ofid<ONGRegistrationRequestChallengeSender>
object provided by theONGRegistrationRequestChallenge
Registration redirect URL can now be passed to the sdk usingid<ONGRegistrationRequestChallengeSender>
, which makeshandleApplicationURL:
obsolete.
ONGRegistrationDelegate
userClient:didReceiveRegistrationRequestWithUrl:
==>userClient:didReceiveRegistrationRequestChallenge:
The URL is passed within theONGRegistrationRequestChallenge
object. It also provides a sender object used to respond with the redirect URL or to cancel the registration.
ONGClientBuilder
setUseEmbeddedWebView
==> No longer required. The Onegini SDK no longer distinguishes how the registration request URL is handled.
ONGPublicCommons
ONGCloseWebViewNotification
==> No longer required. Called only ifsetUseEmbeddedWebView
was set toYES
. The Onegini SDK no longer distinguishes how the registration request URL is handled. If the registration request URL was handled within a UIWebView, it could be closed as soon as you send a response to theONGRegistrationRequestChallengeSender
or when you receive theuserClient:didReceivePinRegistrationChallenge:
on yourONGRegistrationDelegate
.
Renamed API's
ONGUserClient
handleMobileAuthenticationRequest:delegate
==>handlePushMobileAuthRequest:delegate:
canHandleMobileAuthenticationRequest
==>canHandlePushMobileAuthRequest
ONGMobileAuthenticationRequest
==>ONGMobileAuthRequest
ONGMobileAuthenticationRequestDelegate
==>ONGMobileAuthRequestDelegate
didFailToHandleMobileAuthenticationRequest
==>didFailToHandleMobileAuthRequest
didHandleMobileAuthenticationRequest
==>didHandleMobileAuthRequest
ONGMobileAuthenticationEnrollmentErrorDomain
==>ONGMobileAuthEnrollmentErrorDomain
ONGMobileAuthenticationEnrollmentErrorUserNotAuthenticated
==>ONGMobileAuthEnrollmentErrorUserNotAuthenticated
ONGMobileAuthenticationEnrollmentErrorDeviceAlreadyEnrolled
==>ONGMobileAuthEnrollmentErrorDeviceAlreadyEnrolled
ONGMobileAuthenticationEnrollmentErrorEnrollmentNotAvailable
==>ONGMobileAuthEnrollmentErrorEnrollmentNotAvailable
ONGMobileAuthenticationEnrollmentErrorUserAlreadyEnrolled
==>ONGMobileAuthEnrollmentErrorUserAlreadyEnrolled
ONGMobileAuthenticationEnrollmentErrorMissingDevicePushToken
==>ONGMobileAuthEnrollmentErrorMissingDevicePushToken
ONGMobileAuthenticationEnrollmentErrorNotEnrolled
==>ONGMobileAuthEnrollmentErrorNotEnrolled
ONGMobileAuthenticationRequestErrorDomain
==>ONGMobileAuthRequestErrorDomain
ONGMobileAuthenticationRequestErrorNotFound
==>ONGMobileAuthRequestErrorNotFound
ONGMobileAuthenticationRequestErrorUserDisenrolled
==>ONGMobileAuthRequestErrorUserDisenrolled
Renamed errors
ONGSDKInitialisationErrorDeviceRegistrationFailed
==>ONGGenericErrorDeviceRegistrationFailure
ONGRegistrationErrorDeviceRegistrationFailure
==>ONGGenericErrorDeviceRegistrationFailure
Removed error domains
ONGSDKInitializationErrorDomain
The Initialization error domain is removed since it didn't contain any errors anymore after renaming & moving theONGSDKInitialisationErrorDeviceRegistrationFailed
error to theONGGenericErrorDomain
.