Newton's Preposterous Miscalculation
Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

fpt-akainsights-react-native

0.0.10 • Public • Published

AKAInsights JavaScript SDK - React Native Plugin

Supports Android, iOS Lean Core Extracted

React Native Aka Insight API for Android, iOS It allows you to get information on:

  • Finish my changes
  • Push my commits to GitHub
  • Open a pull request

Prerequisites

  • This plugin will only work in react-native apps, e.g. it will not work with expo.
  • React-Native v0.59.0 -> v0.62.*

Getting started

This plugin relies on @react-native-community/async-storage, @react-native-community/geolocation, @react-native-community/netinfo, react-native-device-info
You must install and link all this packages.
NOTE: Keep react-native-device-info up-to-date to collect the latest device names using your app.

Install the library using either Yarn:

yarn add fpt-akainsights-react-native

or npm:

npm install --save fpt-akainsights-react-native

Initializing the Plugin

To use this plugin, you only need to construct the plugin and add it as an extension to your existing Application Insights instance.

import {Initial} from 'fpt-akainsights-react-native';
 
Initial({clientId: 'YOUR_CLENT_ID', clientSecret: 'YOUR_CLIENT_SECRET'});
 
const App = () => {
    // Your code
}

Event API usage

  1. Send event behavior registration
import {Events} from 'fpt-akainsights-react-native';
 
const CategoryViewComponent = () => {
 
    ...
 
    const handleCategoryList = () => {
        // Import this line in your code for display category list
        Events.categoryView({
            categoryId: 'YOUR_CATEGORY_ID',
            categoryName: 'YOUR_CATEGORY_NAME',
            ...
        });
    }
    
    return (...)
}

Full attributes for category view event

Attribute Type Required
categoryId string x
categoryName string x
category1 string
category2 string
category3 string
categoriesPath string
language string
location string
domain string
userId string
campaignId string

Enumeration

Enums Data
ActionEnum ADD, REMOVE, EMPTY
PageTypeEnum PRODUCT, HOME_PAGE, CATEGORY, PAGE, CHECKOUT
PaymentTypeEnum BANK_TRANSFER, ONLINE_PAYMENT, CASH, COD
PurchaseSourceTypeEnum ONLINE, STORE
ShippingTypeEnum COURIER, NORMAL_DELIVERY
StatusEnum SENT, DELIVERED, CLICKED

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

Install

npm i fpt-akainsights-react-native

DownloadsWeekly Downloads

0

Version

0.0.10

License

MIT

Unpacked Size

76 kB

Total Files

83

Last publish

Collaborators

  • avatar