SDK Initialization¶

This document covers the initialization and runtime fundamentals of the UniApp SDK.

Basic Configuration¶

<script>
var ftModule = uni.requireNativePlugin("GCUniPlugin-MobileAgent");

export default {
    onLaunch: function() {
        ftModule.sdkConfig({
            datakitUrl: 'your datakitUrl',
            debug: true,
            env: 'common',
            globalContext: {
                custom_key: 'custom value'
            }
        });
    }
}
</script>

Remote Configuration and Data Filtering¶

var ftModule = uni.requireNativePlugin("GCUniPlugin-MobileAgent");

ftModule.sdkConfig({
    datakitUrl: 'http://10.0.0.1:9529',
    remoteConfiguration: true,
    remoteConfigMiniUpdateInterval: 600,
    enableDataFilter: true,
    dataFilters: {
        logging: [
            "{ message match [ 'password' ] }"
        ],
        rum: [
            "{ resource_status match [ '5..' ] }"
        ]
    }
});

• remoteConfiguration enables remote updates of SDK configurations such as sampling rate. To trigger an update manually, use updateRemoteConfigWithMiniUpdateInterval.
• dataFilters are local blacklist rules shipped with the app. Data matching any rule is discarded before being written to the local cache.
• Local and remote rules are applied together. Rules are evaluated after lineDataModifier, so the filtering is based on the modified data.
• Each rule is expressed as { condition }. For supported fields and value formats, see Blacklist Filtering Rules. Too many rules or overly complex regular expressions may affect data write performance.

Binding and Unbinding User Information¶

var ftModule = uni.requireNativePlugin("GCUniPlugin-MobileAgent");

ftModule.bindRUMUserData({
    userId: 'Test userId',
    userName: 'Test name',
    userEmail: 'test@123.com',
    extra: {
        age: '20'
    }
});

ftModule.unbindRUMUserData();

API - bindRUMUserData¶

API - unbindRUMUserData¶

Unbinds the current user.

Runtime Capabilities¶

Dynamically Update the Upload URL¶

SDK 0.2.7+ supports dynamically setting the upload URL after initialization. Use setDatakitURL or setDatawayURL (choose one). When switching to DataWay, you must provide clientToken as well.

You can omit both datakitUrl and datawayUrl during initialization. The SDK will still initialize and cache collected data. Once a valid upload URL is set, the SDK will start uploading to that address.

var ftModule = uni.requireNativePlugin("GCUniPlugin-MobileAgent");

ftModule.setDatakitURL({
    datakitUrl: 'http://10.0.0.1:9529'
});

// When using DataWay, call the following method instead of setDatakitURL.
ftModule.setDatawayURL({
    datawayUrl: 'https://open.dataway.url',
    clientToken: 'client-token'
});

API - setDatakitURL¶

API - setDatawayURL¶

Manually Update Remote Configuration¶

Before calling this method, you must set remoteConfiguration: true in sdkConfig. The miniUpdateInterval parameter in this call specifies the minimum update interval for this invocation; the initialization-time remoteConfigMiniUpdateInterval is not used.

var ftModule = uni.requireNativePlugin("GCUniPlugin-MobileAgent");

ftModule.updateRemoteConfigWithMiniUpdateInterval({
    miniUpdateInterval: 0
}, result => {
    if (result.success) {
        console.log('remote config: ' + result.rawJson);
    } else {
        console.log('remote config failed: ' + result.errorMessage);
    }
});

API - updateRemoteConfigWithMiniUpdateInterval¶

Callback parameters:

Shut Down the SDK¶

var ftModule = uni.requireNativePlugin("GCUniPlugin-MobileAgent");
ftModule.shutDown();

API - shutDown¶

Shuts down the SDK.

Clear SDK Cached Data¶

var ftModule = uni.requireNativePlugin("GCUniPlugin-MobileAgent");
ftModule.clearAllData();

API - clearAllData¶

Clears all data that has not yet been uploaded to the server.

Manually Sync Data¶

var ftModule = uni.requireNativePlugin("GCUniPlugin-MobileAgent");
ftModule.flushSyncData();

API - flushSyncData¶

When sdkConfig.autoSync is set to true, no additional action is required; the SDK syncs automatically.

When sdkConfig.autoSync is set to false, you must call this method manually to trigger data synchronization.