メソッド説明

init(Function successCallback, Function<BeaconError> errorCallback)

Beacon API の初期化を行います。このメソッドを呼び出さないと、以降のメソッドは全て失敗します。
beacon-config.xmlが存在しない場合や、読み込みに失敗した場合はエラーを返します。

パラメータ

Return

サンプルコード

//　Beacon APIの初期化
applican.beacon.init(initBeaconSuccess, initBeaconError);
function initBeaconSuccess(){
	var dump = "beaconInitSuccess";
	alert(dump);
}

function initBeaconError(error){
	var dump = "beaconInitError\n";
	dump += "code:" + error.code + "\n";
	alert(dump);
}

メソッド説明

startMonitoring(Function successCallback, Function<BeaconError> errorCallback)

beacon-config.xml に記述されたビーコンのモニタリングを開始します。フォアグラウンド監視時、バックグラウンド監視時共に呼び出しが必要です。
このメソッドを呼び出した状態で、アプリをバックグラウンドへ移行するとバックグラウンド監視が開始されます。

パラメータ

Return

サンプルコード

// モニタリングの開始
applican.beacon.startMonitoring(startMonitoringSuccess, startMonitoringError);

function startMonitoringSuccess(){
	var dump = "beaconStartMonitoringSuccess";
	alert(dump);
}

function startMonitoringError(error){
	var dump = "beaconStartMonitoringError\n";
	dump += "code:" + error.code + "\n";
	alert(dump);
}

メソッド説明

stopMonitoring(Function successCallback, Function<BeaconError> errorCallback)

startMonitoring()で開始したビーコンのモニタリングを終了します。

パラメータ

Return

サンプルコード

// startMonitoring() で開始したモニタリングを終了する。
applican.beacon.stopMonitoring(stopMonitoringSuccess, stopMonitoringError);

function stopMonitoringSuccess(){
	var dump = "beaconStopMonitoringSuccess";
	alert(dump);
}

function stopMonitoringError(error){
	var dump = "beaconStopMonitoringError\n";
	dump += "code:" + error.code + "\n";
	alert(dump);
}

メソッド説明

isMonitoring(Function successCallback, Function<BeaconError> errorCallback)

ビーコンをモニタリング状態を取得します。

パラメータ

Return

サンプルコード

// ビーコンのモニタリング状態を取得
applican.beacon.isMonitoring(isMonitoringSuccess, isMonitoringError);

function isMonitoringSuccess(){
	var dump = "beaconIsMonitoringSuccess";
	alert(dump);
}

function isMonitoringError(error){
	var dump = "beaconIsMonitoringError\n";
	dump += "code:" + error.code + "\n";
	alert(dump);
}

メソッド説明

watchBeacon(Object beaconInfo, Function successCallback, Function<BeaconError> errorCallback)

アプリがフォアグラウンド時に、ビーコンの監視を開始します。beacon-config.xmlで定義したビーコン以外の監視は行えません。

パラメータ

Return

サンプルコード

// 監視するビーコンの情報
var beaconInfo = { uuid:'ABCDEFGH-0123-4567-8901-ABCDEFG01234', major:1, minor:2 };

// ビーコンの監視の開始。
var watchId = applican.beacon.watchBeacon(beaconInfo, watchBeaconResult, watchBeaconSuccess, watchBeaconError);

// 取得したビーコン情報
function watchBeaconResult(beacon){
	var uuid		= beacon.uuid;		// ビーコンの UUID
	var major		= beacon.major;		// ビーコンのメジャー番号
	var minor		= beacon.minor;		// ビーコンのマイナー番号
	var proximity	= beacon.proximity;	// 距離の精度（0:不明, 1:至近距離, 2:近距離, 3:遠距離）
	var accuracy	= beacon.accuracy;	// ビーコンまでの距離（メートル）
	var rssi		= beacon.rssi;		// 受信信号強度（dBm）
}

function watchBeaconSuccess(){
	var dump = "beaconWatchBeaconSuccess";
	alert(dump);
}

function watchBeaconError(error){
	var dump = "beaconWatchBeaconError\n";
	dump += "code:" + error.code + "\n";
	alert(dump);
}

メソッド説明

clearBeacon(Number watchId)

watchBeacon() で指定したビーコンを監視対象外にします。

Return

サンプルコード

// 監視IDを指定してビーコンの監視を対象外にする。
function clearBeacon(){
	applican.beacon.clearBeacon(watchId);
}

メソッド説明

getBeaconHistory(Object beaconInfo, Function successCallback, Function<BeaconError> errorCallback)

beacon-config.xmlの記述により、履歴保存対象となっているビーコンの履歴を取得します。
結果は成功コールバックで JSON 配列で返されます。

パラメータ

Return

サンプルコード

// 履歴を取得するビーコンの情報
var beaconInfo = { uuid:'ABCDEFGH-0123-4567-8901-ABCDEFG01234', major:1, minor:2 };

// 履歴を取得
applican.beacon.getBeaconHistory(beaconInfo, getBeaconHistorySuccess, getBeaconHistoryError);

function getBeaconHistorySuccess(beacons){

	var dump = "beaconWatchBeaconSuccess\n";
	for (var i in beacons){
		var beacon = beacons[i];
		dump += "-------------------\n";
		dump += beacon.uuid + "\n";	// ビーコンの UUID
		dump += beacon.major + "\n";	// ビーコンのメジャー番号
		dump += beacon.minor + "\n";	// ビーコンのマイナー番号
		dump += beacon.proximity + "\n";	// 距離の精度（0:不明, 1:至近距離, 2:近距離, 3:遠距離）
		dump += beacon.accuracy + "\n";	// ビーコンまでの距離（メートル）
		dump += beacon.rssi + "\n";		// 受信信号強度（dBm）
	}

	alert(dump);
}

function getBeaconHistoryError(error){
	var dump = "beaconWatchBeaconError\n";
	dump += "code:" + error.code + "\n";
	alert(dump);
}