Summary

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

Details

Page properties

Content

...	...	@@ -67,89 +67,28 @@
67	67
68	68	== 3.2 SDK initialization ==
69	69
70		-You must initialize the library before running it. Use //init(apiKey, options, onSuccess, onError)// method for that:
	70	+You must initialize the library before running it. Use //Future<String> init// method for that:
71	71
72		-**Mobigate.init(apiKey, options, onSuccess, onError)**
	72	+**mobigateInstance.init()**
73	73
74		-(% class="table-bordered table-hover" style="border-color:powderblue" %)
75		-|=(% style="background-color:powderblue" %)Parameter|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Description
76		-|apiKey|String|Api key provided by your business partner
77		-|options|Json Object|SDK configuration
78		-|onSuccess|Function|returns callback object
79		-|onError|Function|returns callback object
	74	+Return:
80	80
81		-{{showhide id="2" showmessage="Options" hidemessage="Options"}}
82	82	(% class="table-bordered table-hover" style="border-color:powderblue" %)
83		-|=(% style="background-color:powderblue" %)Name|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Default|=(% style="background-color:powderblue" %)Description
84		-| appIdentifier|String| | Application identifier
85		-|appInstallationSource |String| | App installation source e.g., google-play, organic.
86		-|email |String | | Set's user email.
87		-|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.
88		-| 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]].
89		-| 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.
90		-| enableIdProfiles|Boolean |false | turns on / off the IDs profiles system.
91		-{{/showhide}}
	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
92	92
93		-{{showhide id="3" showmessage="DataGatherPolicy options" hidemessage="DataGatherPolicy options"}}
94		-(% class="table-bordered table-hover" style="border-color:powderblue" %)
95		-|=(% style="background-color:powderblue" %)Name|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Default|=(% style="background-color:powderblue" %)Description
96		-| 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]]
97		-|notificationText|String| | if state = Mobigate.DATA_GATHER_POLICY_DEFAULT you can pass custom foreground service notification text
98		-{{/showhide}}
	81	+When the library is already initialized run it. Use //Future<String> startSdk()// method for that:
99	99
	83	+**mobigateInstance.startSdk();**
100	100
101		-When the library is already initialized run it. Use //startSDK(onSuccess, onError)// method for that:
	85	+Return:
102	102
103		-**Mobigate.startSDK(onSuccess, onError)**
104		-
105	105	(% class="table-bordered table-hover" style="border-color:powderblue" %)
106		-|=(% style="background-color:powderblue" %)Parameter|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Description
107		-|onSuccess|Function|returns callback object
108		-|onError|Function|returns callback object
	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
109	109
110		-{{showhide id="3" showmessage="Example" hidemessage="Example"}}
111		-{{code language="javascript"}}
112		- initLibrary = () => {
113		- if (Platform.OS === 'android') {
114		- Mobigate.init("V0K6jhiIfem6CRWHYZ59Nmj3oFBBKbJsnSsWfR2JNq7ktblOUXwbJoBQTpWnw2uSwW76gpiu2kun50jweTY69B",
115		- {
116		- /*custom options, check docs for more details
117		- appIdentifier: 'customUserAppIdentifier',
118		- appInstallationSource: "customAppInstallationSourcexyz",
119		- email: 'testemail@gmail.com',
120		- userAgent: 'customUserAgent',
121		- customUserId: 'customUserId',*/
122		- }, (success) => {
123		- /* You can configure custom collectors after init
124		- Mobigate.disableAllDataCollector()
125		- Mobigate.configureDataCollectors(true, [Mobigate.DATA_COLLECTOR_APPS_LIST,
126		- Mobigate.DATA_COLLECTOR_BATTERY,
127		- Mobigate.DATA_COLLECTOR_PHONE_INFO])*/
128		-
129		- Mobigate.startSDK((result) => {
130		- this.setState({
131		- status: 'started',
132		- });
133		-
134		- }, (errorResult) => {
135		- this.setState({
136		- status: errorResult,
137		- });
138		- })
139		- }, (initError) => {
140		- this.setState({
141		- status: initError,
142		- });
143		- })
144		- }else{
145		- this.setState({
146		- status: 'Mobigate SDK supports only Android'
147		- })
148		- }
149		- }
150		-{{/code}}
151		-{{/showhide}}
152		-
153	153	== 3.2 Tracking in app events ==
154	154
155	155	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.