Summary

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

Details

Page properties

Content

...	...	@@ -24,30 +24,42 @@
24	24	$ flutter pub get
25	25	{{/code}}
26	26
	27	+**Import it in your Dart code**
	28	+
	29	+{{code language="dart"}}
	30	+import 'package:flutter_mobigate/flutter_mobigate.dart';
	31	+{{/code}}
	32	+
27	27	= 3. Api methods =
28	28
29	29	To use any method from the plugin add import:
30	30
31		-{{code language="dart"}}
32		-import 'package:flutter_mobigate/flutter_mobigate.dart';
	37	+{{code language="javascript"}}
	38	+import Mobigate from 'react-native-mobigate'
33	33	{{/code}}
34	34
35		-== 3.1 MobigateSDK class initialization ==
	41	+== 3.1 SDK initialization ==
36	36
37		-Initialize class with //MobigateSDK(MobigateOptions options)//
	43	+You must initialize the library before running it. Use //init(apiKey, options, onSuccess, onError)// method for that:
38	38
39		-//MobigateOptions(apiKey,{appIdentifier, appInstallationSource,email,cusUserId,enableUserFields,dataGatherPolicy,notificationText,enableIdProfiles})//
	45	+**Mobigate.init(apiKey, options, onSuccess, onError)**
40	40
41		-{{showhide id="2" showmessage="MobigateOptions" hidemessage="MobigateOptions"}}
42	42	(% class="table-bordered table-hover" style="border-color:powderblue" %)
	48	+|=(% style="background-color:powderblue" %)Parameter|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Description
	49	+|apiKey|String|Api key provided by your business partner
	50	+|options|Json Object|SDK configuration
	51	+|onSuccess|Function|returns callback object
	52	+|onError|Function|returns callback object
	53	+
	54	+{{showhide id="2" showmessage="Options" hidemessage="Options"}}
	55	+(% class="table-bordered table-hover" style="border-color:powderblue" %)
43	43	|=(% style="background-color:powderblue" %)Name|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Default|=(% style="background-color:powderblue" %)Description
44	44	| appIdentifier|String| | Application identifier
45	45	|appInstallationSource |String| | App installation source e.g., google-play, organic.
46	46	|email |String | | Set's user email.
47		-|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.
	60	+|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.
48	48	| 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]].
49	49	| 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.
50		-| notificationText|String | | if state = Mobigate.DATA_GATHER_POLICY_DEFAULT you can pass custom foreground service notification text.
51	51	| enableIdProfiles|Boolean |false | turns on / off the IDs profiles system.
52	52	{{/showhide}}
53	53
...	...	@@ -55,40 +55,62 @@
55	55	(% class="table-bordered table-hover" style="border-color:powderblue" %)
56	56	|=(% style="background-color:powderblue" %)Name|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Default|=(% style="background-color:powderblue" %)Description
57	57	| 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]]
	70	+|notificationText|String| | if state = Mobigate.DATA_GATHER_POLICY_DEFAULT you can pass custom foreground service notification text
58	58	{{/showhide}}
59	59
60		-{{showhide id="3" showmessage="Example" hidemessage="Example"}}
61		-{{code language="dart"}}
62		- MobigateSDK mobigateInstance = MobigateSDK(MobigateOptions(
63		- "V0K6jhiIfem6CRWHYZ59Nmj3oFBBKbJsnSsWfR2JNq7ktblOUXwbJoBQTpWnw2uSwW76gpiu2kun50jweTY69B"
64		- ));
65		-{{/code}}
66		-{{/showhide}}
67	67
68		-== 3.2 SDK initialization ==
	74	+When the library is already initialized run it. Use //startSDK(onSuccess, onError)// method for that:
69	69
70		-You must initialize the library before running it. Use //Future<String> init// method for that:
	76	+**Mobigate.startSDK(onSuccess, onError)**
71	71
72		-**mobigateInstance.init()**
73		-
74		-Return:
75		-
76	76	(% class="table-bordered table-hover" style="border-color:powderblue" %)
77		-|=(% style="background-color:powderblue" %)Message|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Description
78		-|success|String|returns success message
79		-|error|String|returns error message
	79	+|=(% style="background-color:powderblue" %)Parameter|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Description
	80	+|onSuccess|Function|returns callback object
	81	+|onError|Function|returns callback object
80	80
81		-When the library is already initialized run it. Use //Future<String> startSdk()// method for that:
	83	+{{showhide id="3" showmessage="Example" hidemessage="Example"}}
	84	+{{code language="javascript"}}
	85	+ initLibrary = () => {
	86	+ if (Platform.OS === 'android') {
	87	+ Mobigate.init("V0K6jhiIfem6CRWHYZ59Nmj3oFBBKbJsnSsWfR2JNq7ktblOUXwbJoBQTpWnw2uSwW76gpiu2kun50jweTY69B",
	88	+ {
	89	+ /*custom options, check docs for more details
	90	+ appIdentifier: 'customUserAppIdentifier',
	91	+ appInstallationSource: "customAppInstallationSourcexyz",
	92	+ email: 'testemail@gmail.com',
	93	+ userAgent: 'customUserAgent',
	94	+ customUserId: 'customUserId',*/
	95	+ }, (success) => {
	96	+ /* You can configure custom collectors after init
	97	+ Mobigate.disableAllDataCollector()
	98	+ Mobigate.configureDataCollectors(true, [Mobigate.DATA_COLLECTOR_APPS_LIST,
	99	+ Mobigate.DATA_COLLECTOR_BATTERY,
	100	+ Mobigate.DATA_COLLECTOR_PHONE_INFO])*/
82	82
83		-**mobigateInstance.startSdk();**
	102	+ Mobigate.startSDK((result) => {
	103	+ this.setState({
	104	+ status: 'started',
	105	+ });
84	84
85		-Return:
	107	+ }, (errorResult) => {
	108	+ this.setState({
	109	+ status: errorResult,
	110	+ });
	111	+ })
	112	+ }, (initError) => {
	113	+ this.setState({
	114	+ status: initError,
	115	+ });
	116	+ })
	117	+ }else{
	118	+ this.setState({
	119	+ status: 'Mobigate SDK supports only Android'
	120	+ })
	121	+ }
	122	+ }
	123	+{{/code}}
	124	+{{/showhide}}
86	86
87		-(% class="table-bordered table-hover" style="border-color:powderblue" %)
88		-|=(% style="background-color:powderblue" %)Message|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Description
89		-|success|String|returns success message
90		-|error|String|returns error message
91		-
92	92	== 3.2 Tracking in app events ==
93	93
94	94	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.