Installation Guide

Android Installation Guide

In Android, the first step of the installation for OkayCam is to include the following dependencies in the project-level build.gradle file. The build.gradle file will need to make some changes as follow below:

allprojects {
    repositories {
        ...
        mavenCentral()
    }
}

Include the following dependencies in the app-level build.gradle file as shown below:

Note: Please make sure the SDK version tally with the provided license key.

dependencies{
    implementation 'com.innov8tif.okaycam:OkayCam:1.1.12'
}

After adding the code, sync the project with gradle files to make sure all of the dependencies are successfully installed.

For Android versions, we are actively published to Maven Repository. User can keep track of the version using the site.

Starting Camera

Camera can be launched by invoking start method on OkayCamDoc with context,config and callback method as follow
config object is optional if you call from Kotlin (refer to Configuration for more info)
after the image is captured or the user cancel, the callback method will be called (refer result)

OkayCamDoc.start(this,LICENSE_KEY, config) { success, images, exception ->
    // do something with the result
}

iOS Installation Guide

In iOS, OkayCam is available through the CocoaPods. The first step of the installation for OkayCam in iOS is to simply add the following line of code to your Podfiles as shown below:

Note: Please make sure the SDK version tally with the provided license key.

use_frameworks!
    pod 'OkayCam', '1.1.12'
    
    post_install do |installer|
        installer.pods_project.targets.each do |target|
            if target.name == "CryptoSwift"
                puts "Enable module stability for CryptoSwift"
                target.build_configurations.each do |config|
                    config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES' 
                end
            end
        end

After adding the code above to the Podfiles:

Run the command "pod install" to install the dependency
Add "NSCameraUsageDescription" to the info.plist in order to gain camera permissions

For iOS versions, we are actively published to Cocoapods. User can keep track of the version using the site. However, in the site, user will need to type in "OkayCam" in the search bar to view the latest version.

React-native Installation Guide

In React-native, the first step of the installation is to install the react-native OkayCam into the environment using the command below:

Note: Please make sure the SDK version tally with the provided license key.

$ react-native install [email protected]

For iOS in React-native:

Navigate to the iOS folder and add the following code to the Podfiles:

platform :ios, '11.0'
use_frameworks!

post_install do |installer|
    installer.pods_project.targets.each do |target|
        if target.name == "CryptoSwift"
			        puts "Enable module stability for CryptoSwift"
			        target.build_configurations.each do |config|
				            config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES' 
				    end
        end
    end
end

After adding the code above to the Podfiles:

Run the command "pod install" to install the dependency
Add "NSCameraUsageDescription" to the info.plist in order to gain camera permissions

For React-Native versions, we are actively published to npm. User can keep track of the version using the site.

Issues

Android:

There will be a duplicate class "org.hamcrest.xxx"

If the above error is encountered, it can be solved by excluding the "junit" module below:

configurations { compile.exclude group: "junit", module: "junit" }

iOS:

There will be several issues stated in the quote below:

Undefined symbol: _swift_FORCE_LOAD$_swiftUniformTypeIdentifiers
Undefined symbol: _swift_FORCE_LOAD$_swiftCoreMIDI

If users encountered the errors above, it can be solved by creating a new swift file called Void.swift without adding a bridging header.

License

After that, a license key is required for both Android and iOS by adding the code below:

const license = Platform.select({
    android: "",
    ios: ""
})

Please be aware of the codes and commands above are case sensitive.

PreviousGetting Started with OkayCam NextDevelopment Guide (Document Capture)

Last updated 24 days ago