はじめに

Cordova で whiteoctober/cordova-plugin-app-version を使って、アプリ名やアプリのバージョン情報などを取得する方法。

TL;DR

  • cordova plugin add cordova-plugin-app-version でプラグイン追加
  • 以下で情報取得
    • アプリ名: cordova.getAppVersion.getAppName()
    • パッケージ名: cordova.getAppVersion.getPackageName()
    • バージョンコード: cordova.getAppVersion.getVersionCode()
    • バージョン番号: cordova.getAppVersion.getVersionNumber()
  • async/await でも記述可能
  • OS, OS Version の取得は apache/cordova-plugin-device
この記事が参考になった方
ここかここからチャージや購入してくれると嬉しいです(ブログ主へのプレゼントではなく、ご自身へのチャージ)
欲しいもの / Wish list

目次

  1. はじめに
  2. TL;DR
  3. 環境・条件
  4. 詳細
    1. セットアップ
    2. 使い方
      1. アプリ名
      2. パッケージ名
      3. バージョンコード
      4. バージョン番号
      5. async/await を使う
    3. その他: OS, OS version の取得
  5. まとめ
  6. 参考文献

環境・条件

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
$ sw_vers
ProductName:	Mac OS X
ProductVersion:	10.15.6
BuildVersion:	19G2021

$ node -v
v12.7.0

$ npm -v
6.14.5

$ cordova --version
10.0.0

$ cordova plugin
cordova-plugin-app-version 0.1.9 "AppVersion"
cordova-plugin-device 2.0.3 "Device"

$ cordova platform
6.0.0
Installed platforms:
  android 9.0.0
  ios 6.1.1

詳細

セットアップ

cordova plugin add でプラグイン追加

1
$ cordova plugin add cordova-plugin-app-version

使い方

config.xml が以下の場合。

1
2
3
4
5
6
7
8
9
10
<?xml version='1.0' encoding='utf-8'?>
<widget
  id="com.example.app"
  version="1.2.3"
  xmlns="http://www.w3.org/ns/widgets"
  xmlns:cdv="http://cordova.apache.org/ns/1.0"
>
  <name>MyCordovaApp</name>
  ...
</widget>

アプリ名

1
2
3
4
cordova.getAppVersion.getAppName().then(appName => {
  console.log({ appName });
});
// => { "appName": "MyCordovaApp" }

パッケージ名

1
2
3
4
cordova.getAppVersion.getPackageName().then(packageName => {
  console.log({ packageName });
});
// => { "packageName": "com.example.app" }

バージョンコード

Returns the build identifier of the app

1
2
3
4
cordova.getAppVersion.getVersionCode().then(versionCode => {
  console.log({ versionCode });
});
// => { "versionCode": "1.2.3" }

バージョン番号

Returns the version number of the app

1
2
3
4
cordova.getAppVersion.getVersionNumber().then(versionNumber => {
  console.log({ versionNumber });
});
// => { "versionNumber": "1.2.3" }

async/await を使う

以下のように async/await でも OK

1
2
3
4
5
6
const getAppInfo = async () => {
  const appName = await cordova.getAppVersion.getAppName();
  const packageName = await cordova.getAppVersion.getPackageName();
  const versionCode = await cordova.getAppVersion.getVersionCode();
  const versionNumber = await cordova.getAppVersion.getVersionNumber();
},

その他: OS, OS version の取得

OS のバージョンなどを取得する場合は apache/cordova-plugin-device を使う。

1
2
3
4
5
6
7
// https://github.com/apache/cordova-plugin-device#deviceplatform
const os = device.platform;
// => 'iOS' や 'Android' など

// https://github.com/apache/cordova-plugin-device#deviceversion
const version = device.version;
// => '14.0' や '9' など

まとめ

  • cordova plugin add cordova-plugin-app-version でプラグイン追加
  • 以下で情報取得
    • アプリ名: cordova.getAppVersion.getAppName()
    • パッケージ名: cordova.getAppVersion.getPackageName()
    • バージョンコード: cordova.getAppVersion.getVersionCode()
    • バージョン番号: cordova.getAppVersion.getVersionNumber()
  • async/await でも記述可能
  • OS, OS Version の取得は apache/cordova-plugin-device

参考文献

関連記事

この記事が参考になった方
ここかここからチャージや購入してくれると嬉しいです(ブログ主へのプレゼントではなく、ご自身へのチャージ)
欲しいもの / Wish list