Changes for page React native integration
Last modified by Developer on 2020/01/03 12:47
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -88,7 +88,7 @@ 88 88 |appInstallationSource |String| | App installation source e.g., google-play, organic. 89 89 |email |String | | Set's user email. 90 90 |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. 91 -| 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"] DODAĆLINKADOCONSTANTS.91 +| 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]]. 92 92 | 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. 93 93 | enableIdProfiles|Boolean |false | turns on / off the IDs profiles system. 94 94 {{/showhide}} ... ... @@ -96,7 +96,7 @@ 96 96 {{showhide id="3" showmessage="DataGatherPolicy options" hidemessage="DataGatherPolicy options"}} 97 97 (% class="table-bordered table-hover" style="border-color:powderblue" %) 98 98 |=(% style="background-color:powderblue" %)Name|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Default|=(% style="background-color:powderblue" %)Description 99 -| monitorState|String| | Possible monitor states: DODAĆLINKADO CONSTANTS. More info about gathering data [[here>>https://wiki.spicymobile.pl/wiki/mobigatesdk/view/Main/mobigatesdkintegrationforandroiddevelopers/#H5.8Datagatherpolicy]]99 +| 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]] 100 100 |notificationText|String| | if state = Mobigate.DATA_GATHER_POLICY_DEFAULT you can pass custom foreground service notification text 101 101 {{/showhide}} 102 102 ... ... @@ -175,7 +175,7 @@ 175 175 176 176 **Mobigate.trackEvent(options)** 177 177 178 -{{showhide id="2" showmessage="Options" hidemessage="Options"}} 178 +{{showhide id="2" showmessage="Options" hidemessage="Options" effect="slide" effectduration="0.3"}} 179 179 (% class="table-bordered table-hover" style="border-color:powderblue" %) 180 180 |=(% style="background-color:powderblue" %)Name|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Default|=(% style="background-color:powderblue" %)Description 181 181 |name|String | | Event category name. ... ... @@ -392,16 +392,313 @@ 392 392 393 393 === 3.2.4 Event parameters === 394 394 395 +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. 396 + 397 +{{showhide id="1" showmessage="Parameters list" hidemessage="Parameters list" effect="slide" effectduration="0.3"}} 398 + 399 +(% class="table-bordered table-hover" %) 400 +|(% style="background-color:powderblue; width:200px" %)**Parameter enum**|(% style="background-color:powderblue; width:200px" %)**Recommended value** 401 +|(% style="width:200px" %)REVENUE|(% style="width:200px" %)FLoat 402 +|(% style="width:200px" %)PRICE|(% style="width:200px" %)Float 403 +|(% style="width:200px" %)LEVEL|(% style="width:200px" %)Integer 404 +|(% style="width:200px" %)SUCCESS|(% style="width:200px" %)Boolean 405 +|(% style="width:200px" %)CONTENT_TYPE|(% style="width:200px" %)String 406 +|(% style="width:200px" %)CONTENT_LIST|(% style="width:200px" %)Array of strings 407 +|(% style="width:200px" %)CONTENT_ID|(% style="width:200px" %)String 408 +|(% style="width:200px" %)CURRENCY|(% style="width:200px" %)String 409 +|(% style="width:200px" %)REGISTRATION_METHOD|(% style="width:200px" %)String 410 +|(% style="width:200px" %)QUANTITY|(% style="width:200px" %)Integer 411 +|(% style="width:200px" %)PAYMENT_INFO_AVAILABLE|(% style="width:200px" %)Boolean 412 +|(% style="width:200px" %)RATING_VALUE|(% style="width:200px" %)Float 413 +|(% style="width:200px" %)MAX_RATING_VALUE|(% style="width:200px" %)Float 414 +|(% style="width:200px" %)SEARCH_STRING|(% style="width:200px" %)String 415 +|(% style="width:200px" %)DESCRIPTION|(% style="width:200px" %)String 416 +|(% style="width:200px" %)SCORE|(% style="width:200px" %)Integer 417 +|(% style="width:200px" %)DESTINATION_A|(% style="width:200px" %)String 418 +|(% style="width:200px" %)DESTINATION_B|(% style="width:200px" %)String 419 +|(% style="width:200px" %)CLASS|(% style="width:200px" %)String 420 +|(% style="width:200px" %)DATE_A|(% style="width:200px" %)String 421 +|(% style="width:200px" %)DATE_B|(% style="width:200px" %)String 422 +|(% style="width:200px" %)EVENT_START|(% style="width:200px" %)Unixtime 423 +|(% style="width:200px" %)EVENT_END|(% style="width:200px" %)Unixtime 424 +|(% style="width:200px" %)LATITUDE|(% style="width:200px" %)Double 425 +|(% style="width:200px" %)LONGITUDE|(% style="width:200px" %)Double 426 +|(% style="width:200px" %)CUSTOMER_USER_ID|(% style="width:200px" %)String 427 +|(% style="width:200px" %)CUSTOMER_SEGMENT|(% style="width:200px" %)String 428 +|(% style="width:200px" %)VALIDATED|(% style="width:200px" %)String 429 +|(% style="width:200px" %)RECEIPT_ID|(% style="width:200px" %)String 430 +|(% style="width:200px" %)ORDER_ID|(% style="width:200px" %)String 431 +|(% style="width:200px" %)TUTORIAL_ID|(% style="width:200px" %)String 432 +|(% style="width:200px" %)ACHIEVEMENT_ID|(% style="width:200px" %)String 433 +|(% style="width:200px" %)VIRTUAL_CURRENCY_NAME|(% style="width:200px" %)String 434 +|(% style="width:200px" %)DEEP_LINK|(% style="width:200px" %)String 435 +|(% style="width:200px" %)OLD_VERSION|(% style="width:200px" %)String 436 +|(% style="width:200px" %)NEW_VERSION|(% style="width:200px" %)String 437 +|(% style="width:200px" %)REVIEW_TEXT|(% style="width:200px" %)String 438 +|(% style="width:200px" %)COUPON_CODE|(% style="width:200px" %)String 439 +|(% style="width:200px" %)DEPARTING_DEPARTURE_DATE|(% style="width:200px" %)String 440 +|(% style="width:200px" %)RETURNING_DEPARTURE_DATE|(% style="width:200px" %)String 441 +|(% style="width:200px" %)DESTINATION_LIST|(% style="width:200px" %)String[] 442 +|(% style="width:200px" %)CITY|(% style="width:200px" %)String 443 +|(% style="width:200px" %)REGION|(% style="width:200px" %)String 444 +|(% style="width:200px" %)COUNTRY|(% style="width:200px" %)String 445 +|(% style="width:200px" %)DEPARTING_ARRIVAL_DATE|(% style="width:200px" %)String 446 +|(% style="width:200px" %)RETURNING_ARRIVAL_DATE|(% style="width:200px" %)String 447 +|(% style="width:200px" %)SUGGESTED_DESTINATIONS|(% style="width:200px" %)String[] 448 +|(% style="width:200px" %)TRAVEL_START|(% style="width:200px" %)String 449 +|(% style="width:200px" %)TRAVEL_END|(% style="width:200px" %)String 450 +|(% style="width:200px" %)NUM_ADULTS|(% style="width:200px" %)Integer 451 +|(% style="width:200px" %)NUM_CHILDREN|(% style="width:200px" %)Integer 452 +|(% style="width:200px" %)NUM_INFANTS|(% style="width:200px" %)Integer 453 +|(% style="width:200px" %)SUGGESTED_HOTELS|(% style="width:200px" %)String[] 454 +|(% style="width:200px" %)USER_SCORE|(% style="width:200px" %)Float 455 +|(% style="width:200px" %)HOTEL_SCORE|(% style="width:200px" %)Float 456 +|(% style="width:200px" %)PURCHASE_CURRENCY|(% style="width:200px" %)String 457 +|(% style="width:200px" %)PREFERRED_STAR_RATINGS|(% style="width:200px" %)Integer[2] 458 +|(% style="width:200px" %)PREFERRED_PRICE_RANGE|(% style="width:200px" %)Integer[2] 459 +|(% style="width:200px" %)PREFERRED_NEIGHBORHOODS|(% style="width:200px" %)String[] 460 +|(% style="width:200px" %)PREFERRED_NUM_STOPS|(% style="width:200px" %)Integer 461 +|(% style="width:200px" %)CONTENT|(% style="width:200px" %)String 462 +|(% style="width:200px" %)PARAM_1|(% style="width:200px" %)String 463 +|(% style="width:200px" %)PARAM_2|(% style="width:200px" %)String 464 +|(% style="width:200px" %)PARAM_3|(% style="width:200px" %)String 465 +|(% style="width:200px" %)PARAM_4|(% style="width:200px" %)String 466 +|(% style="width:200px" %)PARAM_5|(% style="width:200px" %)String 467 +|(% style="width:200px" %)PARAM_6|(% style="width:200px" %)String 468 +|(% style="width:200px" %)PARAM_7|(% style="width:200px" %)String 469 +|(% style="width:200px" %)PARAM_8|(% style="width:200px" %)String 470 +|(% style="width:200px" %)PARAM_9|(% style="width:200px" %)String 471 +|(% style="width:200px" %)PARAM_10|(% style="width:200px" %)String 472 + 473 +{{/showhide}} 474 + 395 395 == 3.3 Remaining methods == 396 396 477 +**Mobigate.setCollectAll()** 478 +This method enables all data collectors. By default all data collectors are enabled. 397 397 480 +{{showhide id="3" showmessage="Example" hidemessage="Example"}} 481 +{{code language="javascript"}} 482 +Mobigate.disableAllDataCollector() 483 +{{/code}} 484 +{{/showhide}} 398 398 486 +(% style="color:powderblue" %) 487 +---- 399 399 489 +**Mobigate.configureDataCollectors(enable, collectors)** 490 +Enable or disable DataCollector by array collectors input 400 400 401 401 (% class="table-bordered table-hover" style="border-color:powderblue" %) 402 -|=(% style="background-color:powderblue" %)Name|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Default|=(% style="background-color:powderblue" %)Description 403 -| | | | 493 +|=(% style="background-color:powderblue" %)Name|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Description 494 +|enable|boolean|true if enable, false if disable| 495 +|collectors|array of [[data collector const>>doc:||anchor="H4.3Datacollectorsconstants"]]|e.g.,[Mobigate.DATA_COLLECTOR_BATTERY, DATA_COLLECTOR_GEOLOCATION]| 404 404 497 +{{showhide id="3" showmessage="Example" hidemessage="Example"}} 498 +{{code language="javascript"}} 499 +Mobigate.configureDataCollectors(true, [Mobigate.DATA_COLLECTOR_APPS_LIST, 500 + Mobigate.DATA_COLLECTOR_BATTERY, 501 + Mobigate.DATA_COLLECTOR_PHONE_INFO]) 502 +{{/code}} 503 +{{/showhide}} 504 + 505 +(% style="color:powderblue" %) 506 +---- 507 + 508 +**Mobigate.disableAllDataCollector()** 509 +Disable all data collectors 510 + 511 +{{showhide id="3" showmessage="Example" hidemessage="Example"}} 512 +{{code language="javascript"}} 513 +Mobigate.disableAllDataCollector() 514 +{{/code}} 515 +{{/showhide}} 516 + 517 +(% style="color:powderblue" %) 518 +---- 519 + 520 +**Mobigate.setEmail(email)** 521 +Set user's email 522 + 523 +(% class="table-bordered table-hover" style="border-color:powderblue" %) 524 +|=(% style="background-color:powderblue" %)Name|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Description 525 +|email |String |user's email address | 526 + 527 +{{showhide id="3" showmessage="Example" hidemessage="Example"}} 528 +{{code language="javascript"}} 529 +Mobigate.setEmail('emailExample@spicymobile.pl') 530 +{{/code}} 531 +{{/showhide}} 532 + 533 +(% style="color:powderblue" %) 534 +---- 535 + 536 +**Mobigate.getEmail(onSuccess, onError)** 537 +Get previously set user email 538 + 539 +(% class="table-bordered table-hover" style="border-color:powderblue" %) 540 +|=(% style="background-color:powderblue" %)Name|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Description 541 +|onSuccess |Function |returns callback object 542 +|onError |Function |returns callback object 543 + 544 +{{showhide id="3" showmessage="Example" hidemessage="Example"}} 545 +{{code language="javascript"}} 546 +Mobigate.getEmail((success) => { 547 + console.log("user email: " + success) 548 + }, (error) => { 549 + console.log(error) 550 + }) 551 +{{/code}} 552 +{{/showhide}} 553 + 554 +(% style="color:powderblue" %) 555 +---- 556 + 557 +**Mobigate.setFbToken(token)** 558 +Set fb token for social network collector 559 + 560 +(% class="table-bordered table-hover" style="border-color:powderblue" %) 561 +|=(% style="background-color:powderblue" %)Name|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Description 562 +|token |string |facebook token 563 + 564 +{{showhide id="3" showmessage="Example" hidemessage="Example"}} 565 +{{code language="javascript"}} 566 +Mobigate.setFbToken('9dsf87ds98978das98d7893u12rj808d0j09012jd012') 567 +{{/code}} 568 +{{/showhide}} 569 + 570 +((( 571 +(% class="showhidebutton" %) 572 +((( 573 +{{html clean="false"}} 574 +<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> 575 +{{/html}} 576 +))) 577 + 578 +(% class="showhidecontent" id="showhidecontent3" style="display: none;" %) 579 +((( 580 +((( 581 +{{code language="javascript"}} 582 +Mobigate.setFbToken('9dsf87ds98978das98d7893u12rj808d0j09012jd012') 583 +{{/code}} 584 +))) 585 +))) 586 +))) 587 + 588 + 589 + 590 +(% style="color:powderblue" %) 591 +---- 592 + 593 +**Mobigate.getSDKInfo(onSuccess, onError)** 594 +Getting information about the library 595 + 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 + 601 +{{showhide id="3" showmessage="Example" hidemessage="Example"}} 602 +{{code language="javascript"}} 603 +Mobigate.getSDKInfo((success) => { 604 + console.log("sdk info: " + success) 605 + }, (error) => { 606 + console.log(error) 607 + }) 608 +{{/code}} 609 +{{/showhide}} 610 + 611 +(% style="color:powderblue" %) 612 +---- 613 + 614 +**Mobigate.getSDKUniqueIdentifier(onSuccess, onError)** 615 +Return unique SDK identificator 616 + 617 +(% class="table-bordered table-hover" style="border-color:powderblue" %) 618 +|=(% style="background-color:powderblue" %)Name|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Description 619 +|onSuccess |Function |returns callback object 620 +|onError |Function |returns callback object 621 + 622 +{{showhide id="3" showmessage="Example" hidemessage="Example"}} 623 +{{code language="javascript"}} 624 +Mobigate.getSDKUniqueIdentifier((success) => { 625 + console.log("UUID: " + success) 626 + }, (error) => { 627 + console.log(error) 628 + }) 629 +{{/code}} 630 +{{/showhide}} 631 + 632 + 633 + 634 + 635 +(% class="table-bordered table-hover" style="border-color:powderblue" %) 636 +|=(% style="background-color:powderblue" %)Name|=(% style="background-color:powderblue" %)Type|=(% style="background-color:powderblue" %)Description 637 +| | | 638 + 639 +{{showhide id="3" showmessage="Example" hidemessage="Example"}} 640 +{{code language="javascript"}} 641 + 642 +{{/code}} 643 +{{/showhide}} 644 + 405 405 = 4. Constants = 406 406 647 +The plugin provides many helpful constants for easier implementation. 648 + 649 +== 4.1 User field constants == 650 + 651 +Used to set custom user fields inside //Mobigate.init()// method: 652 + 653 +* Mobigate.USER_FIELD_EMAIL 654 +* Mobigate.USER_FIELD_IMSI 655 +* Mobigate.USER_FIELD_IMEI 656 +* Mobigate.USER_FIELD_SERIAL 657 + 658 +== 4.2 Data gather policy constants == 659 + 660 +Used to set how the library collects data: 661 + 662 +* Mobigate.DATA_GATHER_POLICY_DEFAULT 663 +* Mobigate.DATA_GATHER_POLICY_HIDE_TRAY 664 +* Mobigate.DATA_GATHER_POLICY_BLOCK_DATA_BG 665 + 666 +== 4.3 Data collectors constants == 667 + 668 +Used to set which data the library should collect: 669 + 670 +* Mobigate.DATA_COLLECTOR_APPS_LIST 671 +* Mobigate.DATA_COLLECTOR_APPS_USAGE 672 +* Mobigate.DATA_COLLECTOR_BATTERY 673 +* Mobigate.DATA_COLLECTOR_BROWSER 674 +* Mobigate.DATA_COLLECTOR_CALENDAR_EVENTS 675 +* Mobigate.DATA_COLLECTOR_CPU_PROCESS 676 +* Mobigate.DATA_COLLECTOR_DICTIONARY 677 +* Mobigate.DATA_COLLECTOR_GEOLOCATION 678 +* Mobigate.DATA_COLLECTOR_HEADSET_PLUG 679 +* Mobigate.DATA_COLLECTOR_MEDIA_FILES 680 +* Mobigate.DATA_COLLECTOR_MEMORY_USEAGE 681 +* Mobigate.DATA_COLLECTOR_NETWORK_CONNECTION 682 +* Mobigate.DATA_COLLECTOR_NETWORK_USEAGE 683 +* Mobigate.DATA_COLLECTOR_PACKAGE_CHANGE 684 +* Mobigate.DATA_COLLECTOR_PHONE_INFO 685 +* Mobigate.DATA_COLLECTOR_ROAMING 686 +* Mobigate.DATA_COLLECTOR_SCREEN_ORIENTED 687 +* Mobigate.DATA_COLLECTOR_SIGNAL_STRENGTH 688 +* Mobigate.DATA_COLLECTOR_PROFILE_MODE 689 +* Mobigate.DATA_COLLECTOR_WIFI_DATA_CONNECTION 690 +* Mobigate.DATA_COLLECTOR_PERMISSION_COLLECTOR 691 +* Mobigate.DATA_COLLECTOR_NFC_COLLECTOR 692 +* Mobigate.DATA_COLLECTOR_BLUETOOTH_COLLECTOR 693 +* Mobigate.DATA_COLLECTOR_BLUETOOTH_DEVICES_COLLECTOR 694 +* Mobigate.DATA_COLLECTOR_MOVEMENT_COLLECTOR 695 +* Mobigate.DATA_COLLECTOR_FACEBOOK_NETWORK_COLLECTOR 696 +* Mobigate.DATA_COLLECTOR_ROOT_COLLECTOR 697 + 698 +== 4.4 Category and parameter constants == 699 + 700 +Instead of using defined [[categories>>doc:||anchor="H3.2.3Eventcategories"]] or [[parameters>>doc:||anchor="H3.2.4Eventparameters"]] in the form of text, you can use constants defined in the plugin. All you have to do is add the prefix "CATEGORY_" or "PARAMETER_" to the category name or parameter e.g., Mobigate.CATEGORY_LEVEL_ACCOMPLISHED, Mobigate.CATEGORY_PURCHASE, Mobigate.PARAMETER_PRICE, Mobigate.PARAMETER_LEVEL. 701 + 407 407 = 5. Sample app = 703 + 704 +The sample application is located in the github repository [[here>>https://github.com/mobigatesdk/react-native-mobigate]] in //example// folder.