Skip to content

Cordova Integration

Requirements

This setup assumes you have already setup your App Key on the Dashboard

Integration Steps

Install Pointzi in your Cordova project. Run this command in a console.

cordova plugin add cordova-plugin-pointzi

Put initial code to your device ready or platform ready handler, example:

Cordova

$(document).on('deviceready', function deviceIsReady() {
    /*Other Code */
    window.pointzi.load().then(function () {

         // CUID is optional.
         // You can set it later by sending sh_cuid tag. It is string tag.
         window.pointzi.register(APP_KEY, EVENT_KEY, CUID).then(function () {
              // Send String Tag
              let key = "first_name";
              let value = "My First Name";
              window.streethawk.tag.string(key, value);
         })
    })
    /*Other Code */
 });

Ionic 4

this.platform.ready().then(() => {
    /*Other Code */
    window.pointzi.load().then(function () {

        // CUID is optional.
        // You can set it later by sending sh_cuid tag. It is string tag.
        window.pointzi.register(APP_KEY, EVENT_KEY, CUID).then(function () {
            // Send String Tag
            let key = "first_name";
            let value = "My First Name";
            window.streethawk.tag.string(key, value);
        })
    })
    /*Other Code */
});

Note

To get your EVENT_KEY, go to dashboard.pointzi.com, click on SETUP->API->EVENT_KEY. To get your APP_KEY, go to dashboard.pointzi.com, where you can see it's name at the top left of the screen. CUID is the name you want to give to your install-id. This name is up to you. For more info visit the Tagging documentation. When you call register method, CUID is optional, you can set it later by sending sh_cuid tag, it is string tag.

User Tagging

You can tag users/devices from your SDK in one line of code.

The SDK looks after the details for the device, you just supply the tag key and value:

  • The tag name (key) is what you want to call it. In the example below "Plan-49" is how you will see this in the Pointzi Dashboard.
  • Pointzi supports tags of: string, numeric and datetime. In the example below, the value for "Plan-49" is "Trial-Period".

String Tags

let key = "Plan-49";
let value = "Trial-Period";
window.streethawk.tag.string(key, value);

Numeric Tags

let key = "BidValue";
let value = 549;
window.streethawk.tag.numeric(key, value);

Datetime Tags

// Tagging using predefined StreetHawk tag.
let key = "sh_registered";
let value = new Date();
window.streethawk.tag.datetime(key, value);

// Tagging using custom tag.
let key = "Birthday";
let value = new Date();
window.streethawk.tag.datetime(key, value);

Increment Tag Value

let key = "PageVisited";
window.streethawk.tag.increment(key);

Enable Youtube video

Add this to your config.xml

<!-- Add the whitelist plugin -->
<plugin name="cordova-plugin-whitelist" spec="~1.2.0" />
<!-- White list https access to Youtube -->
<allow-navigation href="https://*youtube.com/*"/>