applican

マイページに戻る

LocalNotification

ローカル通知機能を提供します。iOSのみバッジの取得や設定も行えます。

機能

ローカル通知をスケジューリングする 【 schedule 】

スケジューリングされたローカル通知をキャンセルする 【 cancel 】

スケジューリングされたローカル通知を全てキャンセルする 【 allCancel 】

現在表示されているバッジの数を取得する 【 getBadgeNum 】

表示するバッジの数を設定する 【 setBadgeNum 】

利用用途

入力された日付データに合わせてのアラーム機能の実装を行いたい等、こちらの機能をご利用ください。

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

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

サンプル LocalNotification
サンプル LocalNotification
サンプル LocalNotification
サンプル LocalNotification

メソッド一覧

schedule

メソッド説明

schedule(Function successCallback, Function errorCallback, LocalNotificationOptions option)

ローカル通知をスケジューリングします。

パラメータ

successCallback : Function ローカル通知をスケジューリング出来たときにCallbackされます。
errorCallback : Function ローカル通知のスケジューリングに失敗した場合にCallbackされます。
options : LocalNotificationOptions ローカル通知のメッセージやクリックアクション、発動日などを指定します。

Return

void

サンプルコード

//ローカル通知
function localNotificationSchedule1(){		//5秒後
	var now = parseInt((new Date)/1000);
	var options = {
		alertId: 1,
		alertBody: "message1",
		uri: "http://www.yahoo.co.jp/",
		fireDate: now+5,
		//repeatInterval: "",
		alertAction: "開く",				//iOSのみ
		applicationIconBadgeNumber: 3,			//iOSのみ
	};
	applican.localNotification.schedule(localNotificationSchedule1Success, localNotificationSchedule1Error, options);
}
function localNotificationSchedule1Success(){
	var dump = "localNotificationSchedule1Success\n";
	document.getElementById("dumpAreaLocalNotification").value =dump;
}
function localNotificationSchedule1Error(res){
	var dump = "localNotificationSchedule1Error\n";
	dump += "code:"+res.code+"\n";
	document.getElementById("dumpAreaLocalNotification").value =dump;
}

function localNotificationSchedule2(){		//毎分0秒
	var fireDateUnixtime= (new Date(2000, 0, 1, 0, 0, 0))/ 1000;
	//alert(fireDateUnixtime);

	var options = {
		alertId: 4,
		alertBody: "message4",
		uri: "http://www.yahoo.co.jp/",
		fireDate: fireDateUnixtime,
		repeatInterval: "minute",
		alertAction: "開く",				//iOSのみ
		applicationIconBadgeNumber: 1,			//iOSのみ
	};
	applican.localNotification.schedule(localNotificationSchedule2Success, localNotificationSchedule2Error, options);
}
function localNotificationSchedule2Success(){
	var dump = "localNotificationSchedule2Success\n";
	document.getElementById("dumpAreaLocalNotification").value =dump;
}
function localNotificationSchedule2Error(res){
	var dump = "localNotificationSchedule2Error\n";
	dump += "code:"+res.code+"\n";
	document.getElementById("dumpAreaLocalNotification").value =dump;
}

cancel

メソッド説明

cancel(LocalNotificationOptions option)

スケジューリングされたローカル通知をキャンセルします。

パラメータ

options : LocalNotificationOptions  

Return

void

サンプルコード

function localNotificationCancel1(){		//キャンセル
	var options = {alertId: 1};
	applican.localNotification.cancel(options);

	var dump = "localNotificationCancel1\n";
	document.getElementById("dumpAreaLocalNotification").value =dump;
}

allCancel

メソッド説明

allCancel()

スケジューリングされたローカル通知を全てキャンセルします。

パラメータ

(none)

Return

void

サンプルコード

//すべてキャンセル
function localNotificationAllCancel(){
	applican.localNotification.allCancel();

	var dump = "localNotificationAllCancel\n";
	document.getElementById("dumpAreaLocalNotification").value =dump;
}

getBadgeNum

メソッド説明（iOSのみ）

applican.localNotification.getBadgeNum(Function successCallback);

現在表示されているバッジの数を取得します。

パラメータ

successCallback : Function 表示されたバッジの数が取得出来たときにCallbackされます。

Return

Number

サンプルコード

applican.localNotification.getBadgeNum(getBadgeNum_Success);

function getBadgeNum_Success(result){
	alert("num : "+result);
}

setBadgeNum

メソッド説明（iOSのみ）

applican.localNotification.setBadgeNum(Number BadgeNum);

表示するバッジの数を設定します。

パラメータ

Number : BadgeNum 表示させたいバッジの数を指定します。

Return

void

サンプルコード

applican.localNotification.setBadgeNum(3);