メソッドの概要

返却値の型 メソッド名
ResultObject delete (ScheduleKey scheduleKey, NoticeTargetType noticeTargetType, String reason)
スケジュールを削除します。
ResultObject findAttachFile (FileKey fileKey)
ダウンロード用の添付ファイルパスを取得します。
ResultObject findForCopy (ScheduleKey scheduleKey)
コピー用のスケジュールを取得します。
ResultObject findForEdit (ScheduleKey scheduleKey)
更新用のスケジュールを取得します。
ResultObject find (ScheduleKey scheduleKey)
スケジュールを取得します。
ResultObject leaveWithReasonWhy (ScheduleKey scheduleKey, NoticeTargetType noticeTargetType, String reason)
スケジュールの参加を辞退します。
ResultObject leave (ScheduleKey scheduleKey, Boolean doNotice) 非推奨
スケジュールの参加を辞退します。
ResultObject register (Schedule schedule)
スケジュールを登録します。
ResultObject updateReminder (ScheduleKey scheduleKey, ScheduleReminder reminder)
スケジュールのリマインダを更新します。
ResultObject update (Schedule schedule)
スケジュールを更新します。

メソッドの詳細

ResultObject delete (ScheduleKey scheduleKey, NoticeTargetType noticeTargetType, String reason)
スケジュールを削除します。

指定されたスケジュールに対する編集権限がある場合のみ削除が可能です。

パラメータ
scheduleKey : ScheduleKey
スケジュールキー
noticeTargetType : NoticeTargetType
通知ターゲット
reason : String
削除理由
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数が設定されます。
ResultObject findAttachFile (FileKey fileKey)
ダウンロード用の添付ファイルパスを取得します。

以下のすべての条件を満たす場合のみ取得が可能です。

  • 指定されたスケジュールに対する参照権限がある
  • 指定されたスケジュールの添付ファイルに対する参照権限がある

パラメータ
fileKey : FileKey
添付ファイルキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、ScheduleDownloadFile が設定されます。
ResultObject findForCopy (ScheduleKey scheduleKey)
コピー用のスケジュールを取得します。

指定されたスケジュールに対する参照権限がある場合のみ取得が可能です。

パラメータ
scheduleKey : ScheduleKey
スケジュールキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、DisplaySchedule が設定されます。
ResultObject findForEdit (ScheduleKey scheduleKey)
更新用のスケジュールを取得します。

指定されたスケジュールに対する編集権限がある場合のみ取得が可能です。

パラメータ
scheduleKey : ScheduleKey
スケジュールキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、DisplaySchedule が設定されます。
ResultObject find (ScheduleKey scheduleKey)
スケジュールを取得します。

指定されたスケジュールに対する参照権限がある場合のみ取得が可能です。

パラメータ
scheduleKey : ScheduleKey
スケジュールキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、DisplaySchedule が設定されます。
ResultObject leaveWithReasonWhy (ScheduleKey scheduleKey, NoticeTargetType noticeTargetType, String reason)
スケジュールの参加を辞退します。

指定されたスケジュールに参加している場合のみ参加者から除外します。
他に参加者がいない場合はスケジュール自体の削除も行います。
当該メソッドでは常に権限判定処理は行われません。

パラメータ
scheduleKey : ScheduleKey
スケジュールキー
noticeTargetType : NoticeTargetType
通知ターゲット
reason : String
辞退理由
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数が設定されます。
ResultObject leave (ScheduleKey scheduleKey, Boolean doNotice) 非推奨
スケジュールの参加を辞退します。

指定されたスケジュールに参加している場合のみ参加者から除外します。
他に参加者がいない場合はスケジュール自体の削除も行います。
当該メソッドでは常に権限判定処理は行われません。

パラメータ
scheduleKey : ScheduleKey
スケジュールキー
doNotice : Boolean
true : 通知者に通知する / false : 登録者に通知しない
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数が設定されます。
ResultObject register (Schedule schedule)
スケジュールを登録します。

権限判定処理を行う場合、編集権限のない参加者および施設が存在すると登録できません。

パラメータ
schedule : Schedule
スケジュール情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、Schedule が設定されます。
ResultObject updateReminder (ScheduleKey scheduleKey, ScheduleReminder reminder)
スケジュールのリマインダを更新します。

指定されたスケジュールに参加している場合のみ更新が可能です。
当該メソッドでは常に権限判定処理は行われません。

パラメータ
scheduleKey : ScheduleKey
スケジュールキー
reminder : ScheduleReminder
リマインダー情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数が設定されます。
ResultObject update (Schedule schedule)
スケジュールを更新します。

指定されたスケジュールに対する編集権限がある場合のみ更新が可能です。
権限判定処理を行う場合、編集権限のない参加者および施設が存在すると更新できません。

パラメータ
schedule : Schedule
スケジュール情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、Schedule が設定されます。