applican

マイページに戻る

WiFi

WiFiの稼働状況の取得、ON/OFFの設定、アクセスポイントのSSID取得、接続を行います。

※getCurrentSSIDとgetCurrentIPv4AddressはIOSでも使用可能な機能です。

機能

利用用途

アプリ内からwifiの制御を行ったり、周辺のアクセスポイントのSSIDを取得したい場合、こちらの機能をご利用ください。

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

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

サンプル WiFi
サンプル WiFi
サンプル WiFi
サンプル WiFi
サンプル WiFi
サンプル WiFi
サンプル WiFi
サンプル WiFi
サンプル WiFi
サンプル WiFi
サンプル WiFi
サンプル WiFi

メソッド

getStatus

メソッド説明

getStatus(Function successCallback, Function errorCallback)

WiFiの稼働状況を読み取ります。
※Androidのみ使用可能

パラメータ

successCallback : Function WiFiの稼働状況を読み取れた場合に以下のステータスがCallbackされます。
WiFiStatus.WIFI_ON … 現在WiFiがONになっている
WiFiStatus.WIFI_OFF … 現在WiFiがOFFになっている
errorCallback : Function WiFiの稼働状況を読み取れなかった場合にエラーコードがCallbackされます。
{code : "エラーコード"}
WiFiError.PERMISSION_DENIED … パーミッションエラー
WiFiError.UNKNOWN_ERROR … 不明なエラー
WiFiError.DISCONNECT  … WiFiが無効
WiFiError.ILLEGAL_PARAMETER … 不正なパラメータ
WiFiError.CONNECT_FAILED … 接続失敗(APが無い、パスワード誤りなど)

Return

void

サンプルコード

applican.wifi.getStatus(getWiFiStatus_Success, getWiFiStatus_Error);

function getWiFiStatus_Success(status){
alert("getWiFiStatus_Success status:"+status);
}

function getWiFiStatus_Error(error){
alert("getWiFiStatus_Error code:"+error.code);
}

on

メソッド説明

on(Function successCallback, Function errorCallback)

WiFIをONにします。
※Androidのみ使用可能

パラメータ

successCallback : Function 成功時のコールバックに引数はありません。
errorCallback : Function 失敗時にエラーコードがCallbackされます。
{code : "エラーコード"}
WiFiError.PERMISSION_DENIED … パーミッションエラー
WiFiError.UNKNOWN_ERROR … 不明なエラー
WiFiError.DISCONNECT  … WiFiが無効
WiFiError.ILLEGAL_PARAMETER … 不正なパラメータ
WiFiError.CONNECT_FAILED … 接続失敗(APが無い、パスワード誤りなど)

Return

void

off

メソッド説明

off(Function successCallback, Function errorCallback)

WiFIをOFFにします。
※Androidのみ使用可能

パラメータ

successCallback : Function 成功時のコールバックに引数はありません。
errorCallback : Function 失敗時にエラーコードがCallbackされます。
{code : "エラーコード"}
WiFiError.PERMISSION_DENIED … パーミッションエラー
WiFiError.UNKNOWN_ERROR … 不明なエラー
WiFiError.DISCONNECT  … WiFiが無効
WiFiError.ILLEGAL_PARAMETER … 不正なパラメータ
WiFiError.CONNECT_FAILED … 接続失敗(APが無い、パスワード誤りなど)

Return

void

getSSIDList

メソッド説明

getSSIDList(Function successCallback, Function errorCallback)

周囲にあるアクセスポイントのSSID一覧を取得します。
※Androidのみ使用可能

パラメータ

successCallback : Function 成功時にSSIDの配列がCallbackされます。
errorCallback : Function 失敗時にエラーコードがCallbackされます。
{code : "エラーコード"}
WiFiError.PERMISSION_DENIED … パーミッションエラー
WiFiError.UNKNOWN_ERROR … 不明なエラー
WiFiError.DISCONNECT  … WiFiが無効
WiFiError.ILLEGAL_PARAMETER … 不正なパラメータ
WiFiError.CONNECT_FAILED … 接続失敗(APが無い、パスワード誤りなど)

Return

void

サンプルコード

applican.wifi.getSSIDList(getSSIDList_Success, getSSIDList_Error);

function getSSIDList_Success(result){
	var dump = "";
	var cnt = result.length;
	for(var i=0; i<cnt; i++){
		dump += result[i] + "\n";
	}
	alert(dump);
}
function getSSIDList_Error(err){
	alert(err.code);
}

getCurrentSSID

メソッド説明

getCurrentSSID(Function successCallback, Function errorCallback)

現在接続中のSSIDを取得します。
※iOSでも使用可能

パラメータ

successCallback : Function 成功時にSSIDがCallbackされます。
errorCallback : Function 失敗時にエラーコードがCallbackされます。
{code : "エラーコード"}
WiFiError.PERMISSION_DENIED … パーミッションエラー
WiFiError.UNKNOWN_ERROR … 不明なエラー
WiFiError.DISCONNECT  … WiFiが無効
WiFiError.ILLEGAL_PARAMETER … 不正なパラメータ
WiFiError.CONNECT_FAILED … 接続失敗(APが無い、パスワード誤りなど)

Return

void

サンプルコード

applican.wifi.getCurrentSSID(getCurrentSSID_Success, getCurrentSSID_Error);

function getCurrentSSID_Success(ssid){
	alert(ssid);
}
function getCurrentSSID_Error(err){
	alert(err.code);
}

getCurrentBSSID ※ver.2.0用

メソッド説明

getCurrentBSSID(Function successCallback, Function errorCallback)

現在接続中のBSSIDを取得します。

アプリカンAPIのver.2.0系から使用可能な機能です。
※Androidのみ使用可能

パラメータ

successCallback : Function 成功時にBSSIDがCallbackされます。
errorCallback : Function 失敗時にエラーコードがCallbackされます。
{code : "エラーコード"}
WiFiError.PERMISSION_DENIED … パーミッションエラー
WiFiError.UNKNOWN_ERROR … 不明なエラー
WiFiError.DISCONNECT  … WiFiが無効
WiFiError.ILLEGAL_PARAMETER … 不正なパラメータ
WiFiError.CONNECT_FAILED … 接続失敗(APが無い、パスワード誤りなど)

Return

void

サンプルコード

applican.wifi.getCurrentBSSID(getCurrentBSSID_Success, getCurrentBSSID_Error);

function getCurrentBSSID_Success(ssid){
	alert(ssid);
}
function getCurrentBSSID_Error(err){
	alert(err.code);
}

getCurrentIPv4Address ※ver.2.0用

メソッド説明

getCurrentIPv4Address(Function successCallback, Function errorCallback)

現在のIPv4のアドレスを取得します。

アプリカンAPIのver.2.0系から使用可能な機能です。
※iOSでも使用可能

パラメータ

successCallback : Function 成功時にIPv4AddressがCallbackされます。
errorCallback : Function 失敗時にエラーコードがCallbackされます。
{code : "エラーコード"}
WiFiError.PERMISSION_DENIED … パーミッションエラー
WiFiError.UNKNOWN_ERROR … 不明なエラー
WiFiError.DISCONNECT  … WiFiが無効
WiFiError.ILLEGAL_PARAMETER … 不正なパラメータ
WiFiError.CONNECT_FAILED … 接続失敗(APが無い、パスワード誤りなど)

Return

void

サンプルコード

applican.wifi.getCurrentIPv4Address(success, failure);

function success(result) {
	console.log("getCurrentIPv4Address() successful.");
}

function failure(error) {
	console.log("getCurrentIPv4Address() failure.", error);
}

getCurrentIPv6Address ※ver.2.0用

メソッド説明

getCurrentIPv6Address(Function successCallback, Function errorCallback)

現在のIPv6のアドレスを取得します。

アプリカンAPIのver.2.0系から使用可能な機能です。
※iOSでも使用可能

パラメータ

successCallback : Function 成功時にIPv6AddressがCallbackされます。
errorCallback : Function 失敗時にエラーコードがCallbackされます。
{code : "エラーコード"}
WiFiError.PERMISSION_DENIED … パーミッションエラー
WiFiError.UNKNOWN_ERROR … 不明なエラー
WiFiError.DISCONNECT  … WiFiが無効
WiFiError.ILLEGAL_PARAMETER … 不正なパラメータ
WiFiError.CONNECT_FAILED … 接続失敗(APが無い、パスワード誤りなど)

Return

void

サンプルコード

applican.wifi.getCurrentIPv6Address(success, failure);

function success(result) {
	console.log("getCurrentIPv6Address() successful.");
}

function failure(error) {
	console.log("getCurrentIPv6Address() failure.", error);
}

connect

メソッド説明

connect(Function successCallback, Function errorCallback, WiFiOptions options)

Wifi設定の登録と接続を行います。
※Androidのみ使用可能

パラメータ

successCallback : Function 登録/接続が成功時にターゲットのssidがCallbackされます。
errorCallback : Function 失敗時にエラーコードがCallbackされます。
{code : "エラーコード"}
WiFiError.PERMISSION_DENIED … パーミッションエラー
WiFiError.UNKNOWN_ERROR … 不明なエラー
WiFiError.DISCONNECT  … WiFiが無効
WiFiError.ILLEGAL_PARAMETER … 不正なパラメータ
WiFiError.CONNECT_FAILED … 接続失敗(APが無い、パスワード誤りなど)
options : WiFiOptions WiFi設定のオプションを設定します。

Return

void

サンプルコード

var options = {};
options.ssid = "testap1";
options.security = applican.wifi.SecurityType.WPA;
options.password = "1234567890123";
applican.wifi.connect(connectWifi_Success, connectWifi_Error, options);

function connectWifi_Success(ssid){
	alert(ssid);
}
function connectWifi_Error(err){
	alert(err.code);
}

getAccessPointList

メソッド説明

getAccessPointList(Function successCallback, Function errorCallback)

周囲にあるアクセスポイントの詳細情報を取得します。
※Androidのみ使用可能

パラメータ

successCallback : Function 成功時はアクセスポイント情報の配列がCallbackされます。

アクセスポイント情報
bssid … MACアドレス
ssid … SSID
level … 信号強度(dBm)
frequency … 周波数(MHz)
capabilitie … 暗号化情報
errorCallback : Function 失敗時にエラーコードがCallbackされます。

Return

void

サンプルコード

applican.wifi.getAccessPointList(getAccessPointList_Success, getAccessPointList_Error);
function getAccessPointList_Success(result){
	var dump = "getAccessPointList_Success\n";
	var cnt = result.length;
	dump += "num: "+cnt +"\n";
	for(var i=0; i<cnt; i++){
		dump += "-----------\n";
		dump += "ssid: "+result[i]['ssid'] +"\n";
		dump += "bssid: "+result[i]['bssid'] +"\n";
		dump += "level: "+result[i]['level'] +"\n";
		dump += "capabilities: "+result[i]['capabilities'] +"\n";
		dump += "frequency: "+result[i]['frequency'] +"\n";
	}
	alert(dump);
}
function getAccessPointList_Error(err){
	var dump = "getAccessPointList_Error\n";
	dump += "code:"+err.code+"\n";
	alert(dump);
}

getConfiguredNetworks

メソッド説明

getConfiguredNetworks(Function successCallback, Function errorCallback)

Wifiの接続履歴を取得します。
※Androidのみ使用可能

パラメータ

successCallback : Function 成功時はアクセスポイント情報の配列がCallbackされます。

アクセスポイント情報
ssid … SSID
status … 状態(CURRENT:接続中、ENABLED:接続可能、DISABLED:接続不可)
networkId … Androidシステム上の通番
errorCallback : Function 失敗時にエラーコードがCallbackされます。

Return

void

サンプルコード

applican.wifi.getConfiguredNetworks(getConfiguredNetworks_Success, getConfiguredNetworks_Error);
function getConfiguredNetworks_Success(result){
	var dump = "getConfiguredNetworks_Success\n";
	var cnt = result.length;
	dump += "num: "+cnt +"\n";
	for(var i=0; i<cnt; i++){
		dump += "-----------\n";
		dump += "ssid: "+result[i]['ssid'] +"\n";
		dump += "status: "+result[i]['status'] +"\n";
		dump += "networkId: "+result[i]['networkId'] +"\n";
	}
	alert(dump);
}
function getConfiguredNetworks_Error(err){
	var dump = "getConfiguredNetworks_Error\n";
	dump += "code:"+err.code+"\n";
	alert(dump);
}

hadConnected

メソッド説明

hadConnected(String ssid, Function successCallback, Function errorCallback)

接続したことがあるSSIDかどうかを判別します。
※Androidのみ使用可能

パラメータ

ssid : String 調べる SSIDを設定します。
successCallback : Function 成功時のCallback引数へはtrueまたはfalseが返ります。
errorCallback : Function 失敗時にエラーコードがCallbackされます。

Return

void

サンプルコード

applican.wifi.hadConnected("TEST_SSID1", wifiHadConnected_Success, wifiHadConnected_Error);
function wifiHadConnected_Success(result){
	var dump = "wifiHadConnected_Success\n";
	dump += "result: "+result +"\n";
	alert(dump);
}
function wifiHadConnected_Error(err){
	var dump = "wifiHadConnected_Error\n";
	dump += "code:"+err.code+"\n";
	alert(dump);
}