Upgrading your iOS SDK

The following information is for customers upgrading from a previous versions of the iOS SDK to more recent versions.  

Upgrading from version 1.5 to 1.6.0

We have amended the original callback method:

Objective-C

   - (void)mainViewController:(nonnull GIDMainViewController *)mainViewController 
didCompleteProcessWithPayload:(nullable NSDictionary *)payload 
                   resultCode:(GIDResultCode)resultcode;

Swift

	public func mainViewController(_ mainViewController: GIDMainViewController, 
				  didCompleteProcessWithPayload payload: [AnyHashable : Any]?, 
											 resultCode: GIDResultCode)

To now look like:

Objective-C

   - (void)mainViewController:(nonnull GIDMainViewController *)mainViewController 
didCompleteProcessWithPayload:(nullable NSDictionary *)payload 
                   resultCode:(GIDResultCode)resultCode 
                        error:(nullable id <GIDErrorProtocol>)error;

Swift

	public func mainViewController(_ mainViewController: GIDMainViewController, 
  				  didCompleteProcessWithPayload payload: [AnyHashable : Any]?, 
											 resultCode: GIDResultCode, 
												  error: GIDErrorProtocol?)

We have added an error parameter. It is an object that conforms to the GIDErrorProtocol protocol. This object contains a few properties/functions to help identify exactly why, what, how an error occurred.

The error object will have an error code,  error.gidErrorCode, which will be one of the following:  

Version 1.12.0 of the greenId iOS SDK will not work as expected and there will be a requirement to update your respective application in order to accommodate the latest changes within the SDK.

Framework changes:

Version 1.12.0 requires updates to your project, to remove old frameworks and add new frameworks. 

• Remove the following two frameworks from your project:  IDMetrics.framework   MobileFlow.framework
• Add the following two frameworks as embedded binaries:  IDMetricsDocumentCapture.framework   IDMetricsSelfieCapture.framework
• Add the following bundle to your project: GIDResources.bundle - it should automatically go into the Copy Bundle Resources build phase.  

A complete guide on the bundle process that must be followed can be obtained here: 

• IOS GreenID SDK: GIDResources.bundle Configuration.

Additional errors:

A detailed GIDErrorCodeResourceBundle error message and a GIDResultCodeResourceBundle result code is sent back to the parent application when the condition that there is a missing or no resource bundle is met.

Configuration changes:

The configuration for the kGIDSDKSelfieScanResetTimeout parameter has changed to meet the following condition: 

• If the value is equal to or less than 0, the greenID iOS SDK will set the selfie capture mode to manual capture from the default semi-auto capture mode.

Deprecations:

This version has removed the callback method that was deprecated in version 1.6.0.  If you are still using the callback method from version 1.5 or earlier, it will no longer be called, and your app will not receive any notification when the greenID SDK hands off an error or verification result.  The correct delegate method to use is: 

 - (void)mainViewController:(nonnull GIDMainViewController *)mainViewController 
didCompleteProcessWithPayload:(nullable NSDictionary *)payload 
                   resultCode:(GIDResultCode)resultCode 
                        error:(nullable id <GIDErrorProtocol>)error;

App permissions:

Version 1.12.0 requires additional permissions from your app.  You should add a NSLocationWhenInUseUsageDescription key to your app's Info.plist file.  

Upgrading from version 1.12.0 or lower to version 1.13.0

• This version includes a new optional parameter. The documentCaptureResetTimeout parameter controls the amount of seconds after which the document scanning process will failover to manual capture mode. this allows the user to frame the document themselves, and manually tap the capture button.

  Constant	Effect
  kDefaultDocumentCaptureResetTimeOut	This value controls the amount of seconds after which the document scanning process will failover to manual capture mode, allowing the user to frame the document themselves, and manually tap the capture button.

Upgrading from version 1.13.0 or lower to version 1.13.8

• This version includes three new optional parameters, for setting the document capture timeouts for different document types: documentCaptureLicenceResetTimeout, documentCapturePassportResetTimeout, and documentCaptureGreenIDResetTimeout  
• The mode parameter is now compulsory.  The SDK will not start if the mode parameter is not set.  

Upgrading from version 1.13.8 or lower to version 1.14.1

This version has two new images (in 3 sizes each) included in the GIDResources.bundle.  You can update the GIDResources.bundle by replacing it with the new bundle provided, or if you have made customisations in your bundle, manually copy the crossIcon.png and tickIcon.png files into your copy of GIDResources.bundle. 

Upgrading from version 1.14.1 or lower to version 1.15.0

• This version has a new required framework to include: iFaceRec.framework.  Refer to the integration instructions for more details.  
• The Always embed Swift standard libraries build setting for your app should be updated to 'Yes'
• This version requires Xcode 9 to build.  Xcode 8 will not work with this version.  
• This version will only run on iOS 10 and 11 devices, due to one of our third party frameworks.  We will be remedying this in a future release.

Upgrading from version 1.15.0 or lower to version 1.16.0

• The Always embed Swift standard libraries build setting for your app can now be set to 'No' if you don't use Swift.  We have removed our Swift dependency. 
• This version now works with Xcode 8 and 9. 
• This version will only run on iOS 9, 10 and 11 devices, due to one of our third party frameworks.
• New versions of the Document capture, selfie capture and iFaceRec frameworks are included, be sure to copy the new frameworks into your project. 
• If you pass in incorrect startup parameters, the SDK will immediately handoff back to your app, with an error object that contains information on how to fix the problem. 
• If you have a custom background colour using custom CSS, make sure to set a matching background colour in the GID Resources bundle.  This will avoid a white strip at the top of some screens in landscape orientation. 

Upgrading from version 1.16.0 or lower to version 1.17.0

• This version will now run on iOS 8 to iOS 11.  
• A new version of the iFaceRec framework is included, be sure to copy the new framework into your project. 
• This version has updated images (in 3 sizes each) included in the GIDResources.bundle.  You can update the GIDResources.bundle by replacing it with the new bundle provided, or if you have made customisations in your bundle, manually copy the crossIcon.png and tickIcon.png files into your copy of GIDResources.bundle. 

Upgrading from version 1.17.0 or lower to version 1.17.1

• A new version of the Document capture and selfie capture framework is included, be sure to copy the new frameworks into your project. 
• There is an additional framework called MicroBlink.framework, which you will need to copy into your project, link and embed like the other frameworks. 
• There is a missing piece of text in the document capture tool - to fix this, you will need to add the following to your Localized.strings file:
  
  "second_overlay_licence_text_line1" = "";