端末情報

次の JavaScript API を使用して、端末側を管理できます。

注釈

バックエンド API にアクセスする場合には、jQuery の読み込み、および、ホワイトリストへの cloud.monaca.mobi の登録 ( 各 OS の設定ファイル上に ) を行います。詳細は、Android の場合はこちら または iOS の場合はこちら をご確認ください。

メソッド/プロパティー

解説

monaca.cloud.Device.getProperty()

端末のプロパティーを 1 つ取得します

monaca.cloud.Device.getProperties()

端末のプロパティー群を一括で取得します。

monaca.cloud.Device.saveProperty()

端末のプロパティーを 1 つ更新します。

monaca.cloud.Device.saveProperties()

端末のプロパティー群を一括更新します。

Device.getProperty() - 端末のプロパティーを取得

端末のプロパティーを取得します。

monaca.cloud.Device.getProperty(name: String) : $.Promise

パラメーター
name

プロパティー名です。

done() コールバック関数の result パラメーター

( プロパティーの値 )

任意の値

 
戻り値

$.Promise オブジェクト

結果の処理には、 done()fail()always() を使用します。

端末のプロパティー値を取得する例を、次に記します。

monaca.cloud.Device.getProperty("nickname")
  .done
    (
      function(result)
      { console.log("Device's nickname: " + result); }
    )
  .fail
    (
      function(err)
      { /* error handling codes */ }
    )
  .always
    (
      function()
      { /* what must be done despite the outcome of the getProperty function */ }
    );

Device.getProperties() - 端末のプロパティー群を取得

端末のプロパティー群の値を、一括で取得します。

monaca.cloud.Device.getProperties(names: Array) : $.Promise

パラメーター
names

プロパティー名の配列です。

done() コールバック関数の result パラメーター

( プロパティー名 )

任意の値

 
戻り値

$.Promise オブジェクト

結果の処理には、 done()fail()always() を使用します。

端末のプロパティーを、2 つ取得する例を、次に記します。

monaca.cloud.Device.getProperties(["nickname", "color"])
  .done
    (
      function(result)
      {
        console.log("Properties: " + JSON.stringify(result));
        console.log("Device's nickname: " + result.nickname);
      }
    )
  .fail
    (
      function(err)
      { /* error handling codes */ }
    )
  .always
    (
      function()
      { /* what must be done despite the outcome of the getProperties function */ }
    );

Device.saveProperty() - 端末のプロパティーを 1 つ更新

端末のプロパティーを 1 つ更新します。

monaca.cloud.Device.saveProperty(name: String, value: String) : $.Promise

パラメーター
name

プロパティー名です。

value

追加または更新対象のプロパティーの値です。

必須
name

[a-zA-Z0-9] を使用して、 [a-zA-Z] で始まらなければなりません。

戻り値

$.Promise オブジェクト

結果の処理には、 done()fail()always() を使用します。

エラーコード

エラーが発生すると、 エラー オブジェクトを返します。

-32602

不正なパラメーターです。

端末側のニックネームを "Monaca" に変更する例を、次に記します。

monaca.cloud.Device.saveProperty("nickname", "Monaca")
  .done
    (
      function()
      { console.log("Saved."); }
    )
  .fail
    (
      function(err)
      { /* error handling codes */ }
    )
  .always
    (
      function()
      { /* what must be done despite the outcome of the saveProperty function */ }
    );

Device.saveProperties() - 端末のプロパティー群を一括更新

端末のプロパティー群の値を格納した配列を更新します。

monaca.cloud.Device.saveProperties(properties: Object) : $.Promise

パラメーター
properties

追加または更新する端末の追加のプロパティー群。

必須
properties

[a-zA-Z0-9] を使用して、 [a-zA-Z] から始まらなければなりません。データサイズは、 500KB 内です。

戻り値

$.Promise オブジェクト

結果の処理には、 done()fail()always() を使用します。

エラーコード

エラーが発生すると、 エラー オブジェクトを返します。

-32602

不正なパラメーターです。

端末の nicknamecolor の 2 つのプロパティーを追加・更新する例を、次に記します。

monaca.cloud.Device.saveProperties({"nickname": "Monaca", "color": "#9999FF"})
 .done
    (
      function()
      { console.log("Saved."); }
    )
  .fail
    (
      function(err)
      { /* error handling codes */ }
    )
  .always
    (
      function()
      { /* what must be done despite the outcome of the saveProperties function */ }
    );