@thinkingai/ae-cli 1.0.28 → 6.0.16-1

package/wiki/te-docs/raw/data-ingestion-guide/client-sdk/cross-platform/flutter.md

@@ -0,0 +1,139 @@
+---
+code: flutter_sdk_installation
+name: "Flutter"
+wikiToken: OzW1wBUwbiX7D5k8ZaSc6Uy0ndh
+parentWikiToken: JRIIwKqb5iVJMAkCwTic7H17ncg
+updateTime: 1774251995000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=en-US&code=flutter_sdk_installation
+---
+::: tip
+Before you begin, please read [<text color="purple" underline="true">Preparation before Data Ingestion</text>](https://thinkingdata.feishu.cn/wiki/OhD8we9iai6Xk5kM1QNc8ITRnQe)
+ :::
+**Latest version:** 3.3.1
+**Update time:**  11/10/2025
+**Resource download: **[SDK](https%3A%2F%2Fgithub.com%2FThinkingDataAnalytics%2Fflutter-sdk%2Ftags)
+## **1. ****SDK**** Integration**
+Add thinking_analytics dependencies to your `pubspec.yaml` file for your Flutter project:
+```yaml
+dependencies:
+  thinking_analytics: ^3.3.1
+```
+
+## **2. Initialization**
+The ThinkingData SDK needs to be initialized after the user agrees to the Privacy Policy
+
+<callout emoji="musical_score" background-color="light-orange" border-color="light-orange">
+Versions 3.3.0 and later do not need to add await
+</callout>
+
+```dart
+import 'package:thinking_analytics/thinking_analytics.dart';
+if (authorized)
+{
+   //init
+   await TDAnalytics.init(APPID, SERVER_URL);
+}
+```
+
+Instruction on parameters:
+- `APPID`: The APPID of your project, which can be found on the project management page of the TE.
+- `SERVER_URL`: 
+  - If you are using a SaaS version, please check the receiver URL on this page
+
+<image token="EvjEbQjETodTuLxuDl7c4KXsnFd" width="1674" height="1318" align="center"/>
+
+- If you use the private deployment version, you can customize the data tracking URL .
+
+<quote-container>
+Since Android 9.0+ restricts HTTP requests by default, please use HTTPS protocol only.
+</quote-container>
+
+## **3. Common Features**
+We suggested that you read [User Identification Rules](https://thinkingdata.feishu.cn/wiki/Pov9wECdsi2QQsk4NN9cEPsvnyc) before using common features; SDK would generate a random number that would be used as the distinct ID, and save the ID locally. Before the user logs in, the distinct ID would be used as the identification ID.   Note: The distinct ID would change after the user reinstalled the APP or use the APP with a new device.
+### **3.1 Login**
+When the users log in , `login` could be called to set the account ID of the user. TE would use the account ID as the identification ID, and this ID would be saved before `logout` is called. The previous account ID would be replaced if `login` has been called multiple times.
+```dart
+// The login unique identifier of the user, corresponding to the #account_id in data tracking. #Account_id now is TE
+TDAnalytics.login("TA");
+```
+
+<quote-container>
+**Login events wouldn't be uploaded in this method.**
+</quote-container>
+
+### 3.2 **Super Properties**
+Super Properties refer to properties that each event might have. You can call `setSuperProperties` to set Super Properties. It is recommended that you set Super Properties first before sending data. Some important properties (e.g., the membership class of users, source channels, etc.) should be set in each event. At this time, you can set these properties as Super Properties.
+```dart
+TDAnalytics.setSuperProperties({
+  "channel": "ta",//character string
+  "age": 1,//number
+  "isSuccess": true,//boolean
+  "birthday": DateTime.now(),//time
+  "object": {"key": "value"},//object
+  "object_arr": [{"key": "value"}],//array object
+  "arr": ["value"]//array
+});
+```
+
+Super Properties would be saved in local storage, and will not need to be called every time the App is opened. If the Super Properties set previously are uploaded after calling `setSuperProperties`, previous properties would be replaced. 
+- Key is the name of the property and refers to the string type. It must start with a character, and contain numbers, characters (insensitive to case, and upper cases would be transformed into lower cases by TE) and underscores "_", with a maximum length of 50 characters. 
+- Value, the value of the property, supports string, numbers, Boolean, time, object, array object, and array
+
+<quote-container>
+**The requirements for event properties and user properties are the same with that for super properties**
+</quote-container>
+
+### **3.3 Automatically Track Events**
+The following code is an example of install, active and inactive events. To get more information about the automatic tracking of SDK, please refer to [Detailed introduction of automatic tracking function](https://thinkingdata.feishu.cn/wiki/V2adwX3TziCBZzkaDUkcbBw6nJf)
+```dart
+TDAnalytics.enableAutoTrack(TDAutoTrackEventType.APP_START |
+    TDAutoTrackEventType.APP_END |
+    TDAutoTrackEventType.APP_INSTALL |
+    TDAutoTrackEventType.APP_CRASH);
+```
+
+### **3.4 Sending Events**
+You can call `track` to upload events. It is suggested that you set event properties based on the data tracking plan drafted previously. Here is an example of a user buying an item:
+```dart
+TDAnalytics.track('product_buy', properties: <String, dynamic>{'product_name': 'tv'});
+```
+
+The event name is string type. It could only start with a character and could contain figures, characters, and an underline "_", with a maximum length of 50 characters.
+### **3.5 User Properties**
+You can set general user properties by calling `user_set` API. The original properties would be replaced by the properties uploaded via this API. The data type of newly-created user properties must be the same as the uploaded properties. User name setting is taken as the example here: 
+```dart
+TDAnalytics.userSet(<String, dynamic>{'user_name': 'TA'});  //the username now is TA
+TDAnalytics.userSet(<String, dynamic>{'user_name': 'TE'});  //the username now is TE
+```
+
+## **4. Best Practice**
+The following sample code covers all the above-mentioned operations. It is recommended that the SDK be used in the following steps:
+```dart
+import 'package:thinking_analytics/thinking_analytics.dart';
+if (authorized)
+{
+   //SDK init
+   await TDAnalytics.init('APP_ID', 'https://SERVER_URL');
+   //if the user has logged in, the account ID of the user could be set as the unique identifier 
+   TDAnalytics.login('TA');
+   //After setting super properties, each event would have super properties
+   TDAnalytics.setSuperProperties({
+     "channel": "ta",//string
+     "age": 1,//number
+     "isSuccess": true,//boolean
+     "birthday": DateTime.now(),//time
+     "object": {"key": "value"},//object
+     "object_arr": [{"key": "value"}],//array object
+     "arr": ["value"]//array
+    });
+   //Enable auto-tracking
+   TDAnalytics.enableAutoTrack(TDAutoTrackEventType.APP_START |
+    TDAutoTrackEventType.APP_END |
+    TDAutoTrackEventType.APP_INSTALL |
+    TDAutoTrackEventType.APP_CRASH);
+   //upload events
+   TDAnalytics.track('product_buy', properties: <String, dynamic>{'product_name': 'productName'});
+   //Set user properties
+   TDAnalytics.userSet(<String, dynamic>{'user_name': 'TE'});
+}
+```

package/wiki/te-docs/raw/data-ingestion-guide/client-sdk/cross-platform/react-native/compliance.md

@@ -0,0 +1,26 @@
+---
+code: rn_sdk_compliance
+name: "Compliance"
+wikiToken: IyWTwtrPYi7IupkpiTOcUuPNnRh
+parentWikiToken: E1F3wNsc3iW7dckzhH9cA2h2nIg
+updateTime: 1774249189000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=en-US&code=rn_sdk_compliance
+---
+
+## **1. Filling out SDK-related Contents in The Privacy Policy**
+### **1.1 Collecting and Acquiring Data**
+The following content is suggested to fill out  in accordance with the actual conditions in the column of collecting and acquiring your personal data in the *Privacy Policy*. 
+When you activate and use the APP, we would collect information about your device (including IDFV, AndroidID, OS, device model, device manufacturer, system version, application process information, etc.) through ThinkingAnalytics-SDK to analyze the effect you achieved by using the App via statistics.
+### **1.2 Sharing with authorized partners**
+The following content is suggested to fill out in accordance with the actual conditions in the column of sharing with authorized partners in the *Privacy Policy*.
+ThinkingAnalytics-SDK: collect information about your device (including IDFV, AndroidID, OS, device model, device manufacturer, system version, application process information, etc.) and your network information to perform data analysis ,so as to improve our products and services
+## **2. ****SDK**** Compliance Steps**
+ThinkingData SDK needs to be initialized after the user agrees with the *Privacy Policy. *
+```java
+// determine whether to enable data tracking according to the Privacy Policy
+import thinkingdata  from "react-native-thinking-data";
+if (authorized)
+{
+   TDAnalytics.init({appId: "xxx",serverUrl: "https://xxx",});
+}
+```

package/wiki/te-docs/raw/data-ingestion-guide/client-sdk/cross-platform/react-native/reactnative-advanced/automatically-track-events.md

@@ -0,0 +1,121 @@
+---
+code: rn_sdk_autotrack
+name: "Automatically Track Events"
+wikiToken: EVwUwiZdYi3jhEkcAhHcNxSrnkd
+parentWikiToken: GKCGw8YI4itlKEk4miNccirjnfc
+updateTime: 1774249183000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=en-US&code=rn_sdk_autotrack
+---
+
+## **1. Enable Auto-Tracking**
+You can call `enableAutoTrack` and pass in a List of type `TDAutoTrackEventType` to enable the auto-tracking function:
+1. Install:  behavior of APP installation,the corresponding type is `TDAutoTrackEventType.APP_INSTALL`
+2. Open APP: including activiting APP and resuming APP from the background, the corresponding type is `TDAutoTrackEventType.APP_START`
+3. Close APP: including disabling the APP and calling in the background, the corresponding type is `TDAutoTrackEventType.APP_END`
+4. Crash:Record crash information when the APP crashes, the corresponding type is `TDAutoTrackEventType.APP_CRASH`
+1. Page view:The APP is triggered when using Navigator route jump,the corresponding type is `TDAutoTrackEventType.APP_VIEW_SCREEN`
+1. Element click:The APP control click event will be triggered when the user clicks the control. The corresponding type is `TDAutoTrackEventType.APP_CLICK`
+pay attention to auto-tracking event:
+1. The auto-tracking event is implemented in the native SDK, so Dynamic Public Properties cannot be added to the automatic collection event at present.
+1. If you need to set the distinct ID or public properties, please complete the settings before enabling automatic event collection.
+Example of enabling auto-tracking:
+```typescript
+TDAnalytics.enableAutoTrack(TDAutoTrackEventType.APP_START | TDAutoTrackEventType.APP_END | TDAutoTrackEventType.APP_INSTALL| TDAutoTrackEventType.APP_CRASH | TDAutoTrackEventType.APP_CLICK | TDAutoTrackEventType.APP_VIEW_SCREEN);
+```
+
+## **2. Detailed Introduction**
+### 2.1 Page view events
+The app's page browsing events support React Navigation ^2.0 ~ ^6.0.
+The APP is triggered when using Navigator route jump. The detailed event description is as follows:
+- Event Name：ta_app_view
+- Preset Properties：
+  `#screen_name`：String type, page name
+  `#title`：String type, page title
+  `#referrer`：String type, forward address
+- Steps to start：
+  - Call enableAutoTrack, passing in TDAutoTrackEventType.APP_VIEW_SCREEN
+  ```typescript
+  TDAnalytics.enableAutoTrack(TDAutoTrackEventType.APP_VIEW_SCREEN);
+  ```
+
+  - Execute script
+  ```typescript
+  node node_modules/react-native-thinking-data/ThinkingDataRNHook.js -run
+  ```
+
+- Set custom page attributes: When navigating via Navigation, you can add custom attributes in params. The SDK will automatically use the settings in params to supplement or override the attributes of the App's page browsing events.
+  ```typescript
+  navigation.navigate('PageB', {
+    thinkingdataparams: {
+      name: 'name_A',
+      '#title': 'page_two',
+      '#screen_name': "page_B"
+    }
+  });
+  ```
+
+If you need to customize #title and #screen_name, you can pass them in the thinkingdataparams parameter.
+- Ignore individual page view events: Adding the TDIgnoreViewScreen property to thinkingdataparams with a value of true will ignore the page view event.
+  ```typescript
+  navigation.navigate('PageB', {
+    thinkingdataparams: {
+      name: 'name_A',
+      '#title': 'page_two',
+      '#screen_name': "page_B",
+      TDIgnoreViewScreen: true
+    }
+  });
+  ```
+
+### 2.1 Element click event
+The APP control click event will be triggered when the user clicks the control
+- Event Name：ta_app_click
+- Preset Properties：
+  `#screen_name`：String type, page name
+  `#title`：String type, page title
+  `#element_content`：String type, element content
+- Steps to start：
+  - Call enableAutoTrack, passing in TDAutoTrackEventType.APP_CLICK
+  ```typescript
+  TDAnalytics.enableAutoTrack(TDAutoTrackEventType.APP_CLICK);
+  ```
+
+  - Execute script
+  ```typescript
+  node node_modules/react-native-thinking-data/ThinkingDataRNHook.js -run
+  ```
+
+- Set custom properties for the control: Add the custom property thinkingdataparams to the control.
+```typescript
+<CustomButton
+  title="button"
+  thinkingdataparams={{
+    name: 'button',
+    pro_key:'pro_value'
+  }}
+/>
+```
+
+- Ignore click events for individual controls: Adding the TDIgnoreViewClick property to thinkingdataparams with a value of true will ignore click events for that control.
+```typescript
+<CustomButton
+  title="button"
+  thinkingdataparams={{
+    name: 'button',
+    pro_key:'pro_value'
+    TDIgnoreViewClick: true
+  }}
+/>
+```
+
+## **3****. Set Auto-tracking Event Public Properties**
+You can call `setAutoTrackProperties` to set or update custom properties
+```javascript
+TDAnalytics.enableAutoTrack({
+    autoTrackTypes: TDAutoTrackEventType.APP_START,
+    properties: {
+        auto_name: "xxx",
+        auto_age: "xxx"
+    }
+})
+```

package/wiki/te-docs/raw/data-ingestion-guide/client-sdk/cross-platform/react-native/reactnative-advanced/debugging-and-logging.md

@@ -0,0 +1,54 @@
+---
+code: rn_sdk_debug
+name: "Debugging and Logging"
+wikiToken: R4uvwDh42iiwV8kS9mcc70Zbnhc
+parentWikiToken: GKCGw8Y4IitlKEk4miNccirjnfc
+updateTime: 1774249185000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=en-US&code=rn_sdk_debug
+---
+
+During the process of SDK integration, you can perform real-time debugging by checking SDK's logs in the IDE console or using the Debug feature of TE.
+## Printing Log
+You can set enableLog to true when the SDK is initialized, and turn on the SDK log switch. After turning on, the reported data will be printed on the IDE console.
+```java
+TDAnalytics.init({ 
+    appId: "xxx", 
+    serverUrl: "https://xxx", 
+    enableLog: true 
+}); 
+```
+
+<quote-container>
+After opening the log, you can check data tracking of SDK by filtering logs related to ThinkingAnalytics in IDE.
+</quote-container>
+
+## **2. Debugging**
+You need to follow the following two steps to enable the Debug mode:
+1. Enable the debug mode at the client side
+The sample code for enabling the Debug mode on the client side is as follows:
+```dart
+/*
+Set the operation mode as the Debug mode
+NORMAL mode: the data would be saved in caches and reported according to relevant cache policies under the NORMAL mode by default. It is recommended to use the mode in an online environment
+Debug mode: report data item by item. If problems occur, the user would be notified with logs and anomalies. It is recommended to use the Debug mode in an online environment
+DebugOnly mode: data would be verified without being stored; it is not recommended to use the DebugOnly mode in an online environment
+ */
+TDAnalytics.init({ 
+    appId: "xxx", 
+    serverUrl: "https://xxx", 
+    mode:"debug"
+}); 
+```
+
+2. Add Device
+To avoid launching the Debug mode in the production environment, it is required that only specified device can enable Debug mode. The Debug mode can only be enabled for devices whose IDs have been configured in the "Debugger"sector on the "Tracking Management" page of TE when the client side has enabled the Debug mode.
+<image token="STbkbWvtMoMYTExnVIycuhA5nAb" width="1280" height="590" align="center"/>
+
+Device ID could be got by the following three means:
+- #Device_id property in the event data of TE
+- Client-side log: DeviceID would be printed as log after SDK is initialized
+- Call API：[Device ID](https%3A%2F%2Fthinkingdata.feishu.cn%2Fwiki%2FKRaFwoiOZiprEEkEKN1cER8an6g%3FfromScene%3DspaceOverview)
+<quote-container>
+The Debug mode may undermine the data tracking quality and stability of the App. It could only be used for data verification at the integration stage, and should not be used in the online environment.
+</quote-container>
+

package/wiki/te-docs/raw/data-ingestion-guide/client-sdk/cross-platform/react-native/reactnative-advanced/preset-properties.md

@@ -0,0 +1,18 @@
+---
+code: rn_sdk_preset_properties
+name: "Preset Properties"
+wikiToken: RfDTw9QYNiY0AckcJZicnBOon7b
+parentWikiToken: GKCGw8YI4itlKEk4miNccirjnfc
+updateTime: 1774251993000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=en-US&code=rn_sdk_preset_properties
+---
+
+## 1. Description of Preset Properties
+The preset properties collected by iOS and Android platforms will have certain differences. For details, please refer to the following documents:
+[iOS platform preset properties](https://thinkingdata.feishu.cn/wiki/Ny61w1VIbi5Qeok94fRcJhulned),[android platform preset properties](https://thinkingdata.feishu.cn/wiki/MBnZwHrO0ibkd9ksCSBc7dxEnic)
+## **2. Getting Preset Properties**
+```javascript
+async () => {
+  var presetProperties = await TDAnalytics.getPresetProperties()
+}
+```

package/wiki/te-docs/raw/data-ingestion-guide/client-sdk/cross-platform/react-native/reactnative-advanced.md

@@ -0,0 +1,305 @@
+---
+code: rn_sdk_advanced
+name: "ReactNative-Advanced"
+wikiToken: GKCGw8YI4itlKEk4miNccirjnfc
+parentWikiToken: E1F3wNsc3iW7dckzhH9cA2h2nIg
+updateTime: 1774251992000
+sourceUrl: https://docs-v2.thinkingdata.cn/?version=v6.0&lan=en-US&code=rn_sdk_advanced
+---
+
+## 1**. Managing User Identity**
+SDK instances would use random UUID as the default distinct ID of each user by default, which would be used as the identity identification ID of users under an unlogged-in state. It should be noted that the distinct ID would change after the user reinstalled the App or use the APP with a new device.
+### **1.1. Identify**
+::: tip
+Generally speaking, you do not need to customize a distinct ID.Please ensure that you understand [User Identification Rules](https://thinkingdata.feishu.cn/wiki/Pov9wECdsi2QQsk4NN9cEPsvnyc)<text color="purple"> </text>before setting a distinct ID. 
+If you need to change the distinct ID, please call the api immediately after SDK is initialized. To avoid the generation of useless accounts, please do not call such a process multiple times.
+:::
+If your App has its own distinct ID management system for each user, you can call `identify` to set the distinct ID:
+```java
+// set distinct ID as Thinker
+TDAnalytics.setDistinctId("Thinker");
+```
+
+If you need to get the current distinct ID, please call `getDistinctId`:
+```java
+//Return distinct ID
+async () => {
+  var distinct_id = await TDAnalytics.getDistinctId()
+}
+```
+
+### **1.2 Login**
+When the users  log in, `login` could be called to set the account ID of the user. TE  would use the account ID as the identity identification ID, and the account ID that has been set would be saved before `logout` is called. The previous account ID would be replaced if `login` has been called multiple times.
+```java
+// The login unique identifier of the user, corresponding to the #account_id in data tracking. #Account_id now is TE
+TDAnalytics.login("TA");
+```
+
+<quote-container>
+**Login events wouldn't be uploaded in this method.**
+</quote-container>
+
+### **1.3 Removing Account ID**
+After the user logs out, `logout` could be called to remove the account ID. The distinct ID would be used as the identity identification ID before the next time `login` is called. 
+```java
+TDAnalytics.logout();
+```
+
+It is recommended that you call logout upon explicit logout event. For example, call `logout` when the user commits the behavior of canceling an account; do not call such a process when the App is closed.
+<quote-container>
+**Logout events wouldn't be uploaded in this method.**
+</quote-container>
+
+## **Sending Events**
+After SDK is initialized, you can track user behaviour data. In general, ordinary events could meet business requirements. You can also use the First/Updatable Event based on your own service scenario.
+### **2.1 Ordinary Events**
+ You can call `track` to upload events. It is suggested that you set event properties based on the data tracking plan drafted previously. Here is an example of a user buying an item:
+```javascript
+TDAnalytics.track({
+    eventName:"product_buy",
+    properties:{
+      'product_name':'tv'
+    }
+})       
+```
+
+### **2.2 First Events**
+The First Events refers to events that would only be recorded once for the ID of a certain device or other dimensions. For example, under certain scenarios, you may want to record the activation event on a certain device. In this case, you can perform data tracking with the first event.
+```javascript
+TDAnalytics.trackFirst({
+    eventName:'device_activation',
+    properties: {
+        KEY_NUMBER: 1.02,
+        KEY_STRING: "name",
+        KEY_LIST: [1, 2, 3],
+        KEY_BOOL: true,
+        KEY_DateTime: "2020-05-12 06:27:18.371"
+    },
+    eventId:'YOUR_ACCOUNT_ID'
+})
+```
+
+If you want to judge whether an event is the first event from other dimensions, you can define a first_check_id for the First Event:
+```javascript
+//set the user ID as the first_check_id of the first event to track the first initialization event of the user.
+TDAnalytics.trackFirst({
+    eventName:'device_activation',
+    properties: {
+        KEY_NUMBER: 1.02,
+        KEY_STRING: "name",
+        KEY_LIST: [1, 2, 3],
+        KEY_BOOL: true,
+        KEY_DateTime: "2020-05-12 06:27:18.371"
+    },
+    eventId:'TA'
+})
+```
+
+<quote-container>
+Note: Since the server has to check whether the event is the first event, the first event will be put in storage one hour later by default.
+</quote-container>
+
+### **2.3 Updatable Events**
+You can meet the requirements for event data modification under specific scenarios through updatable events. The ID of Updatable Events should be specified and uploaded when the objects of updatable events are created. TE would determine the data to be updated according to the event name and event ID.
+```javascript
+//The event property status is 3 after reporting, with the price being 100
+TDAnalytics.trackUpdate({
+    eventName:'UPDATABLE_EVENT',
+    properties: { status: 3, price: 100},
+    eventId:'test_event_id'
+})
+//The event property status is 5 after reporting, with the price remaining the same
+TDAnalytics.trackUpdate({
+    eventName:'UPDATABLE_EVENT',
+    properties: { status: 5},
+    eventId:'test_event_id'
+})
+```
+
+### **2.4 Overwritable Event****s**
+Despite the similarity with Updatable Events, Overwritable Events would replace all historical data with the latest data. Looking from the perspective of effect, such a process is equivalent to the behavior of deleting the previous data while putting the latest data in storage. TE would determine the data to be updated according to the event name and event ID.
+```javascript
+//The event property status is 3 after reporting, with the price being 100
+TDAnalytics.trackOverwrite({
+    eventName:'OVERWRITE_EVENT',
+    properties: { status: 3, price: 100},
+    eventId:'test_event_id'
+})
+//The event property status is 5 after reporting, with the price deleted
+TDAnalytics.trackOverwrite({
+    eventName:'OVERWRITE_EVENT',
+    properties: { status: 5},
+    eventId:'test_event_id'
+})
+```
+
+### **2.5 Super Properties**
+Super Properties refer to properties that would be uploaded by each event. Super Properties could be divided into `static super properties` and `dynamic super properties`based on the update frequency. You can select different methods for super property setting according to business requirements; we recommend that you set Super Properties first before sending events. In the same event, when the keys of Super Properties, self-defined event properties, and preset properties are the same, we would assign value according to the following priority:  `self-defined properties>dynamic super properties>static super properties>preset properties`.
+#### **2.5.1 Static Super Properties**
+Static Super properties are properties that all events might have and would change with a low frequency, for example, the user membership class. After setting Static Super Properties through `setSuperProperties`, SDK would use the preset super properties as the event properties when tracking events.
+```javascript
+TDAnalytics.setSuperProperties({ vip_level: 2})
+```
+
+Static Super Properties would be saved in local storage, and should not be called every time the App is closed. If such properties already exist, the reset properties would replace the original properties. If such properties do not exist, properties would be newly created. In addition to property setting, we also provide other APIs to set and manage Static Super Properties and meet general business requirements.
+```javascript
+//clear a certain super property
+TDAnalytics.unsetSuperProperty("superKey")
+//clear all certain super properties
+TDAnalytics.clearSuperProperties()
+//obtain all certain super properties
+async () => {
+  var properties = await TDAnalytics.getSuperProperties()
+}
+```
+
+#### **2.5.2 ****Dynamic Super Properties**
+Dynamic Super Properties that all events might have and would change with a high frequency, for example, the quantity of the gold coins the user possesses. After setting Dynamic Super Properties through `setDynamicSuperPropertiesTracker`, SDK would get the properties in `getDynamicSuperProperties` during event tracking automatically, and add such properties to the event triggered.
+```javascript
+var coin = 0;
+TDAnalytics.setDynamicSuperProperties(function () {
+    return { coin: coin++ }
+})
+```
+
+### **2.6 Timing Events**
+If you need to record the duration of a certain event, you can call `timeEvent` . Configure the name of the event you want to record. When you upload the event, `#duration` would be added to your event property automatically to record the duration of the event (Unit: second). It should be noted that only one task can be timed with the same event name.
+```javascript
+//The following instance has recorded the time the user spent on a certain product page
+//The user enters the product page and starts the timing
+TDAnalytics.timeEvent("stay_shop")
+/**do someting
+    .......
+    **/
+//the timing would end when the user leaves the product page. "stay_shop" event would carry#duration, a property representing event duration. 
+TDAnalytics.track({eventName:"stay_shop")
+```
+
+## **3. User Properties**
+User property setting APIs supported by TE  include: `userSet`,`userSetOnce`,`userAdd`,`userUnset`,`userDel``ete` , `userAppend`,`userUniqAppend`
+### 3.1 userSet
+You can call `userSet` to set general user properties. The original properties would be replaced if the properties uploaded via the API are used. The type of newly-created user properties must conform to that of the uploaded properties. User name setting is taken as the example here:
+```javascript
+//the username now is TA
+TDAnalytics.userSet({ username: "TA" });
+//the username now is TE
+TDAnalytics.userSet({ username: "TE" });
+```
+
+### 3.2 userSetOnce
+If the user property you want to upload only needs to be set once, you can call `userSetOnce` to set the property. If such property had been set before, this message would be neglected. Let's take the setting of the first payment time as an example:
+```javascript
+//first_payment_time is 2018-01-01 01:23:45.678
+TDAnalytics.userSetOnce({first_payment_time: "2018-01-01 01:23:45.678" });
+//first_payment_time is still 2018-01-01 01:23:45.678
+TDAnalytics.userSetOnce({first_payment_time: "2018-12-31 01:23:45.678" });
+```
+
+### 3.3 userAdd
+When you want to upload numeric attributes for cumulative operation, you can call `userAdd`.
+If the property has not been set, it would be given a value of 0 before computing. A negative value could be uploaded, which is equivalent to subtraction operation. Let's take the accumulative payment amount as an example:
+```javascript
+//in this case, the total_revenue is 30
+TDAnalytics.userAdd({ total_revenue: 30 });
+//in this case, the total_revenue is 678
+TDAnalytics.userAdd({ total_revenue: 648 });
+```
+
+<quote-container>
+The set attribute key is a string, and the Value is only allowed to be a numeric value.
+</quote-container>
+
+### 3.4 userUnset
+When you need to clear the user properties of users, you can call `userUnset` to clear specific properties.  `userUnset` would not create properties that have not been created in the cluster.
+```javascript
+TDAnalytics.userUnset("usersetkey")
+```
+
+### 3.5 userDelete
+You can call `userDel` to delete a user. After deleting the user, you would no longer be able to inquire about its user property, but could still obtain the events data triggered by the user.
+```java
+TDAnalytics.userDelete()
+```
+
+### 3.6 userAppend
+You can call `userAppend` to add user properties of array type.
+```javascript
+TDAnalytics.userAppend({ user_list: ["apple", "ball"] });
+```
+
+### 3.7 userUniqAppend
+You can call `userUniqAppend` to add user properties of array type. You can delete duplicated user property by calling `userUniqAppend` interface. If you call `userAppend` API, duplicated user property might not be deleted.
+```javascript
+//in this case, the property value of user_list is ["apple"，"ball"]
+TDAnalytics.userAppend({ user_list: ["apple", "ball"] });
+//in this case, the property value of user_list is ["apple","apple","ball","cube"]
+TDAnalytics.userAppend({ user_list: ["apple", "cube"] });
+//in this case, the property value of user_list is ["apple"，"ball","cube"]
+TDAnalytics.userUniqAppend({ user_list: ["apple", "cube"] });
+```
+
+## **4. Encryption**
+The SDK supports data encryption using AES+RSA. The data encryption function requires the cooperation of the client and the server. For specific usage methods, please consult customer success manager.
+```javascript
+import TDAnalytics, { TDAutoTrackEventType,TDThirdPartyType,TDTrackStatus} from "react-native-thinking-data";
+TDAnalytics.init({
+    appId: "xxx",
+    serverUrl: "https://xxx",
+    enableEncrypt: true,
+    secretKey: {
+        publicKey: "xxx",
+        version: 1,
+        symmetricEncryption: "AES",
+        asymmetricEncryption: "RSA"
+    }
+});
+```
+
+## **5. Enable H5 Connection **
+If you need to connect with the JavaScript SDK that tracks the data of H5, please call the following API. For detailed information, please refer to [<text underline="true">H5 and APP SDK Connection</text>](https://thinkingdata.feishu.cn/wiki/FOFZwGHJii1Jm2ke88DcFrrJnUb)
+```javascript
+<WebView
+  ref={webViewRef}
+  source={localHtmlFile}
+  onMessage={ event => {
+    console.log(event.nativeEvent.data);
+    TDAnalytics.h5ClickHandler(event.nativeEvent.data);
+  }}
+  javaScriptEnabled={true}
+  injectedJavaScript='window.ThinkingData_APP_ReactNative_Bridge = function(data) { window.ReactNativeWebView.postMessage(data); };'
+/>
+```
+
+## **6****. Other**
+### **6****.1  ****Device ID**
+You can call `getDeviceId` to obtain the device ID:
+```javascript
+async () => {
+  var device_id = await TDAnalytics.getDeviceId()
+}
+```
+
+### **6****.2 Time Calibration**
+SDK would use local time as the event time by default. If the user modifies the device time manually,  analysis would be affected. At this time, time calibration could be performed to ensure the accuracy of event time. We provide two time calibration methods: `timestamp` and `NTP.`
+- You can use the current timestamp obtained from the server to calibrate the time of SDK. Thereafter, all calling operations not assigned with a specific time would use the calibrated time as the occurrence time, including event data and user property setting.
+```java
+// 1585633785954 is the current unix time stamp, with the unit being millisecond; the corresponding Beijing time is 2020-03-31 13:49:45
+TDAnalytics.calibrateTime(1585633785954);
+```
+
+- You can also set the address of NTP server, after which SDK would try to obtain the current time from the uploaded NTP server address and calibrate the SDK time. If you failed to obtain the current return results within the default timeout interval (3s), local time would be used to track data.
+```java
+//use the NTP service of Apple Inc for time calibration 
+TDAnalytics.calibrateTimeWithNtp("time.apple.com");
+```
+
+<quote-container>
+1. Time calibration may fail due to unstable NTP server. It is suggested that you use a time stamp for time calibration as the priority
+2. You should select your NTP server address carefully to ensure that the device of the user could obtain server time rapidly under sound network conditions
+</quote-container>
+
+### 6.3 Flush
+You can call the `flush` API to report data to TE  immediately .
+```javascript
+TDAnalytics.flush();
+```