applican

マイページに戻る

Device

端末のハードウェア/ソフトウェアの情報です。

機能

Push通知用トークンを取得する 【 getPushToken 】

画面解像度と現在の画面の向きを取得する 【 getDisplayInfo 】

ライトを制御する 【 light 】 【 camera.light 】 ※camera.lightに移動しました。device.lightを呼んでもエラーは発生しませんが何も起こりません。

画面の常時点灯を制御する 【 keepScreenOn 】

広告用IDを取得する 【 getAdvertisingId 】

画面輝度レベルを取得する 【 getScreenBacklightLevel 】※ver.2.0用

画面輝度レベルを設定する 【 setScreenBacklightLevel 】※ver.2.0用

アプリの設定画面を開く 【 showApplicationSettings 】※iOSのみ

利用用途

アプリ内で入力された情報やPUSH通知用トークンの取得機能を実装したい場合は、こちらの機能をご利用ください。

【対応ランタイムバージョン】

ランタイムのバージョン毎に最適化したサンプルをダウンロードしてご使用ください。

サンプル Device
サンプル Device
サンプル Device
サンプル Device
サンプル Device
サンプル Device
サンプル Device
サンプル Device
サンプル Device
サンプル Device
サンプル Device
サンプル Device
サンプル Device
サンプル Device
サンプル Device

プロパティ

name : String 端末のモデル名を表します。
platform : String 端末のOS名を表します。
uuid : String アプリインストール時、自動生成されるUUIDを表します。
この値は、アプリがアンインストールされるか、アプリのデータ領域の消去操作によって異なる値に変更されます。
uuid_rfc4122 : String UUIDをRFC4122形式で表します。
version : String OSのバージョンを表します。
applican : String アプリカンのバージョンを表します。
applican_type : String アプリの種類を表します。
開発支援アプリ「アプリカンシミュレータ」の場合は「simulator」を返します。
それ以外のアプリの場合は「product」を返します。
package_name : String アプリのパッケージ名を表します。
iOSの場合はBundle Identifierを返します。

サンプルコード

//端末情報取得
function checkDeviceInfo(){
	var dump = "";
	dump += "端末名:"+applican.device.name+"\n";
	dump += "プラットフォーム:"+applican.device.platform+"\n";
	dump += "UUID:"+applican.device.uuid+"\n";
	dump += "UUID_RFC4122:"+applican.device.uuid_rfc4122+"\n";
	dump += "OSのバージョン:"+applican.device.version+"\n";
	dump += "アプリカンのバージョン:"+applican.device.applican+"\n";
	dump += "アプリの種類:"+applican.device.applican_type+"\n";
	dump += "パッケージ名:"+applican.device.package_name+"\n";

	document.getElementById("dumpAreaDeviceInfo").value = dump;
}

メソッド

getPushToken

メソッド説明

getPushToken(Function getPushTokenSuccess, Function getPushTokenError)

Push通知用トークンが取得できます。

パラメータ

getPushTokenSuccess : Function 成功時のコールバックの引数はトークンがオブジェクト形式で渡ります。
getPushTokenError : Function  

Return

void

サンプルコード

function getPushTokenSuccess(res){
	var token = res.pushToken;
}

getDisplayInfo

メソッド説明

getDisplayInfo(Function getDisplayInfo_success)

画面解像度と現在の画面の向きが取得できます。

パラメータ

getDisplayInfo_success : Function 成功時のコールバックの引数はオブジェクト形式の結果が渡されます。
orientation … 現在の画面の向き。“PORTRAIT” 又は “LANDSCAPE”
width … WebViewエリアの実解像度幅。
height … WebViewエリアの実解像度高さ。

Return

void

サンプルコード

function getDisplayInfo(){
	applican.device.getDisplayInfo(getDisplayInfo_success);
}
function getDisplayInfo_success(info){
	console.log(info.orientation);
	console.log(info.width);
	console.log(info.height);
}

補足

iPhone4などの高解像度端末ではjavascriptのwindow.innerWidth、window.innerHeightとは異なる値が取得されます。
例)
iPhone4で縦向きの時
window.innerWidth = 320
info.widht = 640

keepScreenOn

メソッド説明

keepScreenOn(boolean flag)

画面の常時点灯を制御できます。

パラメータ

flag : boolean 引数にtrueを渡すと画面が常時点灯になり、falseを渡すと常時点灯が解除されます。

Return

void

サンプルコード

applican.device.keepScreenOn(true);

getAdvertisingId

メソッド説明

getAdvertisingId(Function getAdvertisingIdSuccess, Function getAdvertisingIdError)

広告のターゲティングのために使用されるIDFA(広告ID)が取得できます。
IDFAは広告目的用はOSで用意された広告用IDです。
このメソッドを使用するにはプロジェクト管理画面のビルド設定において、追加オプションメニュー内の「IDFA(広告ID)」を「使用する」にチェックしてビルドする必要があります。
※このメソッドはアプリカンシミュレータでは確認することは出来ません。

パラメータ

getAdvertisingIdSuccess : Function 成功時にIDFA値がCallback関数に引数として渡されます。
getAdvertisingIDError : Function 失敗時にエラーコードがCallback関数に引数として渡されます。
エラーコードは以下のとおりです。
0:
不明なエラー
1:
CMSの設定で本APIが無効になっています
2:
広告IDの読み出しが端末側で許可されていません
3:
Google Playがインストールされていません (Androidのみ)
4:
Google Playサービスに接続できません (Androidのみ)
5:
Google Playサービス接続時に復旧可能なエラーが発生しました(Androidのみ)
※これはAndroid端末にインストールされている「Google Play開発者サービス」のバージョンが古い場合に発生することがあります。

Return

void

サンプルコード

//IDFA取得用メソッド呼び出し
applican.device.getAdvertisingId(getAdvertisingIdSuccess, getAdvertisingIdError);

//IDFA取得成功時のコールバック
function getAdvertisingIdSuccess(adid){
	alert(adid);
}
//IDFA取得失敗時のコールバック
function getAdvertisingIdError(err){
	alert(err.code);
}

getScreenBacklightLevel

メソッド説明

getScreenBacklightLevel(Function SuccessCallback, Function ErrorCallback)

画面輝度レベルを取得できます。

パラメータ

SuccessCallback : Function 画面輝度レベルが取得出来た場合にCallbackされます。
ErrorCallback : Function 値が取得出来なかった場合にCallbackされます。

Return

void

サンプルコード

//画面輝度レベル取得用メソッド呼び出し
applican.device.getScreenBacklightLevel(success);

//画面輝度レベル取得成功時のコールバック
function success(level) {
	console.log("getScreenBacklightLevel() successful.", level);
}

setScreenBacklightLevel

メソッド説明

setScreenBacklightLevel(Number Level, Function SuccessCallback, Function ErrorCallback)

画面輝度レベルを設定できます。

パラメータ

Level : Number 0-100までの数字を設定します。
SuccessCallback : Function 画面輝度レベルを設定出来た場合にCallbackされます。
ErrorCallback : Function 画面輝度レベルを設定出来なかった場合にCallbackされます。

Return

void

サンプルコード

//画面輝度レベル設定用メソッド呼び出し
applican.device.setScreenBacklightLevel(75, success);

//画面輝度レベル設定成功時のコールバック
function success() {
	console.log("setScreenBacklightLevel() successful.");
}

showApplicationSettings

メソッド説明

showApplicationSettings(String message, Function SuccessCallback, Function ErrorCallback, String title, String buttonName)

アプリの設定画面を開く

パラメータ

message : String ダイアログの説明文を指定します。
SuccessCallback : Function アプリの設定画面を開くことが出来た場合にCallbackされます。
ErrorCallback : Function アプリの設定画面を開くことが出来なかった場合にCallbackされます。
title : String ダイアログのタイトルを指定します。
buttonName : String ボタンに表示するテキストを指定します。

Return

void

サンプルコード

applican.device.showApplicationSettings(message, successCallback, failureCallback, title, buttonName);

//アプリの設定画面を開く成功時のコールバック
function successCallback() {
	console.log("showApplicationSettings() successful.");
}
//アプリの設定画面を開く失敗時のコールバック
function failureCallback() {
	console.log("showApplicationSettings() error.");
}