hiku-cordova-plugin

Cordova iOS plugin for HikuSetupSDK in your app

  1. Description
  2. Installation 2. Automatically
  3. Usage

1. Description

This plugins allows you to make use of HikuSetupSDK

  • Works with Cordova >= 5.0.0

iOS specifics

  • Supported methods: initWithParameters, initWithAppId, startSetup, loginUserWithEmail, logoutUser, launchTipsFlow
  • initWithParameters, initWithAppId initiates SDK
  • startSetup allows to create a user account
  • All methods return data in callbacks if needed
  • Plugin using some libraries from cocoapods with cordova-plugin-cocoapod-support

2. Installation

Automatically

Latest github version

cordova plugin add https://github.com/hikuinc/hiuk_cordova_plugin.git

After installing plugin, build required

cordova build ios

Build may fail for some reason, please try xcode build when occurs.

3. Usage

The table gives an overview of basic operation compatibility:

Operation Comment iOS Android
initWithParameters SDK init only yes
initWithAppId SDK init only yes
startSetup interactive yes
loginUserWithEmail (email, password) yes
logoutUser yes
launchTipsFlow interactive yes

Basic operations, you'll want to copy-paste this for testing purposes:

Example 1 - basic

    var success = function(d){console.log(d)};
    var failure = function(e){console.log(e)}

    Hiku.initWithParameters(success, failure, {appId: 'XXX', addSecret: 'XXXX'});
    Hiku.startSetup(success, failure);

Example 2 - advanced options

    var params = {
        appId: 'XXX', 
        addSecret: 'XXXX', 
        email: 'email@email.com', 
        partnerLogo: '<logo url>'
    }

    Hiku.initWithParameters(success, failure, params);
    Hiku.startSetup(success, failure);

    Hiku.launchTipsFlow(success, failure);

Example Response IOS successful startSetup

    {success: true, message: "User authentication status: Success"}
    {success: true, message: "Application authorization status: Success Authorization", token: "XXX"}

    //when user cancels setup process
    {success: true, message: "User cancelled setup"}

Example Response IOS failed startSetup

    {success: false, message: "User authentication status: Failed"}
    {success: false, message: "Application authorization status: Failed", token: ""}