今回のメソッドは、予定に設定されているすべてのリマインダーを削除するremoveAllReminders()メソッドのご紹介をします。Google Apps Scriptにはリマインダーを1つずつ削除するメソッドは用意されていませんので、リマインダーを削除する場合はこちらのメソッドで削除することになります。
予定のすべてのリマインダーを削除する— removeAllReminders()
コピペで使えるサンプルコードを参照したい方はこちらをクリックすればサンプルコードまでジャンプできますので、手っ取り早くコードを確認したい方はクリックしてください。
それでは、早速概要を説明をしていきます。今回のコードの使い方はとても簡単なのですが、イベントオブジェクトに対してこちらのメソッドを使用すれば対象の予定から設定されているリマインダーをすべて削除することができます。使い方は簡単ですが、できればリマインダーを1つずつ削除するメソッドも用意してほしかったですねぇ。リマインダーをピンポイントで削除するには、一度こちらのメソッドでリマインダーをすべて削除して、再度リマインダーを設定するという流れになると思います。
それでは、サンプルコードを参考に使い方を学んでいきましょう。
『 引数に入れる値 』
今回のメソッドに関しては引数は必要ありません。
『 関連するメソッド 』
合わせて覚えたいリマインダー操作に関するメソッド
- get****Reminders — 予定のリマインダーを取得する
- add****Reminder — 予定にリマインダーを追加する
- resetRemindersToDefault — 予定のリマインダーを初期値に設定する
removeAllReminders()サンプルコード
//予定のリマインダーをすべて削除するコード
function sampleCodeForCalendarAppRemoveAllReminders() {
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.removeAllReminders());
}
}
『 変数の説明 』
calendar = デフォルトカレンダーを取得
date = プログラム実行日を代入
events = プログラム実行日の予定を取得
event = 個々予定を取得
スクリプトができたら▶ボタンでプログラムを実行してみましょう。今回のコードではプログラム実行日のすべての予定に設定されたリマインダーをすべて削除するコードを組んでみました。実行前後の確認はカレンダーのリマインダー設定部分で確認ができます。下記にスクリーンショットを記載しますので、ご自身のカレンダーでも処理前後で差分を確認してみてください。
プログラム実行前のリマインダー
プログラム実行後のリマインダー
実行前には3つ設定されていたリマインダーがすべてなくなっているのが確認できます。
このように今回ご紹介しているremoveAllReminders()メソッドは1回の処理ですべてのリマインダーを削除してしまいます。消したくないリマインダーがある場合には、一度削除したあとに再度リマインダーを設定する必要があります。
リマインダーを設定するためのメソッドは『【コピペで使える】GASでカレンダーにリマインダーを追加してみる』という記事で使い方を確認することができます。
まとめ
今回は予定に設定されているすべてのリマインダーを削除するremoveAllReminders()メソッドのご紹介をしました。使い方は簡単ですが、単体で使うだけでなく、関連するメソッドと併用して柔軟性をもたせた方が良いかもしれませんね。
サンプルコードはコピーしてスクリプトエディタに貼り付けることでそのまま利用が可能です。実際の挙動はご自身で確認してみてください。
コメント