Changes for page Flutter integration

Last modified by Developer on 2020/03/19 15:21

From version < 12.1 >

edited by Developer
on 2020/03/19 14:55

To version < 2.1 >

edited by Developer
on 2020/03/19 13:46

< >

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -4,50 +4,92 @@
  = 1. Overview =
--The plugin is located at pub repositories [[(pub repositories)>>https://pub.dev/packages/flutter_mobigate]]
++The plugin is located at npmjs repositories [[(npm repositories)>>https://www.npmjs.com/package/react-native-mobigate]]
  This plugin is built for:
--* Mobigate SDK version 1.0.6
++* Mobigate SDK version 1.0.4
  = 2. Adding SDK to the project =
--**First, add this to your package's pubspec.yaml file**
++**First, install library from the repository with**
  {{code language=""}}
--dependencies:
--  flutter_mobigate: ^1.0.2
++yarn add react-native-mobigate
  {{/code}}
--**Install packages from the command line**
++or
  {{code language=""}}
--$ flutter pub get
++npm install react-native-mobigate --save
  {{/code}}
++**Link newly added plugin**
++
++* **React Native >= 0.60**
++Starting from React Native 0.60, [[autolinking>>https://github.com/react-native-community/cli/blob/master/docs/autolinking.md]] makes the installation process simpler
++
++* **React Native <= 0.59**
++** Mostly automatic installation:
++{{code language=""}}react-native link react-native-mobigate{{/code}}
++** Manual installation:{{showhide id="1" showmessage="Manually link the library on Android" hidemessage="Manually link the library on Android"}}* Add to: android/settings.gradle
++
++{{code language="groovy"}}
++include ':react-native-mobigate'
++project(':react-native-mobigate').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-mobigate/android')
++{{/code}}
++* Add to: android/app/build.gradle
++
++{{code language="groovy"}}
++dependencies {
++implementation project(':react-native-mobigate')
++}
++{{/code}}
++* Add the MobigatePackage class to your list of exported packages into: android/app/src/main/.../MainApplication.java
++
++{{code language="java"}}
++...
++import pl.spicymobile.reactmobigate.MobigatePackage;
++
++
++@Override
++protected List<ReactPackage> getPackages() {
++    return Arrays.<ReactPackage>asList(
++        new MainReactPackage(),
++        new MobigatePackage()
++    );
++}
++{{/code}}{{/showhide}}
++
  = 3. Api methods =
  To use any method from the plugin add import:
--{{code language="dart"}}
--import 'package:flutter_mobigate/flutter_mobigate.dart';
++{{code language="javascript"}}
++import Mobigate from 'react-native-mobigate'
  {{/code}}
--== 3.1 MobigateSDK class initialization ==
++== 3.1 SDK initialization ==
--Initialize class with //MobigateSDK(MobigateOptions options)//
++You must initialize the library before running it. Use //init(apiKey, options, onSuccess, onError)// method for that:
--//MobigateOptions(apiKey,{appIdentifier, appInstallationSource,email,cusUserId,enableUserFields,dataGatherPolicy,notificationText,enableIdProfiles})//
++**Mobigate.init(apiKey, options, onSuccess, onError)**
--{{showhide id="2" showmessage="MobigateOptions" hidemessage="MobigateOptions"}}
  (% class="table-bordered table-hover" style="border-color:powderblue" %)
++|=(% style="background-color:powderblue" %)Parameter|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Description
++|apiKey|String|Api key provided by your business partner
++|options|Json Object|SDK configuration
++|onSuccess|Function|returns callback object
++|onError|Function|returns callback object
++
++{{showhide id="2" showmessage="Options" hidemessage="Options"}}
++(% class="table-bordered table-hover" style="border-color:powderblue" %)
  |=(% style="background-color:powderblue" %)Name|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Default|=(% style="background-color:powderblue" %)Description
  | appIdentifier|String| | Application identifier
  |appInstallationSource |String| | App installation source e.g., google-play, organic.
  |email |String | | Set's user email.
--|cusUserId |String | | You may use your custom userID for marking data. By default we are using device ID and emails for matching. Set it before starting the service using MobigateSDk.Builder method.
++|customUserId |String | | You may use your custom userID for marking data. By default we are using device ID and emails for matching. Set it before starting the service using MobigateSDk.Builder method.
  | enableUserFields|Json Array | | Enable custom fields in user data. By default MobienceSDK is gathering all identifiers, which it can read. You can choose one of these field: ["email", "imei", "imsi", "msisdn", "mac", "serial"] see [[plugin user field constants>>https://wiki.spicymobile.pl/wiki/mobigatesdk/view/Main/sdkintegration/reactnativeintegration/#H4.1Userfieldconstants]].
  | dataGatherPolicy| Json Object| | Enable custom data gater policy. By default MobienceSDK gather all data it can read and hide notification icon. Check below DataGatherPolicy options for more details.
--| notificationText|String | |  if state = Mobigate.DATA_GATHER_POLICY_DEFAULT you can pass custom foreground service notification text.
  | enableIdProfiles|Boolean |false | turns on / off the IDs profiles system.
  {{/showhide}}
@@ -55,45 +55,67 @@
  (% class="table-bordered table-hover" style="border-color:powderblue" %)
  |=(% style="background-color:powderblue" %)Name|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Default|=(% style="background-color:powderblue" %)Description
  | monitorState|String| | Possible monitor states: [[plugin constants>>https://wiki.spicymobile.pl/wiki/mobigatesdk/view/Main/sdkintegration/reactnativeintegration/#H4.2Datagatherpolicyconstants]]. More info about gathering data [[here>>https://wiki.spicymobile.pl/wiki/mobigatesdk/view/Main/mobigatesdkintegrationforandroiddevelopers/#H5.8Datagatherpolicy]]
++|notificationText|String| | if state = Mobigate.DATA_GATHER_POLICY_DEFAULT you can pass custom foreground service notification text
  {{/showhide}}
--{{showhide id="3" showmessage="Example" hidemessage="Example"}}
--{{code language="dart"}}
--  MobigateSDK mobigateInstance = MobigateSDK(MobigateOptions(
--      "V0K6jhiIfem6CRWHYZ59Nmj3oFBBKbJsnSsWfR2JNq7ktblOUXwbJoBQTpWnw2uSwW76gpiu2kun50jweTY69B"
--  ));
--{{/code}}
--{{/showhide}}
--== 3.2 SDK initialization ==
++When the library is already initialized run it. Use //startSDK(onSuccess, onError)// method for that:
--You must initialize the library before running it. Use //Future<String> init// method for that:
++**Mobigate.startSDK(onSuccess, onError)**
--**mobigateInstance.init()**
--
--Return:
--
  (% class="table-bordered table-hover" style="border-color:powderblue" %)
--|=(% style="background-color:powderblue" %)Message|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Description
--|success|String|returns success message
--|error|String|returns error message
++|=(% style="background-color:powderblue" %)Parameter|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Description
++|onSuccess|Function|returns callback object
++|onError|Function|returns callback object
--When the library is already initialized run it. Use //Future<String> startSdk()// method for that:
++{{showhide id="3" showmessage="Example" hidemessage="Example"}}
++{{code language="javascript"}}
++  initLibrary = () => {
++    if (Platform.OS === 'android') {
++      Mobigate.init("V0K6jhiIfem6CRWHYZ59Nmj3oFBBKbJsnSsWfR2JNq7ktblOUXwbJoBQTpWnw2uSwW76gpiu2kun50jweTY69B",
++        {
++          /*custom options, check docs for more details
++           appIdentifier: 'customUserAppIdentifier',
++           appInstallationSource: "customAppInstallationSourcexyz",
++           email: 'testemail@gmail.com',
++           userAgent: 'customUserAgent',
++           customUserId: 'customUserId',*/
++        }, (success) => {
++          /* You can configure custom collectors after init
++          Mobigate.disableAllDataCollector()
++          Mobigate.configureDataCollectors(true, [Mobigate.DATA_COLLECTOR_APPS_LIST,
++          Mobigate.DATA_COLLECTOR_BATTERY,
++          Mobigate.DATA_COLLECTOR_PHONE_INFO])*/
--**mobigateInstance.startSdk();**
++          Mobigate.startSDK((result) => {
++            this.setState({
++              status: 'started',
++            });
--Return:
++          }, (errorResult) => {
++            this.setState({
++              status: errorResult,
++            });
++          })
++        }, (initError) => {
++          this.setState({
++            status: initError,
++          });
++        })
++    }else{
++      this.setState({
++        status: 'Mobigate SDK supports only Android'
++      })
++    }
++  }
++{{/code}}
++{{/showhide}}
--(% class="table-bordered table-hover" style="border-color:powderblue" %)
--|=(% style="background-color:powderblue" %)Message|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Description
--|success|String|returns success message
--|error|String|returns error message
++== 3.2 Tracking in app events ==
--== 3.3 Tracking in app events ==
--
  In-App Events provide insight on what is happening in your app. It is recommended to take the time and define the events you would like to measure.
--=== 3.3.1 Overview ===
++=== 3.2.1 Overview ===
  An event consists of two fields that you (% style="display:none" %) (%%)can use to describe a user's interaction with your app content:
@@ -103,31 +103,41 @@
  |(% style="width:200px" %)Parameter|(% style="width:200px" %)String|(% style="width:200px" %)no|(% style="width:200px" %)Event parameter.
  There can be more than one
--You can use any event category or parameter string of your choice. However, flutter_mobigate plugin contains recommended event categories and parameters via String constants (see [[Event categories>>doc:||anchor="H3.2.3Eventcategories"]] and [[Event parameters>>doc:||anchor="H3.2.4Eventparameters"]]).
++You can use any event category or parameter string of your choice. However, react-native-mobigate plugin contains recommended event categories and parameters via String constants (see [[Event categories>>doc:||anchor="H3.2.3Eventcategories"]] and [[Event parameters>>doc:||anchor="H3.2.4Eventparameters"]]).
--=== 3.3.2 Implementation ===
++=== 3.2.2 Implementation ===
  Tracking in-app events is performed by two methods:
--**void trackEvent(Category category)**
++**Mobigate.trackEvent(options)**
++{{showhide id="2" showmessage="Options" hidemessage="Options" effect="slide" effectduration="0.3"}}
  (% class="table-bordered table-hover" style="border-color:powderblue" %)
--|=(% style="background-color:powderblue" %)Parameter|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Description
--|Category|Category class |Category class built with help of CategoryBuilder
++|=(% style="background-color:powderblue" %)Name|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Default|=(% style="background-color:powderblue" %)Description
++|name|String | | Event category name.
++|parameters|Json array| | Array of parameters. Look below on example.
++{{/showhide}}
  {{showhide id="3" showmessage="Example" hidemessage="Example"}}
--{{code language="dart"}}
--mobigateInstance.trackEvent((CategoryBuilder(EventCategory.BEGIN_TRIAL)
--    ..setParameter(EventParameter.CITY, "Warsaw")
--    ..setParameter(EventParameter.CONTENT_ID, 523456)
--    ..setParameter(EventParameter.COUPON_CODE, 97636572)
--    ..setParameter(EventParameter.CUSTOMER_SEGMENT, [1, 2, 4]))
--  .build());
++{{code language="javascript"}}
++  sendTrackEvent = () => {
++    if (Platform.OS === 'android') {
++      Mobigate.trackEvent({
++        name: Mobigate.CATEGORY_PURCHASE,
++        parameters: {
++          [Mobigate.PARAMETER_CONTENT_ID]: 42313532,
++          [Mobigate.PARAMETER_PRICE]: 43.23,
++          [Mobigate.PARAMETER_QUANTITY]: 2,
++          'userCustomParameterName':'simpleName'
++        },
++      })
++    }
++  }
  {{/code}}
  {{/showhide}}
--**void trackAppInstall(int timestamp)**
++**Mobigate.trackAppInstall(timestamp)**
  (% class="table-bordered table-hover" style="border-color:powderblue" %)
  |=(% style="background-color:powderblue" %)Parameter|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Description
@@ -143,7 +143,7 @@
  {{/code}}
  {{/showhide}}
--=== 3.3.3 Event categories ===
++=== 3.2.3 Event categories ===
  The following section describes the recommended structure of each event category. In-app events categories are defined as part of plugin String constants.
@@ -398,14 +398,14 @@
  {{/showhide}}
--== 3.4 Remaining methods ==
++== 3.3 Remaining methods ==
--**void setCollectAll()**
++**Mobigate.setCollectAll()**
  This method enables all data collectors. By default all data collectors are enabled.
  {{showhide id="3" showmessage="Example" hidemessage="Example"}}
--{{code language="dart"}}
--mobigateInstance.setCollectAll();
++{{code language="javascript"}}
++Mobigate.disableAllDataCollector()
  {{/code}}
  {{/showhide}}
@@ -412,7 +412,7 @@
  (% style="color:powderblue" %)
  ----
--**void configureDataCollectors(bool enable, List<int> collectors)**
++**Mobigate.configureDataCollectors(enable, collectors)**
  Enable or disable DataCollector by array collectors input
  (% class="table-bordered table-hover" style="border-color:powderblue" %)
@@ -422,11 +422,9 @@
  {{showhide id="3" showmessage="Example" hidemessage="Example"}}
  {{code language="javascript"}}
--mobigateInstance.configureDataCollectors(true, [
--          DataCollector.APPS_LIST,
--          DataCollector.APPS_USAGE,
--          DataCollector.BROWSER
--        ])
++Mobigate.configureDataCollectors(true, [Mobigate.DATA_COLLECTOR_APPS_LIST,
++        Mobigate.DATA_COLLECTOR_BATTERY,
++        Mobigate.DATA_COLLECTOR_PHONE_INFO])
  {{/code}}
  {{/showhide}}

Changes for page Flutter integration

Summary

Details

MobigateSDK Center