予定が終日予定か判定する— isAllDayEvent()
今回のメソッドは、予定が終日予定か判定するisAllDayEvent()メソッドをご紹介します。このメソッドを利用することで、予定が終日予定なのかそうでないのかを判定することができます。
Google Apps Scriptでは、予定が終日予定なのかをプログラム的に判断するためのメソッドが用意されています。それが、今回ご紹介するisAllDayEvent()メソッドになります。
終日予定であれば、『true』、そうでなければ『false』が返されます。プログラム処理をする際は、期間やキーワードで一度に複数のイベントを取得して処理を行うことが高速化には必要なことですが、その際の処理の条件分岐などに今回のメソッドは活用できるかと思います。終日予定に対してのみ処理を実行することや、その逆もあり得ると思います。
それでは、具体的なサンプルコードで説明をします。
『 引数に入れる値 』
今回のメソッドに関しては引数は必要ありません。
isAllDayEvent()
//予定のゲストが予定を変更できるか取得するコード
function sampleCodeForCalendarAppIsAllDayEvent() {
var calendar = CalendarApp.getDefaultCalendar();
var date = new Date();
var events = calendar.getEventsForDay(date);
for (var i in events) {
var event = events[i];
console.log(event.isAllDayEvent());
}
}
『 変数の説明 』
calendar = デフォルトカレンダーを取得
date = プログラム実行日を代入
events = プログラム実行日の予定を取得
event = 個々予定を取得
スクリプトができたら▶ボタンでプログラムを実行してみましょう。今回のコードではプログラム実行日の予定が終日予定かどうかを判定して真偽値をログに表示するコードを書いてみました。私の環境では、2つの予定を作成し、1つは終日予定、もう1つは時間指定予定に設定しました。
下記のスクリーンショットを確認すると、『true』と『false』が出力されていることが確認できます。
上記サンプルコードをコピペしてもらい、プログラムの実行が終了したらCtrl + Enterを打鍵してログを確認してみましょう。終日予定の判定結果がログに出力されていればプログラムは問題なく動作しています。
まとめ
今回は予定が終日予定か判定するisAllDayEvent()メソッドのご紹介をしました。今回で予定が終日予定かそうでないのかをプログラム的に判定できるようになりましたので、今回のメソッドを活用してなにかプログラムを書いてみましょう。