SDK v1.3 → v1.4 Migration

This guide lists the code changes needed to upgrade an existing v1.3.x integration to v1.4.0, per platform.

iOS

1. CameraViewModel → CameraController

// v1.3.x (deprecated)
@StateObject private var viewModel: CameraViewModel
CameraView(viewModel: viewModel)

// v1.4.0
@StateObject private var controller: CameraController 
CameraView(controller: controller)                    

CameraViewModel is a deprecated typealias of CameraController. Change CameraView(viewModel:) to CameraView(controller:) as well.

2. Move the license to the constructor

Passing the license via initializeCamera(licenseInfo:) is deprecated. Inject licenseInfo into the constructor and call initializeCamera without the license argument.

// v1.3.x (deprecated)
let controller = CameraController(species: .dog, cameraPurpose: .forRegisterFromProfile)
try await controller.initializeCamera(
    licenseInfo: LicenseInfo(apiKey: "YOUR_API_KEY", isDebugMode: false),
    initialPosition: .back,
    captureSessionId: sessionId,
)

// v1.4.0
let controller = CameraController( 
    configuration: DetectionConfiguration(species: .dog, purpose: .petProfileRegistration), 
    licenseInfo: LicenseInfo(apiKey: "YOUR_API_KEY", isDebugMode: false), 
)
try await controller.initializeCamera(initialPosition: .back, captureSessionId: sessionId) 

3. Teardown: stopDetection() → finalizeCamera()

// v1.3.x (deprecated)
controller.stopDetection()

// v1.4.0
controller.finalizeCamera() 

startDetectionSession() was also renamed to startDetection() (used to re-capture).

4. DetectionStatus adds .finished

DetectionStatus has a .finished case. A non-exhaustive switch will fail to compile, so handle .finished or add a default.

switch controller.detectionStatus {
case .noObject, .processing, .detected: break
case .finished: break          // added
case .failed(let reason): handle(reason)
}

iOS change summary

See Basic Usage for details.

Android

1. PetnowUiClient removed → per-session passing

// v1.3.x (removed — compile error)
PetnowUiClient.initialize(apiKey = "YOUR_API_KEY", isDebugMode = false)
PetnowUiClient.configureDetection(DetectionConfiguration(/* ... */))

• Recommended (CameraView + CameraController): pass LicenseInfo to the CameraController(context, license, scope) constructor and DetectionConfiguration to initializeCamera(config, captureSessionId). → Basic Usage
• Keep the existing PetnowCameraFragment: pass the license via Fragment args (ARG_API_KEY/ARG_IS_DEBUG_MODE) or provideLicense(), and the configuration via ARG_DETECTION_CONFIGURATION. → Fragment (legacy)

PetnowUiClient.isSuccessInitialize was also removed.

2. Listener import package changed

// v1.3.x
import io.petnow.ui.PetnowCameraDetectionListener

// v1.4.0
import io.petnow.callback.PetnowCameraDetectionListener      
// V2: import io.petnow.callback.PetnowCameraDetectionListenerV2

3. (Recommended) Move to the V2 listener

On the CameraController path, use setDetectionListenerV2 (V2). V2 delivers DetectionStatus (sealed: NoObject/Processing/Detected/Finished/Failed(reason)) and CameraResult (Success(fingerprintImageFiles, appearanceImageFiles)/Fail).

Android change summary

See Basic Usage and Fragment (legacy) for details.

Migration checklist

iOS

• CameraViewModel → CameraController, CameraView(viewModel:) → (controller:)
• Move the license to the constructor (CameraController(configuration:licenseInfo:)); drop the license arg from initializeCamera
• stopDetection() → finalizeCamera(), startDetectionSession() → startDetection()
• Handle .finished in DetectionStatus switches

Android

• Remove PetnowUiClient calls → pass license/config per session
• Change the listener import to io.petnow.callback
• (Recommended) Move to CameraView + CameraController + the V2 listener