【GAS】予定のリマインダーを削除するremoveAllRemindersメソッドを完全マスター

Contents

1 予定のすべてのリマインダーを削除する— removeAllReminders()
- 1.1 『引数に入れる値』
- 1.2 removeAllReminders()
  - 1.2.1 『変数の説明』
2 まとめ
- 2.1 関連

予定のすべてのリマインダーを削除する— removeAllReminders()

今回のメソッドは、予定に設定されているすべてのリマインダーを削除するremoveAllReminders()メソッドのご紹介をします。Google Apps Scriptにはリマインダーを1つずつ削除するメソッドは用意されていませんので、こちらのメソッドで削除する必要があります。

さて早速説明をしていきます。今回のコードはとてもかんたんですが、イベントオブジェクトに対してこちらのメソッドを使用すれば対象の予定からリマインダーがすべて削除されます。使い方は簡単ですが、できればリマインダーを1つずつ削除するメソッドも用意してほしかったですねぇ。

それでは、サンプルコードを参考に使い方を学んでいきましょう。

1. 1. removeAllReminders()

『引数に入れる値』

今回のメソッドに関しては引数は必要ありません。

removeAllReminders()

サンプルコード1

//予定のリマインダーをすべて削除するコード
function sampleCodeForCalendarAppRemoveAllReminders() {
  var calendar = CalendarApp.getDefaultCalendar();
  var date = new Date(); 
  var events = calendar.getEventsForDay(date);
  for (var i in events) {
    var event = events[i];
    Logger.log(event.removeAllReminders());
  }
}

『変数の説明』

calendar = デフォルトカレンダーを取得
date = プログラム実行日を代入
events = プログラム実行日の予定を取得
event = 個々予定を取得

スクリプトができたら▶ボタンでプログラムを実行してみましょう。今回のコードではプログラム実行日の予定に設定されたリマインダーをすべて削除するコードを組んでみました。実行前後の確認はカレンダーのリマインダー設定部分で確認してみようと思います。

プログラム実行前のリマインダー

プログラム実行後のリマインダー

実行前には3つ設定されていたリマインダーがすべてなくなっているのが確認できます。

このように今回ご紹介しているremoveAllReminders()メソッドは1回の処理ですべてのリマインダーを削除してしまいます。消したくないリマインダーがある場合には、一度削除したあとに再度リマインダーを設定する必要があります。

設定するためのメソッドはこちらをクリックして使い方を確認できます。

まとめ

今回は予定に設定されているすべてのリマインダーを削除するremoveAllReminders()メソッドのご紹介をしました。簡単な使い方ですので、この機会に自分のものにしてしまいましょう。

【GAS】予定のリマインダーを削除するremoveAllRemindersメソッドを完全マスター