Launching

Triggering the QuickoSDK is the process of launching the tax solution within your app. This is typically done by calling the open method provided by the SDK. It’s important to note that the implementation of this method varies slightly between Android and iOS, catering to the specific requirements and conventions of each platform.

`open` method

Definition:

open([PlatformSpecific Param], JSONObject options)

Parameters

Platform Specific Param
- Android: android.content.Context
- iOS: UIViewController
options (Options): An object that configures the SDK’s behavior, user interface, and referral attribution. See the Options Object reference.

For referral attribution, pass your unique Cliq value in the top-level ref field of options. Replace YOUR_REF in the examples below with your value. See Affiliates to sign up and create it. Example Usage:

Java
Kotlin
Swift

import org.json.JSONObject;

// Constructing a JSONObject for the mobile number.
JSONObject mobileJson = new JSONObject();
mobileJson.put("isd", "91");
mobileJson.put("number", "9988774455");

// Constructing a JSONObject for the user.
JSONObject userJson = new JSONObject();
userJson.put("email", "[email protected]");
userJson.put("mobile", mobileJson);

// Constructing a JSONObject for the theme.
JSONObject themeJson = new JSONObject();
themeJson.put("mode", "dark");
themeJson.put("seed", "#2962FF");

// Constructing the root JSONObject which will contain the user and theme details.
JSONObject optionsJson = new JSONObject();
optionsJson.put("intent", "connect");
optionsJson.put("module", "com.quicko.it.file");
optionsJson.put("ref", "YOUR_REF");
optionsJson.put("user", userJson);
optionsJson.put("theme", themeJson);

// Triggering the FILE module with the constructed JSON options.
// The open() method in QuickoSDK is a suspend function.
// Suspend functions in Kotlin require an additional Continuation parameter when called from Java.
// Java does not natively support coroutines, so you must explicitly provide a Continuation instance.
// Below is an example of invoking the open() method with a "dummy" Continuation to handle or ignore the result.
QuickoSDK.INSTANCE.open(
    getApplicationContext(),  // Pass the application context as the first parameter
    optionsJson,              // Provide the JSONObject with options as the second parameter
    new Continuation<Unit>() { // Manually implement the Continuation interface for the third parameter
        @NotNull
        @Override
        public CoroutineContext getContext() {
            // Returning an empty coroutine context as no specific context is required here.
            return EmptyCoroutineContext.INSTANCE;
        }

        @Override
        public void resumeWith(@NotNull Object result) {
            // This method is called when the suspend function completes.
            // The 'result' parameter can contain either the success result or an exception:
            // - If successful, result will be of type Unit.
            // - If an exception occurred, result will be an instance of Result.Failure.
            // For simplicity, you can leave this method empty since you don't need to handle the outcome.
        }
    }
);

import org.json.JSONObject

// Creating a JSONObject for the mobile.
val mobileJson = JSONObject().apply {
    put("isd", "91")
    put("number", "9988774455")
}

// Creating a JSONObject for the user.
val userJson = JSONObject().apply {
    put("email", "[email protected]")
    put("mobile", mobileJson)
}

// Creating a JSONObject for the theme.
val themeJson = JSONObject().apply {
    put("mode", "dark")
    put("seed", "#2962FF")
}

// Creating the root JSONObject which will include user and theme.
val optionsJson = JSONObject().apply {
    put("intent", "connect")
    put("module", "com.quicko.it.file")
    put("ref", "YOUR_REF")
    put("user", userJson)
    put("theme", themeJson)
}

// Triggering the FILE module with the constructed JSON options.
QuickoSDK.INSTANCE.open(context, optionsJson)

import Foundation
import income_tax_sdk

// Creating a dictionary for the mobile.
let mobileJson: [String: Any] = [
    "isd": "91",
    "number": "9988774455"
]

// Creating a dictionary for the user.
let userJson: [String: Any] = [
    "email": "[email protected]",
    "mobile": mobileJson
]

// Creating a dictionary for the theme.
let themeJson: [String: Any] = [
    "mode": "dark",
    "seed": "#2962FF"
]

// Creating the root dictionary which will include user and theme.
let optionsJson: [String: Any] = [
    "intent": "connect",
    "module": "com.quicko.it.file",
    "ref": "YOUR_REF",
    "user": userJson,
    "theme": themeJson
]

// Triggering the FILE module with the constructed JSON options.
QuickoSDK.open(context: context, options: optionsJson)

Error Handling

IllegalArgumentException

This exception is thrown when the API key has not been set before invoking the open method, and if your intent is connect.

Example:

Java
Kotlin
Swift

try {
    QuickoSDK.open(myContext, myModule);
} catch (IllegalArgumentException iEA) {
    System.out.println("Error: API Key has not been set.");
}

try {
    QuickoSDK.open(myContext, myOptions)
} catch (e: IllegalArgumentException) {
    println("Error: API Key has not been set.")
}

do {
    try QuickoSDK.open(controller: myController, options: myOptions)
} catch let error as IllegalArgumentException {
    print("Error: API Key has not been set.")
} catch {
    // Handle other potential errors if any.
}

In the above example, if the API key hasn’t been set before calling the open method, the IllegalArgumentException will be thrown, and the error message “Error: API Key has not been set.” will be printed.

Recommendations

Best Practices

Always ensure that the API key has been set using the setAPIKey method before invoking the open method.
It’s a good practice to wrap the open method call inside a try-catch block to handle the IllegalArgumentException and provide feedback to the user or log the error for debugging purposes.

Getting started

OAuth

Open APIs

Integration

Events

Notifications

`open` method

Parameters

IllegalArgumentException

Best Practices

​open method

​Parameters

IllegalArgumentException

Best Practices

`open` method

Parameters