動的設定と動的アップロードURLの更新¶
このドキュメントでは、UniApp SDK 0.3.0 以降のバージョンにおける、リモート設定のプッシュ更新とアップロード先URLの動的更新機能について説明します。
動的設定¶
リモート設定のプッシュ更新¶
uni-app アプリケーションで呼び出す前に、sdkConfig 内で remoteConfiguration: true を設定する必要があります。ホストアプリ内の uni ミニアプリについては、ホストアプリが Native SDK を初期化する際にリモート設定を有効にします。miniUpdateInterval には、この呼び出しで使用する最小更新間隔を指定します。
mobileAgent.updateRemoteConfigWithMiniUpdateInterval({
miniUpdateInterval: 0
}, result => {
if (result.success) {
console.log('remote config: ' + result.rawJson);
} else {
console.log('remote config failed: ' + result.errorMessage);
}
});
API - updateRemoteConfigWithMiniUpdateInterval¶
| リクエストフィールド | 型 | 必須 | 説明 |
|---|---|---|---|
| miniUpdateInterval | number | いいえ | 今回のプッシュ更新の最小間隔。範囲 [0,)、単位は秒。デフォルト 0 |
コールバックパラメータ:
| レスポンスフィールド | 型 | 説明 |
|---|---|---|
| success | boolean | 更新成功かどうか |
| platform | string | 現在のプラットフォーム |
| rawJson | string | 更新成功時に返される生のリモート設定 JSON 文字列 |
| errorCode | number/string | 更新失敗時のエラーコード |
| errorMessage | string | 更新失敗時のエラーメッセージ |
動的アップロードURLの更新¶
初期化時に datakitUrl と datawayUrl を両方とも省略できます。有効なアップロードURLが設定される前でも、SDK は初期化されデータをキャッシュできます。URL 設定後にアップロードを開始します。setDatakitURL と setDatawayURL はどちらか一方のみ使用します。DataWay に切り替える場合は、clientToken も同時に渡す必要があります。
mobileAgent.setDatakitURL({
datakitUrl: 'http://10.0.0.1:9529'
});
// DataWay を使用する場合は、以下のメソッドを setDatakitURL の代わりに呼び出します。
mobileAgent.setDatawayURL({
datawayUrl: 'https://open.dataway.url',
clientToken: 'client-token'
});
API - setDatakitURL¶
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
| datakitUrl | string | はい | 新しい Datakit アップロードURL |
API - setDatawayURL¶
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
| datawayUrl | string | はい | 新しい DataWay アップロードURL |
| clientToken | string | はい | DataWay のURLに対応する認証トークン |