Changes for page Flutter integration

Last modified by Developer on 2020/03/19 15:21
From version < 17.1 >
edited by Developer
on 2020/03/19 15:17
To version < 10.1 >
edited by Developer
on 2020/03/19 14:40
< >
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -89,11 +89,11 @@
89 89  |success|String|returns success message
90 90  |error|String|returns error message
91 91  
92 -== 3.3 Tracking in app events ==
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.
95 95  
96 -=== 3.3.1 Overview ===
96 +=== 3.2.1 Overview ===
97 97  
98 98  An event consists of two fields that you (% style="display:none" %) (%%)can use to describe a user's interaction with your app content:
99 99  
... ... @@ -103,31 +103,41 @@
103 103  |(% style="width:200px" %)Parameter|(% style="width:200px" %)String|(% style="width:200px" %)no|(% style="width:200px" %)Event parameter. 
104 104  There can be more than one
105 105  
106 -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"]]).
106 +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"]]).
107 107  
108 -=== 3.3.2 Implementation ===
108 +=== 3.2.2 Implementation ===
109 109  
110 110  Tracking in-app events is performed by two methods:
111 111  
112 -**void trackEvent(Category category)**
112 +**Mobigate.trackEvent(options)**
113 113  
114 +{{showhide id="2" showmessage="Options" hidemessage="Options" effect="slide" effectduration="0.3"}}
114 114  (% class="table-bordered table-hover" style="border-color:powderblue" %)
115 -|=(% style="background-color:powderblue" %)Parameter|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Description
116 -|Category|Category class |Category class built with help of CategoryBuilder
116 +|=(% style="background-color:powderblue" %)Name|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Default|=(% style="background-color:powderblue" %)Description
117 +|name|String | | Event category name.
118 +|parameters|Json array| | Array of parameters. Look below on example.
119 +{{/showhide}}
117 117  
118 118  {{showhide id="3" showmessage="Example" hidemessage="Example"}}
119 -{{code language="dart"}}
120 -mobigateInstance.trackEvent((CategoryBuilder(EventCategory.BEGIN_TRIAL)
121 - ..setParameter(EventParameter.CITY, "Warsaw")
122 - ..setParameter(EventParameter.CONTENT_ID, 523456)
123 - ..setParameter(EventParameter.COUPON_CODE, 97636572)
124 - ..setParameter(EventParameter.CUSTOMER_SEGMENT, [1, 2, 4]))
125 - .build());
122 +{{code language="javascript"}}
123 + sendTrackEvent = () => {
124 + if (Platform.OS === 'android') {
125 + Mobigate.trackEvent({
126 + name: Mobigate.CATEGORY_PURCHASE,
127 + parameters: {
128 + [Mobigate.PARAMETER_CONTENT_ID]: 42313532,
129 + [Mobigate.PARAMETER_PRICE]: 43.23,
130 + [Mobigate.PARAMETER_QUANTITY]: 2,
131 + 'userCustomParameterName':'simpleName'
132 + },
133 + })
134 + }
135 + }
126 126  {{/code}}
127 127  {{/showhide}}
128 128  
129 129  
130 -**void trackAppInstall(int timestamp)**
140 +**Mobigate.trackAppInstall(timestamp)**
131 131  
132 132  (% class="table-bordered table-hover" style="border-color:powderblue" %)
133 133  |=(% style="background-color:powderblue" %)Parameter|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Description
... ... @@ -143,7 +143,7 @@
143 143  {{/code}}
144 144  {{/showhide}}
145 145  
146 -=== 3.3.3 Event categories ===
156 +=== 3.2.3 Event categories ===
147 147  
148 148  The following section describes the recommended structure of each event category. In-app events categories are defined as part of plugin String constants.
149 149  
... ... @@ -316,7 +316,7 @@
316 316  **Recommended parameters:** CONTENT_ID
317 317  {{/showhide}}
318 318  
319 -=== 3.3.4 Event parameters ===
329 +=== 3.2.4 Event parameters ===
320 320  
321 321  In addition each category that is passed with event may have optional parameters defined as part of the plugin constants, or custom defined as String. Below is a list of recommended parameters.
322 322  
... ... @@ -398,14 +398,14 @@
398 398  
399 399  {{/showhide}}
400 400  
401 -== 3.4 Remaining methods ==
411 +== 3.3 Remaining methods ==
402 402  
403 -**void setCollectAll()**
413 +**Mobigate.setCollectAll()**
404 404  This method enables all data collectors. By default all data collectors are enabled.
405 405  
406 406  {{showhide id="3" showmessage="Example" hidemessage="Example"}}
407 -{{code language="dart"}}
408 -mobigateInstance.setCollectAll();
417 +{{code language="javascript"}}
418 +Mobigate.disableAllDataCollector()
409 409  {{/code}}
410 410  {{/showhide}}
411 411  
... ... @@ -412,21 +412,19 @@
412 412  (% style="color:powderblue" %)
413 413  ----
414 414  
415 -**void configureDataCollectors(bool enable, List<int> collectors)**
425 +**Mobigate.configureDataCollectors(enable, collectors)**
416 416  Enable or disable DataCollector by array collectors input
417 417  
418 418  (% class="table-bordered table-hover" style="border-color:powderblue" %)
419 419  |=(% style="background-color:powderblue" %)Name|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Description
420 -|enable|boolean|true if enable, false if disable
421 -|collectors|array of [[data collector const>>doc:||anchor="H4.3Datacollectorsconstants"]]|e.g.,[Mobigate.DATA_COLLECTOR_BATTERY, DATA_COLLECTOR_GEOLOCATION]
430 +|enable|boolean|true if enable, false if disable|
431 +|collectors|array of [[data collector const>>doc:||anchor="H4.3Datacollectorsconstants"]]|e.g.,[Mobigate.DATA_COLLECTOR_BATTERY, DATA_COLLECTOR_GEOLOCATION]|
422 422  
423 423  {{showhide id="3" showmessage="Example" hidemessage="Example"}}
424 -{{code language="dart"}}
425 -mobigateInstance.configureDataCollectors(true, [
426 - DataCollector.APPS_LIST,
427 - DataCollector.APPS_USAGE,
428 - DataCollector.BROWSER
429 - ]);
434 +{{code language="javascript"}}
435 +Mobigate.configureDataCollectors(true, [Mobigate.DATA_COLLECTOR_APPS_LIST,
436 + Mobigate.DATA_COLLECTOR_BATTERY,
437 + Mobigate.DATA_COLLECTOR_PHONE_INFO])
430 430  {{/code}}
431 431  {{/showhide}}
432 432  
... ... @@ -433,12 +433,12 @@
433 433  (% style="color:powderblue" %)
434 434  ----
435 435  
436 -**void disableAllDataCollector()**
444 +**Mobigate.disableAllDataCollector()**
437 437  Disable all data collectors
438 438  
439 439  {{showhide id="3" showmessage="Example" hidemessage="Example"}}
440 -{{code language="dart"}}
441 -mobigateInstance.disableAllDataCollector();
448 +{{code language="javascript"}}
449 +Mobigate.disableAllDataCollector()
442 442  {{/code}}
443 443  {{/showhide}}
444 444  
... ... @@ -445,16 +445,16 @@
445 445  (% style="color:powderblue" %)
446 446  ----
447 447  
448 -**void setEmail(String email)**
456 +**Mobigate.setEmail(email)**
449 449  Set user's email
450 450  
451 451  (% class="table-bordered table-hover" style="border-color:powderblue" %)
452 452  |=(% style="background-color:powderblue" %)Name|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Description
453 -|email |String |user's email address
461 +|email |String |user's email address |
454 454  
455 455  {{showhide id="3" showmessage="Example" hidemessage="Example"}}
456 -{{code language="dart"}}
457 -mobigateInstance.setEmail('test@spicymobile.pl');
464 +{{code language="javascript"}}
465 +Mobigate.setEmail('emailExample@spicymobile.pl')
458 458  {{/code}}
459 459  {{/showhide}}
460 460  
... ... @@ -461,12 +461,21 @@
461 461  (% style="color:powderblue" %)
462 462  ----
463 463  
464 -**Future<String> getEmail()**
465 -Get previously set user email. Return email on success, error otherwise.
472 +**Mobigate.getEmail(onSuccess, onError)**
473 +Get previously set user email
466 466  
475 +(% class="table-bordered table-hover" style="border-color:powderblue" %)
476 +|=(% style="background-color:powderblue" %)Name|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Description
477 +|onSuccess |Function |returns callback object
478 +|onError |Function |returns callback object
479 +
467 467  {{showhide id="3" showmessage="Example" hidemessage="Example"}}
468 -{{code language="dart"}}
469 -final String email = await mobigateInstance.getEmail();
481 +{{code language="javascript"}}
482 +Mobigate.getEmail((success) => {
483 + console.log("user email: " + success)
484 + }, (error) => {
485 + console.log(error)
486 + })
470 470  {{/code}}
471 471  {{/showhide}}
472 472  
... ... @@ -473,7 +473,7 @@
473 473  (% style="color:powderblue" %)
474 474  ----
475 475  
476 -**void setFbToken(String token)**
493 +**Mobigate.setFbToken(token)**
477 477  Set fb token for social network collector
478 478  
479 479  (% class="table-bordered table-hover" style="border-color:powderblue" %)
... ... @@ -481,20 +481,49 @@
481 481  |token |string |facebook token
482 482  
483 483  {{showhide id="3" showmessage="Example" hidemessage="Example"}}
484 -{{code language="dart"}}
485 -mobigateInstance.setFbToken('dsf87esy789fys9dfu08sds54s6547c8s8doc4');
501 +{{code language="javascript"}}
502 +Mobigate.setFbToken('9dsf87ds98978das98d7893u12rj808d0j09012jd012')
486 486  {{/code}}
487 487  {{/showhide}}
488 488  
506 +(((
507 +(% class="showhidebutton" %)
508 +(((
509 +{{html clean="false"}}
510 +<a href="javascript:void(0)" id="showhidebuttontext3" data-show-duration="0" data-show-effect="toggle" data-show-message="Example" data-hide-message="Example">Example</a>
511 +{{/html}}
512 +)))
513 +
514 +(% class="showhidecontent" id="showhidecontent3" style="display: none;" %)
515 +(((
516 +(((
517 +{{code language="javascript"}}
518 +Mobigate.setFbToken('9dsf87ds98978das98d7893u12rj808d0j09012jd012')
519 +{{/code}}
520 +)))
521 +)))
522 +)))
523 +
524 +
525 +
489 489  (% style="color:powderblue" %)
490 490  ----
491 491  
492 -**Future<String> getSDKInfo()**
493 -Getting information about the library. Return on success sdk info string, error otherwise.
529 +**Mobigate.getSDKInfo(onSuccess, onError)**
530 +Getting information about the library
494 494  
532 +(% class="table-bordered table-hover" style="border-color:powderblue" %)
533 +|=(% style="background-color:powderblue" %)Name|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Description
534 +|onSuccess |Function |returns callback object
535 +|onError |Function |returns callback object
536 +
495 495  {{showhide id="3" showmessage="Example" hidemessage="Example"}}
496 -{{code language="dart"}}
497 -final String sdkInfo = await mobigateInstance.getSDKInfo();
538 +{{code language="javascript"}}
539 +Mobigate.getSDKInfo((success) => {
540 + console.log("sdk info: " + success)
541 + }, (error) => {
542 + console.log(error)
543 + })
498 498  {{/code}}
499 499  {{/showhide}}
500 500  
... ... @@ -501,12 +501,21 @@
501 501  (% style="color:powderblue" %)
502 502  ----
503 503  
504 -**Future<String> getSDKUniqueIdentifier()**
505 -Return unique SDK identificator. Return on success sdk unique identifier, error otherwise.
550 +**Mobigate.getSDKUniqueIdentifier(onSuccess, onError)**
551 +Return unique SDK identificator
506 506  
553 +(% class="table-bordered table-hover" style="border-color:powderblue" %)
554 +|=(% style="background-color:powderblue" %)Name|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Description
555 +|onSuccess |Function |returns callback object
556 +|onError |Function |returns callback object
557 +
507 507  {{showhide id="3" showmessage="Example" hidemessage="Example"}}
508 -{{code language="dart"}}
509 -final String sdkUniqueIdentifier = await mobigateInstance.getSDKUniqueIdentifier();
559 +{{code language="javascript"}}
560 +Mobigate.getSDKUniqueIdentifier((success) => {
561 + console.log("UUID: " + success)
562 + }, (error) => {
563 + console.log(error)
564 + })
510 510  {{/code}}
511 511  {{/showhide}}
512 512  
... ... @@ -513,12 +513,22 @@
513 513  (% style="color:powderblue" %)
514 514  ----
515 515  
516 -**Future<List<int>> getIDsProfiles()**
571 +**Mobigate.getIDsProfiles(onSuccess, onError)**
517 517  Method returns IDs profiles. List of IDs profiles in the application memory is updated (synchronized with the server) at specified intervals. To enable functionality, use the 'enableIDsProfiles (boolean enable)' method. Returns the identifiers of IDs profiles (ex. 5,9,20), returns '0' if list of user IDs profiles is empty, returns 'null' if the system has not yet communicated
518 518  
574 +
575 +(% class="table-bordered table-hover" style="border-color:powderblue" %)
576 +|=(% style="background-color:powderblue" %)Name|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Description
577 +|onSuccess |Function |returns callback object
578 +|onError |Function |returns callback object
579 +
519 519  {{showhide id="3" showmessage="Example" hidemessage="Example"}}
520 -{{code language="dart"}}
521 -final List<int> idsProfiles = await mobigateInstance.getIDsProfiles();
581 +{{code language="javascript"}}
582 +Mobigate.getIDsProfiles((success) => {
583 + console.log("Profiles: " + success)
584 + }, (error) => {
585 + console.log(error)
586 + })
522 522  {{/code}}
523 523  {{/showhide}}
524 524  
... ... @@ -525,12 +525,21 @@
525 525  (% style="color:powderblue" %)
526 526  ----
527 527  
528 -**Future<Map<String, int>> getAdOceanTargeting()**
593 +**Mobigate.getAdOceanTargeting(onSuccess, onError)**
529 529  Getting numerical variables, that can be used for ads targeting. Method must be called from separate thread. Return 3 different identifiers of a user, encoded into a map of AdOcean numerical variables
530 530  
596 +(% class="table-bordered table-hover" style="border-color:powderblue" %)
597 +|=(% style="background-color:powderblue" %)Name|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Description
598 +|onSuccess |Function |returns callback object
599 +|onError |Function |returns callback object
600 +
531 531  {{showhide id="3" showmessage="Example" hidemessage="Example"}}
532 -{{code language="dart"}}
533 -final Map<String,int> adOceanTargeting = await mobigateInstance.getAdOceanTargeting();
602 +{{code language="javascript"}}
603 +Mobigate.getAdOceanTargeting((success) => {
604 + console.log("Adocean targeting: " + success)
605 + }, (error) => {
606 + console.log(error)
607 + })
534 534  {{/code}}
535 535  {{/showhide}}
536 536  
... ... @@ -542,50 +542,50 @@
542 542  
543 543  Used to set custom user fields inside //Mobigate.init()// method:
544 544  
545 -* UserField.USER_FIELD_EMAIL
546 -* UserField.USER_FIELD_IMSI
547 -* UserField.USER_FIELD_IMEI
548 -* UserField.USER_FIELD_SERIAL
619 +* Mobigate.USER_FIELD_EMAIL
620 +* Mobigate.USER_FIELD_IMSI
621 +* Mobigate.USER_FIELD_IMEI
622 +* Mobigate.USER_FIELD_SERIAL
549 549  
550 550  == 4.2 Data gather policy constants ==
551 551  
552 552  Used to set how the library collects data:
553 553  
554 -* MonitorState.DATA_GATHER_POLICY_DEFAULT
555 -* MonitorState.DATA_GATHER_POLICY_HIDE_TRAY
556 -* MonitorState.DATA_GATHER_POLICY_BLOCK_DATA_BG
628 +* Mobigate.DATA_GATHER_POLICY_DEFAULT
629 +* Mobigate.DATA_GATHER_POLICY_HIDE_TRAY
630 +* Mobigate.DATA_GATHER_POLICY_BLOCK_DATA_BG
557 557  
558 558  == 4.3 Data collectors constants ==
559 559  
560 560  Used to set which data the library should collect:
561 561  
562 -* DataCollector.APPS_LIST
563 -* DataCollector.DATA_COLLECTOR_APPS_USAGE
564 -* DataCollector.BATTERY
565 -* DataCollector.BROWSER
566 -* DataCollector.CALENDAR_EVENTS
567 -* DataCollector.CPU_PROCESS
568 -* DataCollector.DICTIONARY
569 -* DataCollector.GEOLOCATION
570 -* DataCollector.HEADSET_PLUG
571 -* DataCollector.MEDIA_FILES
572 -* DataCollector.MEMORY_USEAGE
573 -* DataCollector.NETWORK_CONNECTION
574 -* DataCollector.NETWORK_USEAGE
575 -* DataCollector.PACKAGE_CHANGE
576 -* DataCollector.PHONE_INFO
577 -* DataCollector.ROAMING
578 -* DataCollector.SCREEN_ORIENTED
579 -* DataCollector.SIGNAL_STRENGTH
580 -* DataCollector.PROFILE_MODE
581 -* DataCollector.WIFI_DATA_CONNECTION
582 -* DataCollector.PERMISSION_COLLECTOR
583 -* DataCollector.NFC_COLLECTOR
584 -* DataCollector.BLUETOOTH_COLLECTOR
585 -* DataCollector.BLUETOOTH_DEVICES_COLLECTOR
586 -* DataCollector.MOVEMENT_COLLECTOR
587 -* DataCollector.FACEBOOK_NETWORK_COLLECTOR
588 -* DataCollector.ROOT_COLLECTOR
636 +* Mobigate.DATA_COLLECTOR_APPS_LIST
637 +* Mobigate.DATA_COLLECTOR_APPS_USAGE
638 +* Mobigate.DATA_COLLECTOR_BATTERY
639 +* Mobigate.DATA_COLLECTOR_BROWSER
640 +* Mobigate.DATA_COLLECTOR_CALENDAR_EVENTS
641 +* Mobigate.DATA_COLLECTOR_CPU_PROCESS
642 +* Mobigate.DATA_COLLECTOR_DICTIONARY
643 +* Mobigate.DATA_COLLECTOR_GEOLOCATION
644 +* Mobigate.DATA_COLLECTOR_HEADSET_PLUG
645 +* Mobigate.DATA_COLLECTOR_MEDIA_FILES
646 +* Mobigate.DATA_COLLECTOR_MEMORY_USEAGE
647 +* Mobigate.DATA_COLLECTOR_NETWORK_CONNECTION
648 +* Mobigate.DATA_COLLECTOR_NETWORK_USEAGE
649 +* Mobigate.DATA_COLLECTOR_PACKAGE_CHANGE
650 +* Mobigate.DATA_COLLECTOR_PHONE_INFO
651 +* Mobigate.DATA_COLLECTOR_ROAMING
652 +* Mobigate.DATA_COLLECTOR_SCREEN_ORIENTED
653 +* Mobigate.DATA_COLLECTOR_SIGNAL_STRENGTH
654 +* Mobigate.DATA_COLLECTOR_PROFILE_MODE
655 +* Mobigate.DATA_COLLECTOR_WIFI_DATA_CONNECTION
656 +* Mobigate.DATA_COLLECTOR_PERMISSION_COLLECTOR
657 +* Mobigate.DATA_COLLECTOR_NFC_COLLECTOR
658 +* Mobigate.DATA_COLLECTOR_BLUETOOTH_COLLECTOR
659 +* Mobigate.DATA_COLLECTOR_BLUETOOTH_DEVICES_COLLECTOR
660 +* Mobigate.DATA_COLLECTOR_MOVEMENT_COLLECTOR
661 +* Mobigate.DATA_COLLECTOR_FACEBOOK_NETWORK_COLLECTOR
662 +* Mobigate.DATA_COLLECTOR_ROOT_COLLECTOR
589 589  
590 590  == 4.4 Category and parameter constants ==
591 591  

MobigateSDK Center

Spicy Mobile
spicymobile.pl