Insider-ionic-plugin NPM

insider-ionic-plugin

Integration with Insider platform products. Bridge plugin with native Insider SDK's.

Install

npm install insider-ionic-plugin
npx cap sync

Setup

Insider SDK has some native requirements to run, so please follow the Dependencies and setup modules from native SDK's.

Android

Setup the project following the instructions in the Insider's Academy
Add the following dependencies in android/app/build.gradle file

dependencies {
  // ... all your projects other dependencies
  implementation 'com.useinsider:insider:14.2.4-nh'
  implementation 'com.useinsider:insiderhybrid:1.1.5'
}

iOS

Setup the project following the instructions in the Insider's Academy

Push Notifications

For this sdk push notification's config, click here

Insider Capacitor SDK Modules

Initialization

await initialize({partnerId: "insider", appGroup: "group.com.insider.capacitor.demotest"});

User

Usage example:

// User object attributes
await setName({ name: `insider` });
await setSurname({ surname: `capacitor-sdk` });
await setAge({ age: 25 });
await setGender({ gender: "female" });
await setBirthday({ birthday: "1996-06-25" }); //Data should be set in (YYYY-MM-DD) format.

await setFacebookID({ facebookId: "facebookId" });
await setTwitterID({ twitterId: "twitterId" });
await setLanguage({ language: "pt" });
await setLocale({ locale: "pt_BR" });

// Optins
await setEmailOptin({ emailOptIn: true });
await setSMSOptin({ smsOptin: true });
await setLocationOptin({ locationOptin: true });
await setPushOptin({ pushOptIn: true });

// Custom User Attributes
await setCustomAttributeWithBoolean({
  key: "boolean_parameter",
  value: false,
});
await setCustomAttributeWithDouble({
  key: "double_parameter",
  value: 20.5,
});
await setCustomAttributeWithInt({
  key: "int_parameter",
  value: 25,
});
await setCustomAttributeWithString({
  key: "string_parameter",
  value: "caaqui",
});
await setCustomAttributeWithArray({
  key: "array_parameter",
  value: ["capacitor", "insider", "ionic"],
});

await setCustomAttributeWithDate({
  key: "date_parameter",
  value: new Date().toISOString(),
});

// Identifiers
await setPhoneAsIdentifier({ phone: "+5511941231111" });
await setEmailIdentifier({ email: `mobile@insider.com` });
await setUserIdAsIdentifier({ uuid: id });
await login(); // Always call LOGIN after set all the identifiers needed. 

await logout();

Product/Track Revenue

   const product = new InsiderProduct(
      "productId",
      "name",
      ["category1"],
      "http://www.insider.com",
      100.0,
      "BRL"
    );
product  
      .setColor("red")
      .setGroupcode("groupcode")
      .setQuantity(1)
      .setStock(10)
      .setPromotionDiscount(0.1)
      .setPromotionName("promotionName")
      .setShippingCost(10.0)
      .setSize("size")
      .setVoucherDiscount(0.2)
      .setSalePrice(90.0);
      .addParameterWithArray("array_parameter", [
        "insider",
        "ionic",
        "capacitor",
      ])
      //custom product parameters
      .addParameterWithBoolean("boolean_parameter", false)
      .addParameterWithDate("date_parameter", new Date().toISOString())
      .addParameterWithDouble("double_parameter", 20.5)
      .addParameterWithInt("int_parameter", 25)
      .addParameterWithString("string_parameter", "caaqui")
    

    await itemAddedToCart({ product: product });
    await itemRemovedFromCart({ productId: "productId" });
    await itemPurchased({ product: product, saleId: "saleId" });
    await cartCleared();

Events

// Events
var event = new InsiderEvent("my_custom_event")
  .addParameterWithBoolean("boolean_parameter", false)
  .addParameterWithDouble("double_parameter", 20.5)
  .addParameterWithInt("int_parameter", 25)
  .addParameterWithString("string_parameter", "insider")
  .addParameterWithArray("array_parameter", [
    "insider",
    "ionic",
    "capacitor",
  ])
  .addParameterWithDate("date_parameter", new Date().toISOString());

await build({
  event: event,
});//Always call build to send event data. If you dont call build, event will not be sent.


// Page View Events

await visitHomePage();
await visitListingPage({taxonomy: ["category1", "category2","category3"]});
await visitProductDetailPage({ product: product });
await visitCartPage({ products: [product, product2] });

Push Notifications

Setup

API

initialize(...)

initialize(_options: { partnerId: string; appGroup?: string; quietPermission?: boolean; }) => Promise<{}>

Param	Type
`_options`	{ partnerId: string; appGroup?: string; quietPermission?: boolean; }

Returns: Promise<{}>

setPhoneAsIdentifier(...)

setPhoneAsIdentifier(_options: { phone: string; }) => Promise<{}>

Param	Type
`_options`	{ phone: string; }

Returns: Promise<{}>

setEmailIdentifier(...)

setEmailIdentifier(_options: { email: string; }) => Promise<{}>

Param	Type
`_options`	{ email: string; }

Returns: Promise<{}>

setUserIdAsIdentifier(...)

setUserIdAsIdentifier(_options: { uuid: string; }) => Promise<{}>

Param	Type
`_options`	{ uuid: string; }

Returns: Promise<{}>

visitHomePage()

visitHomePage() => Promise<{}>

Returns: Promise<{}>

visitListingPage(...)

visitListingPage(_options: { taxonomy: string[]; }) => Promise<{}>

Param	Type
`_options`	{ taxonomy: string[]; }

Returns: Promise<{}>

visitCartPage(...)

visitCartPage(_options: { products: InsiderProduct[]; }) => Promise<{}>

Param	Type
`_options`	{ products: InsiderProduct[]; }

Returns: Promise<{}>

visitProductDetailPage(...)

visitProductDetailPage(_options: { product: InsiderProduct; }) => Promise<{}>

Param	Type
`_options`	{ product: InsiderProduct; }

Returns: Promise<{}>

setGDPRConsent(...)

setGDPRConsent(_options: { consent: boolean; }) => Promise<{}>

Param	Type
`_options`	{ consent: boolean; }

Returns: Promise<{}>

setActiveForegroundPushView()

setActiveForegroundPushView() => Promise<{}>

Returns: Promise<{}>

receivedNotification(...)

receivedNotification(_options: { notification: PushNotificationSchema; }) => Promise<{}>

Param	Type
`_options`	{ notification: PushNotificationSchema; }

Returns: Promise<{}>