In-App アップデーター プラグインは、アプリの再ビルド・再パッケージ化を行わずに、アプリで使用している HTML5 アセットを更新するためのプラグインです。
In-App アップデーター プラグインを使用する場合は、別途、更新ファイルをホストする Web サーバーが必要になります (アプリから、これらのファイルへアクセスできること )。
このプラグインを使用するためには、対応するプランへの加入が必要となります。詳細は、 料金プラン をご確認ください。
このプラグインは、カスタムビルドデバッガーでは利用できません。
動作検証を行う場合は、デバッグビルドを行い、実機で確認する必要があります。
サポート対象のプラットフォーム
Android 5.1 以降 (6.0以降を推奨)
プラグインの追加方法
Monaca クラウド IDE から設定 → Cordova プラグインの管理
を選択します。
利用可能なプラグイン 項目の InAppUpdater
プラグインにカーソルを置き、有効
ボタンをクリックします。
3. 次に、有効なプラグイン 項目へ行き、先ほど追加したプラグイン上に、カーソルを置き、設定
ボタンをクリックします。
更新用 HTML5 アセットの作成方法
Monaca クラウド IDE から、
ビルド → Androidアプリのビルド → リリース向けビルド → In-App Updater用更新ファイル
ビルド → iOSアプリのビルド → リリース向けビルド → In-App Updater用更新ファイル
を選択し、ビルドを開始する
ボタンをクリックします。
使い方
In-App アップデーター プラグインは、対象アプリのバージョンに対して、HTML5 アセットを更新します。
HTML5 アセットを更新する場合は、Web サーバー側の更新ファイルに新しい更新番号の設定を行います。
Web サーバー側の更新ファイルについては、CheckUpdate URL を参照ください。
※ Android 9以降ではhttp通信が禁止されているため、通信プロトコルについてこちらを確認ください。
プラグインの設定
本プラグインを利用するためには、CheckUpdate URL と Download URL の二つのWeb API(URL)が必要となります。
CheckUpdate URL
更新ファイル情報を提供する Web API の URL を指定します。更新ファイル情報は、以下のように JSON 形式で作成します。
更新ファイル情報は、getServerVersion() メソッドの Promise によって返される JSON オブジェクトの updateInfo
パラメータによって取得できます。
{
"ios": {
"2.1.0": { // アプリのバージョン
"1": { // 更新番号
"date": 20170113,
"url": "https://hogehoge.com/app/1/ios-v2.1.0.zip" // オプション
},
"2": { // 更新番号
"date": 20170113,
"url": "https://hogehoge.com/app/2/ios-v2.1.0.zip" // オプション
}
},
"2.2.0": { // アプリのバージョン
"1": { // 更新番号
"date": 20170210,
"url": "https://hogehoge.com/app/1/ios-v2.2.0.zip" // オプション
}
}
},
"android": {
"2.1.0": { // アプリのバージョン
"1": { // 更新番号
"date": 20170113,
"url": "https://hogehoge.com/app/1/android-v2.1.0.zip" // オプション
},
"2": { // 更新番号
"date": 20170113,
"url": "https://hogehoge.com/app/2/android-v2.1.0.zip" // オプション
}
},
"2.2.0": { // アプリのバージョン
"1": { // 更新番号
"date": 20170210,
"url": "https://hogehoge.com/app/1/android-v2.2.0.zip" // オプション
}
}
}
}
Download URL
更新用 HTML5 アセットファイル ( ZIP 形式 ) の URL を指定します。
API リファレンス
このプラグインの最もシンプルな使用方法は、autoUpdate() を使用して、更新ファイルのダウンロード ( プラグインの設定 を参照のこと ) とアプリの更新を自動で行うことです。
getServerVersion()、download()、updateAndRestart() などのメソッドを組わせて使用すれば、更新処理をカスタマイズすることもできます。
このプラグインが提供しているメソッドは次のとおりです。
getServerVersion()
更新ファイルの情報をサーバー側から取得します。
monaca.InAppUpdater.getServerVersion([args: JSON object]): Promise
パラメーター ( JSON オブジェクト)
戻り値 (Promise)
成功時のコールバックには、次のような内容の JSON オブジェクトが渡されます。
失敗時のコールバックには、エラーを示す JSON オブジェクトが渡されます。
例
monaca.InAppUpdater.getServerVersion().then(
function(json) {
alert( JSON.stringify(json) );
targetVersion = json.myVersion;
targetUpdateNumber = json.latestUpdateNumber;
url = json.updateInfo.url;
alert( targetVersion );
alert( targetUpdateNumber );
alert( url );
} ,
function(fail) { alert( JSON.stringify(fail) ); }
);
forceStopGetServerVersion()
getServerVersion()
の処理を中断します。
monaca.InAppUpdater.forceStopGetServerVersion(): Promise
パラメーター
戻り値 (Promise)
成功時のコールバックには、結果を格納した JSON オブジェクトが渡されます。
失敗時のコールバックには、エラーを示す JSON オブジェクトが渡されます。
例
monaca.InAppUpdater.forceStopGetServerVersion().then(
function(str) { alert("stop success"); } ,
function(fail) { alert( JSON.stringify(fail) ); }
);
getLocalVersion()
現在のアプリの更新番号を確認します。
monaca.InAppUpdater.getLocalVersion(): Promise
パラメーター
戻り値 (Promise)
成功時のコールバックには、結果を格納した JSON オブジェクトが渡されます。
失敗時のコールバックには、エラーを示す JSON オブジェクトが渡されます。
例
monaca.InAppUpdater.getLocalVersion().then(
function(json) { alert( JSON.stringify(json) ); } ,
function(fail) { alert( JSON.stringify(fail) ); }
);
download()
更新用ファイルをダウンロードします。
monaca.InAppUpdater.download(args: JSON object): Promise
パラメーター ( JSON オブジェクト)
戻り値 (Promise)
成功時のコールバックには、結果を格納した JSON オブジェクトが渡されます。
失敗時のコールバックには、エラーを示す JSON オブジェクトが渡されます。
進捗表示コールバックには、ダウンロードの進捗状況を示す、次のような JSON オブジェクトが渡されます。
例
monaca.InAppUpdater.download( { version : targetVersion, updateNumber : targetBuildNumber, url : url } ).then(
function(json) { alert( JSON.stringify(json) ); } ,
function(fail) { alert( JSON.stringify(fail) ); } ,
function(json) { console.log( json.count + "/" + json.total + " are done." ); }
);
forceStopDownload()
download()
の処理を中断します。
monaca.InAppUpdater.forceStopDownload(): Promise
パラメーター
戻り値 (Promise)
成功時のコールバックには、結果を格納した JSON オブジェクトが渡されます。
失敗時のコールバックには、エラーを示す JSON オブジェクトが渡されます。
例
monaca.InAppUpdater.forceStopDownload().then(
function(str) { alert("stop success"); } ,
function(fail) { alert( JSON.stringify(fail) ); }
);
updateAndRestart()
ダウンロードした更新用ファイルを展開し、アプリを再起動します。
monaca.InAppUpdater.updateAndRestart(): Promise
パラメーター
戻り値 (Promise)
成功時のコールバックには、結果を格納した JSON オブジェクトが渡されます。
失敗時のコールバックには、エラーを示す JSON オブジェクトが渡されます。
進捗表示コールバックには、展開処理の進捗状況を示す、次のような JSON オブジェクトが渡されます。
例
monaca.InAppUpdater.updateAndRestart().then(
function() { },
function(fail) { alert( JSON.stringify(fail) ); },
function(json) { console.log( json.count + "/" + json.total + " are done." ); }
);
status()
プラグインの状態を確認します。
monaca.InAppUpdater.status(): Promise
パラメーター
戻り値 (Promise)
成功時のコールバックには、次のような内容の JSON オブジェクトが渡されます。
失敗時のコールバックには、エラーを示す JSON オブジェクトが渡されます。
例
monaca.InAppUpdater.status().then(
function(json) { alert( JSON.stringify(json) ); },
function(fail) { alert( JSON.stringify(fail) ); }
);
showAlertDialog()
ダイアログ ( タイトルとメッセージ ) を表示します。
monaca.InAppUpdater.showAlertDialog(args: JSON object): Promise
パラメーター ( JSON オブジェクト)
戻り値 (Promise)
成功時のコールバックには、結果を格納した JSON オブジェクトが渡されます。
失敗時のコールバックには、エラーを示す JSON オブジェクトが渡されます。
例
monaca.InAppUpdater.showAlertDialog({
title : "Title" ,
message : "Message" ,
button : { label : "OK" , handler : function() { console.log("OK is clicked"); } },
cancel : { label : "Cancel" , handler : function() { console.log("Cancel is clicked"); } },
dismiss : function() { conole.log("Dismissed!"); }
} ).then(
function(btnLabel) { console.log("open"); },
function(fail) { console.log(JSON.stringify(fail)); }
);
dismissAlertDialog()
警告 ( Alert ) ダイアログを閉じます。
monaca.InAppUpdater.dismissAlertDialog(): Promise
パラメーター
戻り値 (Promise)
成功時のコールバックには、結果を格納した JSON オブジェクトが渡されます。
失敗時のコールバックには、エラーを示す JSON オブジェクトが渡されます。
例
setTimeout( function() {
monaca.InAppUpdater.dismissAlertDialog().then(
function(json) { console.log("OK auto close"); },
function(fail) { console.log(JSON.stringify(fail)); }
);
} , 1000 );
showProgressDialog()
進捗表示 ( Progress ) 用ダイアログを表示します。こちらのダイアログでは、更新の進捗状況が表示されます。
monaca.InAppUpdater.showProgressDialog(args: JSON object): Promise
パラメーター ( JSON オブジェクト)
戻り値 (Promise)
成功時のコールバックには、結果を格納した JSON オブジェクトが渡されます。
失敗時のコールバックには、エラーを示す JSON オブジェクトが渡されます。
例
monaca.InAppUpdater.showProgressDialog(
{ title : "Title" ,
message : "Message" ,
max : 100 ,
progress : 50 ,
cancel : { label : "Cancel" , handler : function() { console.log("cancel handler"); } } ,
dismiss : function() { console.log("dismissed."); }
} ).then(
function(json) {
console.log(JSON.stringify(json));
},
function(fail) {
console.log(JSON.stringify(fail));
}
);
changeProgressDialog()
進捗表示 ( Progress ) 用ダイアログを更新します。
monaca.InAppUpdater.changeProgressDialog(args: JSON object): Promise
パラメーター ( JSON オブジェクト)
戻り値 (Promise)
例
monaca.InAppUpdater.changeProgressDialog( { progress: progress } ).then(
function() {
if (progress < 100) {
setTimeout( function() { changeProgressDialog(progress+10); } , 500 );
} else {
monaca.InAppUpdater.dismissProgressDialog().then(
function(json) { console.log("complete"); } ,
function(error) { console.log(JSON.stringify(error)); }
);
}
}
)
dismissProgressDialog()
進捗表示 ( Progress ) 用ダイアログを閉じます。
monaca.InAppUpdater.dismissProgressDialog(): Promise
パラメーター
戻り値 (Promise)
成功時のコールバックには、結果を格納した JSON オブジェクトが渡されます。
失敗時のコールバックには、エラーを示す JSON オブジェクトが渡されます。
例
setTimeout( function() {
monaca.InAppUpdater.dismissProgressDialog().then(
function(json) { console.log(JSON.stringify(json)); } ,
function(error) { console.log( JSON.stringify(error) ); }
);
} , 1000 );
networkStatus()
ネットワークの状態 ( Wifi、3G/LTE、接続なし など ) を確認します。
monaca.InAppUpdater.networkStatus(): Promise
パラメーター
戻り値 (Promise)
成功時のコールバックには、次のような内容の JSON オブジェクトが渡されます。
失敗時のコールバックには、エラーを示す JSON オブジェクトが渡されます。
例
monaca.InAppUpdater.networkStatus().then(
function(json) { alert( JSON.stringify(json) ); },
function(fail) { alert( JSON.stringify(fail) ); }
);
terminateApp()
アプリを強制終了します。
このメソッドは、旧 InAppUpdater
( Cordova 5 向けの v2.0.4 ) との互換性を維持するために提供されているメソッドです。
こちらはクラッシュに相当するので、iOS での使用は推奨しません。Apple 側から申請をリジェクトされる可能性があります。
monaca.InAppUpdater.terminateApp()
パラメーター
戻り値 (Promise)
例
monaca.InAppUpdater.terminateApp();
autoUpdate()
更新ファイルのダウンロードとアプリの更新を自動的に行います。
monaca.InAppUpdater.autoUpdate(options: JSON object): Promise
パラメーター ( JSON オブジェクト)
戻り値 (Promise)
例
monaca.InAppUpdater.autoUpdate( {
connectDelay : 0000,
connectTimeout : 30000,
readTimeout: 300000,
nextTask : function(res) {
if (res.requireRestart) {
monaca.InAppUpdater.updateAndRestart().then(
function() { },
function(fail) { alert( JSON.stringify(fail) ); }
);
} else {
alert("App is started!");
}
},
failTask : function(res) {
monaca.InAppUpdater.showAlertDialog(
{ title : "Error Code "+res.error.code ,
message : res.error.message ,
button : { label : "OK" , handler : function() { } }
} ).then(
function(json) { },
function(fail) { }
);
}
});
Android 9 以降での注意点
Android 9 以降では、http プロトコルでの通信が原則禁止されています。
そのため、アップデートファイルを https
プロトコルで取得するように修正する必要があります。
動作テストなどで http プロトコルでの通信が必要となる場合は、以下のように、config.xml
の widget
タグに andorid 名前空間
設定を追加し、usesCleartextTraffic
設定を追加する必要があります。
<widget xmlns:android="http://schemas.android.com/apk/res/android">
<platform name="android">
<edit-config file="AndroidManifest.xml" target="/manifest/application" mode="merge">
<application android:usesCleartextTraffic="true" />
</edit-config>
</platform>
CustomSchemeの設定 (iOSのみ)
カスタムスキームは、Cordova 10以降 および 本プラグインのバージョン 6.1.0以降で設定いただけます。
本プラグインは、iOSの場合、単体でschemeとhostnameを設定することが可能です。(アプリロジック暗号化プラグインとは共通です。)
まず、デフォルトのschemeとhostnameの下記設定を削除します。これが指定されている場合、ビルドエラーとなります。
<preference name="scheme" value="monaca-app"/>
<preference name="hostname" value="localhost"/>
次にconfig.xml
に以下のようにschemeとhostnameを設定していきます。この例では、schemeをmonacax-app
、hostnameをmonacax.io
としています。
<preference name="monaca:scheme" value="monacax-app"/>
<preference name="monaca:hostname" value="monacax.io"/>
schemeは,小文字で始まる文字列で構成されます。 小文字で始まり,その後に、次の任意の組合せが続く小文字の文字列です。
また、monaca:scheme
と moanca:hostname
を省略 した場合、それぞれ monaca-plugin
と monaca.plugin
になります。
バージョン履歴
プライバシーマニフェスト
このプラグインで必要となるプライバシーマニフェストは以下のようになります。(cordova-ios 7.1.0以上)
<platform name="ios">
<privacy-manifest>
<key>NSPrivacyTracking</key>
<false/>
<key>NSPrivacyTrackingDomains</key>
<array/>
<key>NSPrivacyAccessedAPITypes</key>
<array>
<dict>
<key>NSPrivacyAccessedAPIType</key>
<string>NSPrivacyAccessedAPICategoryUserDefaults</string>
<key>NSPrivacyAccessedAPITypeReasons</key>
<array>
<string>CA92.1</string>
</array>
</dict>
<dict>
<key>NSPrivacyAccessedAPIType</key>
<string>NSPrivacyAccessedAPICategoryFileTimestamp</string>
<key>NSPrivacyAccessedAPITypeReasons</key>
<array>
<string>0A2A.1</string>
</array>
</dict>
</array>
<key>NSPrivacyCollectedDataTypes</key>
<array/>
</privacy-manifest>
</platform>
マニフェストの記述方法について詳しくは https://ja.docs.monaca.io/release_notes/ios-privacy-manifest#puraibashmanifesutono を参照して下さい。