関数と設定
インストール手順と、このプラグインの完全なMarkdownガイドを含むセットアッププロンプトをコピーします。
Updater Plugin の設定
「Updater Plugin の設定」というセクションGithub を参照してください README 詳細はこちら。
CapacitorUpdater は以下のオプションで設定できます:
| プロパティ | 種類 | 説明 | デフォルト | 以降 |
|---|---|---|---|---|
appReadyTimeout | number | アップデートを「失敗」と判定するまでの待機時間をミリ秒単位で設定します。Android、iOS、Electronで利用可能です。 | 10000 // (10 seconds) | |
responseTimeout | number | ネイティブプラグインが API をタイムアウトとみなすまで待機するミリ秒数を設定します。Android、iOS、Electronで利用可能です。 | 20000 // (20 seconds) | |
autoDeleteFailed | boolean | 失敗したbundleを自動的に削除するかどうかを設定します。Android、iOS、Electronで利用可能です。 | true | |
autoDeletePrevious | boolean | アップデート成功後に、以前のbundleを自動的に削除するかどうかを設定します。Android、iOS、Electronで利用可能です。 | true | |
autoUpdate | boolean | ‘off’ | ‘atBackground’ | ‘atInstall’ | ‘onLaunch’ | ‘always’ | ‘onlyDownload’ | アップデートサーバー経由のAuto Updateの動作を設定します。trueは「atBackground」と同じ、falseは「off」と同じです。 - off: Auto Updateを無効化 - atBackground: 自動チェックとダウンロードを行い、アプリがバックグラウンドに移行した際に適用 - atInstall: 新規インストールまたはネイティブアプリの更新直後のみ即時適用し、それ以外はatBackgroundを使用 - onLaunch: 起動時に即時適用し、それ以外は起動時チェック後にatBackgroundを使用 - always: Auto Updateが実行されるたびに即時適用 - onlyDownload: 自動でチェックとダウンロードを行い、updateAvailableを発行し、次のbundleを自動的に設定しません。即時適用モード(“atInstall”、“onLaunch”、“always”)は、アップデートでユーザー体験が低下しないよう、--delta を付けてアップロードしてください。AndroidとiOSでは、これらのモードに autoSplashscreen: true と、launchAutoHide: false を設定した @capacitor/splash-screen が必要です。Android、iOS、Electronで利用可能です。 | “atBackground” // true is still accepted | |
resetWhenUpdate | boolean | 新しいネイティブアプリのbundleがデバイスにインストールされた際、以前ダウンロードしたbundleを自動的に削除します。Android、iOS、Electronで利用可能です。 | true | |
updateUrl | string | アップデートチェックの送信先となるURL / エンドポイントを設定します。Android、iOS、Electronで利用可能です。 | https://plugin.capgo.app/updates | |
channelUrl | string | チャンネル操作用のURL / エンドポイントを設定します。Android、iOS、Electronで利用可能です。 | https://plugin.capgo.app/channel_self | |
statsUrl | string | アップデート統計の送信先となるURL / エンドポイントを設定します。Android、iOS、Electronで利用可能です。統計レポートを無効にするには""を設定してください。 | https://plugin.capgo.app/stats | |
publicKey | string | エンドツーエンドのlive update暗号化 Version 2用の公開鍵を設定します。Android、iOS、Electronで利用可能です。 | undefined | 6.2.0 |
version | string | アプリの現在のバージョンを設定します。これは最初のアップデートリクエストに使用されます。設定しない場合、プラグインはネイティブのcodeからバージョンを取得します。Android、iOS、Electronで利用可能です。 | undefined | 4.17.48 |
directUpdate | boolean | ‘always’ | ‘atInstall’ | ‘onLaunch’ | 非推奨。代わりにautoUpdateの文字列モード(“atInstall”、“onLaunch”、“always”)を使用してください。このオプションは既存のアプリで引き続きサポートされます。Instant applyは--deltaを付けてuploadしてください。そうしないとアップデートでユーザー体験が遅くなります。AndroidとiOSでは、これらのモードにはautoSplashscreen: trueと、launchAutoHide: falseを設定した@capacitor/splash-screenが必要です。 - false: 直接アップデートを一切行わない - atInstall: autoUpdate: “atInstall” と同じ - onLaunch: autoUpdate: “onLaunch” と同じ - always: autoUpdate: “always” と同じ - true: 後方互換性のため “always” と同じ。Android、iOS、Electronで利用可能です。 | false | 5.1.0 |
autoSplashscreen | boolean | 非推奨の directUpdate 値を含む即時適用モード(“atInstall”、“onLaunch”、“always”)を使用する場合に必須です。@capacitor/splash-screen をインストールし、launchAutoHide: false で設定する必要があります。有効にすると、アップデートの適用後、またはアップデートが不要な場合にプラグインがスプラッシュスクリーンを非表示にします。これにより、appReady イベントを手動でリッスンして SplashScreen.hide() を呼び出す必要がなくなります。Android と iOS で利用可能です。 | false | 7.6.0 |
periodCheckDelay | number | 定期アップデートチェックの間隔を設定します。単位は秒です。Android、iOS、Electron で利用可能です。600 秒(10 分)未満に設定することはできません。 | 600 // (10 minutes) | |
localS3 | boolean | テスト用のローカルサーバー、またはセルフホストのアップデートサーバーを使うよう CLI を設定します。 | undefined | 4.17.48 |
localHost | string | テスト用のローカルサーバー、またはセルフホストのアップデートサーバーを使うよう CLI を設定します。 | undefined | 4.17.48 |
localWebHost | string | テスト用のローカルサーバー、またはセルフホストのアップデートサーバーを使うよう CLI を設定します。 | undefined | 4.17.48 |
localSupa | string | テスト用のローカルサーバー、またはセルフホストのアップデートサーバーを使うよう CLI を設定します。 | undefined | 4.17.48 |
localSupaAnon | string | テスト用のローカルサーバーを使うよう CLI を設定します。 | undefined | 4.17.48 |
localApi | string | テスト用にローカルの api を使うように CLI を設定します。 | undefined | 6.3.3 |
localApiFiles | string | テスト用にローカルファイル api を使うように CLI を設定します。 | undefined | 6.3.3 |
allowModifyUrl | boolean | JavaScript 側から updateUrl、statsUrl、channelUrl を動的に変更できるようにします。 | false | 5.4.0 |
defaultChannel | string | 設定ファイルでアプリのデフォルトチャネルを設定します。大文字と小文字を区別します。この設定はクラウドで設定されたデフォルトチャネルを上書きしますが、クラウド側で行われたオーバーライドは引き続き尊重されます。 | undefined | 5.5.0 |
appId | string | 設定ファイルでアプリの app id を設定します。 | undefined | 6.0.0 |
keepUrlPathAfterReload | boolean | リロード後もURLパスを保持するようにプラグインを設定します。警告:リロードが実行されると、‘window.history’ はクリアされます。 | false | 6.8.0 |
disableJSLogging | boolean | プラグインのJavaScriptログ出力を無効にします。trueに設定すると、JavaScriptコンソールへのログ出力は行われず、ネイティブログのみが記録されます。 | false | 7.3.0 |
shakeMenu | boolean | デバッグやテスト用に、シェイクジェスチャーでアップデートメニューを表示する機能を有効にします | false | 7.5.0 |
では capacitor.config.json:
{ "plugins": { "CapacitorUpdater": { "appReadyTimeout": 1000 // (1 second), "responseTimeout": 10 // (10 second), "autoDeleteFailed": false, "autoDeletePrevious": false, "autoUpdate": "onlyDownload", "resetWhenUpdate": false, "updateUrl": https://example.com/api/auto_update, "channelUrl": https://example.com/api/channel, "statsUrl": https://example.com/api/stats, "publicKey": undefined, "version": undefined, "directUpdate": undefined, "autoSplashscreen": undefined, "periodCheckDelay": undefined, "localS3": undefined, "localHost": undefined, "localWebHost": undefined, "localSupa": undefined, "localSupaAnon": undefined, "localApi": undefined, "localApiFiles": undefined, "allowModifyUrl": undefined, "defaultChannel": undefined, "appId": undefined, "keepUrlPathAfterReload": undefined, "disableJSLogging": undefined, "shakeMenu": undefined } }}では capacitor.config.ts:
import { CapacitorConfig } from '@capacitor/cli';
const config: CapacitorConfig = { plugins: { CapacitorUpdater: { appReadyTimeout: 1000 // (1 second), responseTimeout: 10 // (10 second), autoDeleteFailed: false, autoDeletePrevious: false, autoUpdate: 'onlyDownload', resetWhenUpdate: false, updateUrl: https://example.com/api/auto_update, channelUrl: https://example.com/api/channel, statsUrl: https://example.com/api/stats, publicKey: undefined, version: undefined, directUpdate: undefined, autoSplashscreen: undefined, periodCheckDelay: undefined, localS3: undefined, localHost: undefined, localWebHost: undefined, localSupa: undefined, localSupaAnon: undefined, localApi: undefined, localApiFiles: undefined, allowModifyUrl: undefined, defaultChannel: undefined, appId: undefined, keepUrlPathAfterReload: undefined, disableJSLogging: undefined, shakeMenu: undefined, }, },};
export default config;notifyAppReady()setUpdateUrl(...)setStatsUrl(...)setChannelUrl(...)download(...)next(...)set(...)delete(...)list(...)reset(...)current()reload()setMultiDelay(...)cancelDelay()getLatest(...)setChannel(...)unsetChannel(...)getChannel()listChannels()setCustomId(...)getBuiltinVersion()getDeviceId()getPluginVersion()isAutoUpdateEnabled()removeAllListeners()addListener('download', ...)addListener('noNeedUpdate', ...)addListener('updateAvailable', ...)addListener('downloadComplete', ...)addListener('majorAvailable', ...)addListener('updateFailed', ...)addListener('downloadFailed', ...)addListener('appReloaded', ...)addListener('appReady', ...)isAutoUpdateAvailable()getNextBundle()setShakeMenu(...)isShakeMenuEnabled()- インターフェース
- 型エイリアス
メソッド
「メソッド」セクションnotifyAppReady()
「notifyAppReady()」セクションnotifyAppReady() => Promise<AppReadyResult>現在のbundleが正常に動作していることを Capacitor Updater に通知します(このメソッドがアプリ起動のたびに呼び出されない場合、ロールバックが発生します)。 デフォルトでは、アプリ起動後10秒以内にこのメソッドを呼び出す必要があります。呼び出されない場合はロールバックが実行されます。 この挙動は {@link appReadyTimeout} で変更可能です。
戻り値: Promise<AppReadyResult>
setUpdateUrl(…)
「setUpdateUrl(…)」セクションsetUpdateUrl(options: UpdateUrl) => Promise<void>アプリのupdateUrlを設定します。これはアップデートの確認に使用されます。
| パラメータ | 種類 | 説明 |
|---|---|---|
options | UpdateUrl | アップデートの確認に使用するURLが含まれます。 |
導入バージョン: 5.4.0
setStatsUrl(…)
「setStatsUrl(…)」セクションsetStatsUrl(options: StatsUrl) => Promise<void>アプリのstatsUrlを設定します。これは統計データの送信に使用されます。空の文字列を渡すと、統計の収集が無効になります。
| パラメータ | 種類 | 説明 |
|---|---|---|
options | StatsUrl | 統計データの送信に使用するURLが含まれます。 |
導入バージョン: 5.4.0
setChannelUrl(…)
「setChannelUrl(…)」セクションsetChannelUrl(options: ChannelUrl) => Promise<void>アプリのchannelUrlを設定します。これはチャンネルの設定に使用されます。
| パラメータ | 種類 | 説明 |
|---|---|---|
options | ChannelUrl | チャンネルの設定に使用するURLが含まれます。 |
導入バージョン: 5.4.0
download(…)
「download(…)」セクションdownload(options: DownloadOptions) => Promise<BundleInfo>指定されたURLから新しいbundleをダウンロードします。zipファイルで、中にファイルが直接入っているか、すべてのファイルを含む一意のIDのディレクトリが入っている必要があります。
| パラメータ | 種類 | 説明 |
|---|---|---|
options | DownloadOptions | {@link DownloadOptions} を使用して、新しいbundleのzipをダウンロードします。 |
戻り値: Promise<BundleInfo>
next(…)
セクション「next(…)」next(options: BundleId) => Promise<BundleInfo>アプリの再読み込み時に使用する次のbundleを設定します。
| パラメータ | 種類 | 説明 |
|---|---|---|
options | BundleId | 次回のアプリ起動時に設定する次の Bundle の ID が含まれます。{@link BundleInfo.id} |
戻り値: Promise<BundleInfo>
set(…)
セクション「set(…)」set(options: BundleId) => Promise<void>現在の bundle を設定し、すぐにアプリをリロードします。
| パラメータ | 種類 | 説明 |
|---|---|---|
options | BundleId | {@link BundleId} オブジェクト。現在の bundle id として設定する新しい bundle id を含みます。 |
delete(…)
セクション「delete(…)」delete(options: BundleId) => Promise<void>ネイティブアプリのストレージから指定した bundle を削除します。保存されている Bundle ID を取得するには {@link list} を併用してください。
| パラメータ | 種類 | 説明 |
|---|---|---|
options | BundleId | {@link BundleId削除するバンドルのIDを含む}オブジェクト(注: これはバンドルIDであり、バージョン名ではありません) |
list(…)
セクション「list(…)」list(options?: ListOptions | undefined) => Promise<BundleListResult>アプリ内でローカルにダウンロードされたすべてのバンドルを取得します
| パラメータ | 種類 | 説明 |
|---|---|---|
options | ListOptions | {@link ListOptionsバンドルをリストするための} |
戻り値: Promise<BundleListResult>
reset(…)
「reset(…)」セクションreset(options?: ResetOptions | undefined) => Promise<void>アプリを以下にリセットします: builtin bundle(Apple App Store / Google Play Store に送信されたもの)、または最後に正常にロードされた bundle。
| パラメータ | 種類 | 説明 |
|---|---|---|
options | ResetOptions | {@link ResetOptions.toLastSuccessful} を含む場合、}, true 組み込みの bundle にリセットし、 false 最後に正常にロードされた bundle にリセットされます。 |
current()
「current()」セクションcurrent() => Promise<CurrentBundleResult>現在の bundle を取得します。何も設定されていない場合は builtinを返します。currentNative はデバイスにインストールされているオリジナルの bundle です
戻り値: Promise<CurrentBundleResult>
reload()
「reload()」セクションreload() => Promise<void>ビューをリロードします
setMultiDelay(…)
「setMultiDelay(…)」セクションsetMultiDelay(options: MultiDelayConditions) => Promise<void>{@link DelayCondition} 配列を設定します。この配列には、Plugin がアップデートを遅延させるために使用する条件が含まれます。
すべての条件が満たされると、アップデートプロセスは通常どおり再開されるため、アプリをバックグラウンドに送るか終了させた後にアップデートがインストールされます。
date kind の場合、値は ISO8601形式の日付文字列である必要があります。
background kind の場合、値はミリ秒単位の数値である必要があります。
nativeVersion kind の場合、値はバージョン番号である必要があります。
kill kind の場合、値は使用されません。
この関数の挙動には一貫性がありません。kill オプションは、他のオプションのように次回バックグラウンドに移行したときではなく、最初の kill 後にアップデートをトリガーします。これは将来のメジャーリリースで修正される予定です。
| パラメータ | 種類 | 説明 |
|---|---|---|
options | MultiDelayConditions | を含む {@link MultiDelayConditions} 条件の配列を設定します |
導入バージョン: 4.3.0
cancelDelay()
セクション「cancelDelay()」cancelDelay() => Promise<void>{@link DelayCondition} をキャンセルして、更新を即座に処理します。
導入バージョン: 4.0.0
getLatest(…)
「getLatest(…)」セクションgetLatest(options?: GetLatestOptions | undefined) => Promise<LatestVersion>update URLから利用可能な最新のbundleを取得します
| パラメータ | 種類 |
|---|---|
options | GetLatestOptions |
戻り値: Promise<LatestVersion>
導入バージョン: 4.0.0
setChannel(…)
「setChannel(…)」セクションsetChannel(options: SetChannelOptions) => Promise<ChannelRes>このデバイスに対して、プラグイン管理のローカルチャネルを設定します。チャネルは allow_device_self_set これが機能するには有効になっている必要があります。
setChannel() バックエンドでチャンネルを検証してから、選択したチャンネルをデバイスにローカル保存します。バックエンドの Device Override を作成・更新しないため、Capgo ダッシュボードでデバイスが override 済みとして表示されることはありません。Device Override UI に表示されるのは、ダッシュボードまたは Public API から作成された割り当てだけです。
重要な注意事項:
- 起動時にチャンネルを設定するためにこのメソッドを使用しないでください。
defaultChannelCapacitor の設定で代わりに - を使用してください。このメソッドは、アプリの準備が整い、ユーザーが操作した後(例:ベータプログラムへの参加)に使用することを想定しています。
- Public チャンネルは自己割り当てできません。 チャンネルが
publicとしてマークされている場合、setChannel()を呼び出すとエラーが返されます。Public チャンネルを使用するには、代わりにunsetChannel()を呼び出してください。デバイスは自動的に一致する Public チャンネルにフォールバックします。 - 使用する
listChannels()を利用して、利用可能なチャンネルと自己割り当てが可能かどうかを確認してください。
| パラメータ | 種類 | 説明 |
|---|---|---|
options | SetChannelOptions | {@link SetChannelOptions} を設定する channel |
戻り値: Promise<ChannelRes>
導入バージョン: 4.7.0
unsetChannel(…)
“unsetChannel(…)”というタイトルのセクションunsetChannel(options: UnsetChannelOptions) => Promise<void>このデバイスのプラグイン管理ローカルチャネルを解除します。これにより、ローカルに保存されたチャネルのみがクリアされます。 setChannel()。Dashboard や Public API Device Override レコードは削除されません。
このメソッドを呼び出した後、通常のチャネル優先順位が適用されます。既存の Dashboard または Public API Device Override が優先されます。それ以外の場合、デバイスは条件(プラットフォーム、デバイスタイプ、ビルドタイプ)に一致する public/default チャネルにフォールバックできます。
次の場合に役立ちます:
- デバイスをデフォルトの更新トラックに戻したい場合
- public チャネルを使用したい場合(public チャネルは self-assign できないため
setChannel())
| パラメータ | 種類 |
|---|---|
options | UnsetChannelOptions |
導入バージョン: 4.7.0
getChannel()
セクション「getChannel()」getChannel() => Promise<GetChannelRes>このデバイスのチャネルを取得します
戻り値: Promise<GetChannelRes>
導入バージョン: 4.8.0
listChannels()
「listChannels()」セクションlistChannels() => Promise<ListChannelsResult>このデバイスで利用可能なすべてのチャンネルを一覧表示します。デバイスの現在の環境(プラットフォーム、エミュレータ/実機、dev/prod ビルド)に互換性があり、公開されているかセルフアサインが許可されているチャンネルを返します。
結果の各チャンネルには以下が含まれます:
public: もしtrue、これは デフォルトチャンネル。これには自分自身を割り当てられません。setChannel()を使用してチャンネルの割り当てを解除すると、unsetChannel()、デバイスはこのパブリックチャネルから自動的にアップデートを受信します。allow_self_set: もしtrue、これは セルフアサイン可能なチャネル。デバイスをこのチャネルに明示的に割り当てるには、次を使用します:setChannel().
戻り値: Promise<ListChannelsResult>
導入バージョン: 7.5.0
setCustomId(…)
セクション「setCustomId(…)」setCustomId(options: SetCustomIdOptions) => Promise<void>このデバイスにカスタムIDを設定する
| パラメータ | 種類 | 説明 |
|---|---|---|
options | SetCustomIdOptions | は {@link SetCustomIdOptions} の customId を設定します |
導入バージョン: 4.9.0
getBuiltinVersion()
「getBuiltinVersion()」セクションgetBuiltinVersion() => Promise<BuiltinVersion>ネイティブアプリのバージョン、または設定で指定された builtin バージョンを取得します
戻り値: Promise<BuiltinVersion>
導入バージョン: 5.2.0
getDeviceId()
「getDeviceId()」セクションgetDeviceId() => Promise<DeviceId>デバイスを識別するために使用される一意のIDを取得します(自動更新サーバーに送信されます)
戻り値: Promise<DeviceId>
getPluginVersion()
「getPluginVersion()」セクションgetPluginVersion() => Promise<PluginVersion>ネイティブの Capacitor Updater プラグインのバージョンを取得します(自動更新サーバーに送信されます)
戻り値: Promise<PluginVersion>
isAutoUpdateEnabled()
「isAutoUpdateEnabled()」セクションisAutoUpdateEnabled() => Promise<AutoUpdateEnabled>自動アップデート設定の状態を取得します。
戻り値: Promise<AutoUpdateEnabled>
removeAllListeners()
「removeAllListeners()」セクションremoveAllListeners() => Promise<void>このプラグインのすべてのリスナーを削除します。
導入バージョン: 1.0.0
addListener(‘download’, …)
「addListener(‘download’, …)」セクションaddListener(eventName: 'download', listenerFunc: (state: DownloadEvent) => void) => Promise<PluginListenerHandle>アプリ内のbundleダウンロードイベントをリッスンします。ダウンロード開始時、ダウンロード中、完了時に発火します。 ダウンロード中の進捗率(パーセント)をすべて返します。
| パラメータ | 種類 |
|---|---|
eventName | ‘download’ |
listenerFunc | (state: DownloadEvent) => void |
戻り値: Promise<PluginListenerHandle>
導入バージョン: 2.0.11
addListener(‘noNeedUpdate’, …)
セクション「addListener(‘noNeedUpdate’, …)」addListener(eventName: 'noNeedUpdate', listenerFunc: (state: NoNeedEvent) => void) => Promise<PluginListenerHandle>アップデート不要イベントをリッスンします。アプリ起動時に毎回強制チェックしたい場合に便利です。
| パラメータ | 種類 |
|---|---|
eventName | ‘noNeedUpdate’ |
listenerFunc | (state: NoNeedEvent) => void |
戻り値: Promise<PluginListenerHandle>
導入バージョン: 4.0.0
addListener(‘updateAvailable’, …)
「addListener(‘updateAvailable’, …)」セクションaddListener(eventName: 'updateAvailable', listenerFunc: (state: UpdateAvailableEvent) => void) => Promise<PluginListenerHandle>アップデートが利用可能になったイベントをリッスンします。アプリ起動時に毎回強制的にチェックしたい場合に便利です。
| パラメータ | 種類 |
|---|---|
eventName | ‘updateAvailable’ |
listenerFunc | (state: UpdateAvailableEvent) => void |
戻り値: Promise<PluginListenerHandle>
導入バージョン: 4.0.0
addListener(‘downloadComplete’, …)
「addListener(‘downloadComplete’, …)」セクションaddListener(eventName: 'downloadComplete', listenerFunc: (state: DownloadCompleteEvent) => void) => Promise<PluginListenerHandle>downloadComplete イベントを検知します。
| パラメータ | 種類 |
|---|---|
eventName | ‘downloadComplete’ |
listenerFunc | (state: DownloadCompleteEvent) => void |
戻り値: Promise<PluginListenerHandle>
導入バージョン: 4.0.0
addListener(‘majorAvailable’, …)
セクション「addListener(‘majorAvailable’, …)」addListener(eventName: 'majorAvailable', listenerFunc: (state: MajorAvailableEvent) => void) => Promise<PluginListenerHandle>アプリ内で Major update イベントを監視し、disableAutoUpdateBreaking 設定によって Major update がブロックされたことを通知します
| パラメータ | 種類 |
|---|---|
eventName | ‘majorAvailable’ |
listenerFunc | (state: MajorAvailableEvent) => void |
戻り値: Promise<PluginListenerHandle>
導入バージョン: 2.3.0
addListener(‘updateFailed’, …)
セクション「addListener(‘updateFailed’, …)」addListener(eventName: 'updateFailed', listenerFunc: (state: UpdateFailedEvent) => void) => Promise<PluginListenerHandle>アプリ内でアップデート失敗イベントをリッスンし、次回アプリ起動時にアップデートのインストールが失敗したときに通知します
| パラメータ | 種類 |
|---|---|
eventName | ‘updateFailed’ |
listenerFunc | (state: UpdateFailedEvent) => void |
戻り値: Promise<PluginListenerHandle>
導入バージョン: 2.3.0
addListener(‘downloadFailed’, …)
セクション「addListener(‘downloadFailed’, …)」addListener(eventName: 'downloadFailed', listenerFunc: (state: DownloadFailedEvent) => void) => Promise<PluginListenerHandle>アプリ内でダウンロード失敗イベントをリッスンし、bundle のダウンロードが失敗したときに通知します
| パラメータ | 種類 |
|---|---|
eventName | ‘downloadFailed’ |
listenerFunc | (state: DownloadFailedEvent) => void |
戻り値: Promise<PluginListenerHandle>
導入バージョン: 4.0.0
addListener(‘appReloaded’, …)
セクション「addListener(‘appReloaded’, …)」addListener(eventName: 'appReloaded', listenerFunc: () => void) => Promise<PluginListenerHandle>アプリ内のリロードイベントを監視し、リロードが発生したことを通知します
| パラメータ | 種類 |
|---|---|
eventName | ‘appReloaded’ |
listenerFunc | () => void |
戻り値: Promise<PluginListenerHandle>
導入バージョン: 4.3.0
addListener(‘appReady’, …)
セクション「addListener(‘appReady’, …)」addListener(eventName: 'appReady', listenerFunc: (state: AppReadyEvent) => void) => Promise<PluginListenerHandle>App 内の app ready イベントを監視し、アプリが使用可能になったことを通知します
| パラメータ | 種類 |
|---|---|
eventName | ‘appReady’ |
listenerFunc | (state: AppReadyEvent) => void |
戻り値: Promise<PluginListenerHandle>
導入バージョン: 5.1.0
isAutoUpdateAvailable()
セクション「isAutoUpdateAvailable()」isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>自動更新が利用可能かどうか(serverUrl によって無効化されていないか)を取得します。
戻り値: Promise<AutoUpdateAvailable>
getNextBundle()
「getNextBundle()」セクションgetNextBundle() => Promise<BundleInfo | null>アプリの再読み込み時に使用される次の bundle を取得します。 次の bundle が設定されていない場合は null を返します。
戻り値: Promise<BundleInfo | null>
導入バージョン: 6.8.0
setShakeMenu(…)
「setShakeMenu(…)」セクションsetShakeMenu(options: SetShakeMenuOptions) => Promise<void>デバッグ/テスト目的でシェイクメニューを有効化または無効化します
| パラメータ | 種類 | 説明 |
|---|---|---|
options | SetShakeMenuOptions | シェイクメニューの有効/無効を切り替える enabled ブール値を含む |
導入バージョン: 7.5.0
isShakeMenuEnabled()
「isShakeMenuEnabled()」セクションisShakeMenuEnabled() => Promise<ShakeMenuEnabled>シェイクメニューの現在の状態を取得します
戻り値: Promise<ShakeMenuEnabled>
導入バージョン: 7.5.0
インターフェース
「Interfaces」セクションAppReadyResult
「AppReadyResult」セクション| プロパティ | 種類 |
|---|---|
bundle | BundleInfo |
BundleInfo
「BundleInfo」セクション| プロパティ | 種類 |
|---|---|
id | string |
version | string |
downloaded | string |
checksum | string |
status | BundleStatus |
UpdateUrl
「UpdateUrl」セクション| プロパティ | 種類 |
|---|---|
url | string |
StatsUrl
セクション「StatsUrl」| プロパティ | 種類 |
|---|---|
url | string |
ChannelUrl
セクション「ChannelUrl」| プロパティ | 種類 |
|---|---|
url | string |
DownloadOptions
「DownloadOptions」セクションこのURLとバージョンは、サーバーからbundleをダウンロードするために使用されます。バックエンドを使用している場合、getLatestメソッドによってすべての情報が提供されます。 バックエンドを使用しない場合、bundleのURLとバージョンを指定する必要があります。bundleをCLIコマンドのencryptで暗号化した場合、SessionKeyが必要です。これらはコマンドの結果として受け取る必要があります。
| プロパティ | 種類 | 説明 | デフォルト | 以降 |
|---|---|---|---|---|
url | string | ダウンロードするbundle zipファイルのURL(例: dist.zip)。(Amazon S3、GitHubタグ、bundleをホストしているその他の場所など、任意のURLを指定できます。) | ||
version | string | このbundle/バージョンのversion code/name | ||
sessionKey | string | アップデートのセッションキー(bundleがセッションキーで暗号化されている場合) | undefined | 4.0.0 |
checksum | string | アップデートのチェックサム。sha256形式である必要があります。bundleが暗号化されている場合は、秘密鍵で暗号化してください。 | undefined | 4.0.0 |
manifest | ManifestEntry[] | Delta(manifest)のマルチファイルダウンロード用マニフェスト | undefined | 6.1.0 |
ManifestEntry
「ManifestEntry」セクション| プロパティ | 種類 |
|---|---|
file_name | string | null |
file_hash | string | null |
download_url | string | null |
BundleId
「BundleId」セクション| プロパティ | 種類 |
|---|---|
id | string |
BundleListResult
「BundleListResult」セクション| プロパティ | 種類 |
|---|---|
bundles | BundleInfo[] |
ListOptions
「ListOptions」セクション| プロパティ | 種類 | 説明 | デフォルト | 以降 |
|---|---|---|---|---|
raw | boolean | 生のバンドルリストを返すか、マニフェストを返すかを指定します。true の場合、リストはディスク上のファイルではなく内部データベースから読み取ろうとします。 | false | 6.14.0 |
ResetOptions
セクション「ResetOptions」| プロパティ | 種類 |
|---|---|
toLastSuccessful | boolean |
CurrentBundleResult
セクション「CurrentBundleResult」| プロパティ | 種類 |
|---|---|
bundle | BundleInfo |
native | string |
MultiDelayConditions
「MultiDelayConditions」セクション| プロパティ | 種類 |
|---|---|
delayConditions | DelayCondition[] |
DelayCondition
「DelayCondition」セクション| プロパティ | 種類 | 説明 |
|---|---|---|
kind | DelayUntilNext | setMultiDelay で遅延条件を設定する |
value | string |
LatestVersion
「LatestVersion」セクション| プロパティ | 種類 | 説明 | 以降 |
|---|---|---|---|
version | string | getLatest メソッドの結果 | 4.0.0 |
checksum | string | 6 | |
major | boolean | ||
message | string | ||
sessionKey | string | ||
error | string | ||
old | string | ||
url | string | ||
manifest | ManifestEntry[] | 6.1 |
GetLatestOptions
「GetLatestOptions」セクション| プロパティ | 種類 | 説明 | デフォルト | 以降 |
|---|---|---|---|---|
channel | string | 最新バージョンを取得する対象のチャンネル。動作させるには、チャンネルで ‘self_assign’ が許可されている必要があります。 | undefined | 6.8.0 |
ChannelRes
「ChannelRes」セクション| プロパティ | 種類 | 説明 | 以降 |
|---|---|---|---|
status | string | 設定されたチャンネルの現在のステータス | 4.7.0 |
error | string | ||
message | string |
SetChannelOptions
「SetChannelOptions」セクション| プロパティ | 種類 |
|---|---|
channel | string |
triggerAutoUpdate | boolean |
UnsetChannelOptions
セクション「UnsetChannelOptions」| プロパティ | 種類 |
|---|---|
triggerAutoUpdate | boolean |
GetChannelRes
セクション「GetChannelRes」| プロパティ | 種類 | 説明 | 以降 |
|---|---|---|---|
channel | string | get channel の現在のステータス | 4.8.0 |
error | string | ||
message | string | ||
status | string | ||
allowSet | boolean |
ListChannelsResult
「ListChannelsResult」セクション| プロパティ | 種類 | 説明 | 以降 |
|---|---|---|---|
channels | ChannelInfo[] | 利用可能なチャンネルの一覧 | 7.5.0 |
ChannelInfo
「ChannelInfo」セクション| プロパティ | 種類 | 説明 | 以降 |
|---|---|---|---|
id | number | 数値のチャネルID | 7.5.0 |
name | string | チャネル名 | 7.5.0 |
public | boolean | trueの場合、これはデフォルト/フォールバックチャネルです。デバイスはパブリックチャネルに自動割り当てできません。代わりに、デバイスがチャネルのオーバーライドを削除すると( unsetChannel()を使用)、対応するパブリックチャネルからの更新が自動的に配信されます。 | 7.5.0 |
allow_self_set | boolean | trueの場合、デバイスは setChannel()を使用して、このチャネルに明示的に自己割り当てできます。これは通常、ベータテスト、A/Bテスト、またはオプトイン更新トラックに使用されます。 | 7.5.0 |
チャネルコマンドでは、この数値の nameではなく、 id.
SetCustomIdOptions
セクション「SetCustomIdOptions」| プロパティ | 種類 |
|---|---|
customId | string |
BuiltinVersion
セクション「BuiltinVersion」| プロパティ | 種類 |
|---|---|
version | string |
DeviceId
セクション「DeviceId」| プロパティ | 種類 |
|---|---|
deviceId | string |
PluginVersion
セクション「PluginVersion」| プロパティ | 種類 |
|---|---|
version | string |
AutoUpdateEnabled
「AutoUpdateEnabled」セクション| プロパティ | 種類 |
|---|---|
enabled | boolean |
PluginListenerHandle
「PluginListenerHandle」セクション| プロパティ | 種類 |
|---|---|
remove | () => Promise<void> |
DownloadEvent
「DownloadEvent」セクション| プロパティ | 種類 | 説明 | 以降 |
|---|---|---|---|
percent | number | ダウンロードの現在の進捗状況(0〜100)。 | 4.0.0 |
bundle | BundleInfo |
NoNeedEvent
「NoNeedEvent」というセクション| プロパティ | 種類 | 説明 | 以降 |
|---|---|---|---|
bundle | BundleInfo | ダウンロードの現在の進捗状況(0〜100)。 | 4.0.0 |
UpdateAvailableEvent
セクション「UpdateAvailableEvent」| プロパティ | 種類 | 説明 | 以降 |
|---|---|---|---|
bundle | BundleInfo | ダウンロードの現在の進捗状況(0〜100)。 | 4.0.0 |
DownloadCompleteEvent
セクション「DownloadCompleteEvent」| プロパティ | 種類 | 説明 | 以降 |
|---|---|---|---|
bundle | BundleInfo | 新しいアップデートが利用可能になったときに発火します。 | 4.0.0 |
MajorAvailableEvent
セクション「MajorAvailableEvent」| プロパティ | 種類 | 説明 | 以降 |
|---|---|---|---|
version | string | 新しいメジャーバンドルが利用可能になったときに発火します。 | 4.0.0 |
UpdateFailedEvent
セクション「UpdateFailedEvent」| プロパティ | 種類 | 説明 | 以降 |
|---|---|---|---|
bundle | BundleInfo | アップデートのインストールに失敗したときに発行されます。 | 4.0.0 |
DownloadFailedEvent
セクション「DownloadFailedEvent」| プロパティ | 種類 | 説明 | 以降 |
|---|---|---|---|
version | string | ダウンロードに失敗したときに発行されます。 | 4.0.0 |
AppReadyEvent
セクション「AppReadyEvent」| プロパティ | 種類 | 説明 | 以降 |
|---|---|---|---|
bundle | BundleInfo | アプリが使用可能な状態になったときに発行されます。 | 5.2.0 |
status | string |
AutoUpdateAvailable
「AutoUpdateAvailable」セクション| プロパティ | 種類 |
|---|---|
available | boolean |
SetShakeMenuOptions
「SetShakeMenuOptions」セクション| プロパティ | 種類 |
|---|---|
enabled | boolean |
ShakeMenuEnabled
セクション「ShakeMenuEnabled」| プロパティ | 種類 |
|---|---|
enabled | boolean |
型エイリアス
セクション「Type Aliases」BundleStatus
セクション「BundleStatus」pending: bundleは次回のbundleとして SET されるのを待機中。 downloading: bundleをダウンロード中。 success: bundleのダウンロードが完了し、次回のbundleとして設定される準備が整いました。 SET 次のバンドルとして設定。 error: バンドルのダウンロードに失敗しました。
‘success’ | ‘error’ | ‘pending’ | ‘downloading’
DelayUntilNext
セクション「DelayUntilNext」‘background’ | ‘kill’ | ‘nativeVersion’ | ‘date’
Functions と設定から続ける
セクション「Functions and settingsから継続」使用している場合 関数と設定 ダッシュボードと API の運用を計画するには、これを次と連携させます @capgo/capacitor-updater を使用する 「@capgo/capacitor-updater を使用する」のネイティブ機能については、 API の概要 「API の概要」の実装の詳細については、 はじめに 「はじめに」における実装の詳細については、 API キー および「API Keys」の実装の詳細については、 デバイス 実装の詳細については Devices を参照してください。