メソッドの概要

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

メソッドの詳細

ResultObject delete (EventKey eventKey, NoticeTargetType noticeTargetType, String reason)
イベントを削除します。

指定されたイベント対する編集権限がある場合のみ削除が可能です。

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

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

  • 指定されたイベントに対する参照権限がある
  • 指定されたイベントの添付ファイルに対する参照権限がある

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

指定されたイベントに対する参照権限がある場合のみ取得が可能です。

パラメータ
eventKey : EventKey
イベントキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、DisplayEvent が設定されます。
ResultObject findForEdit (EventKey eventKey)
更新用のイベントを取得します。

指定されたイベントに対する編集権限がある場合のみ取得が可能です。

パラメータ
eventKey : EventKey
イベントキー
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、DisplayEvent が設定されます。
ResultObject find (EventKey eventKey)
イベントを取得します。

指定されたイベントに対する参照権限がある場合のみ取得が可能です。

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

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

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

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

パラメータ
eventKey : EventKey
イベントキー
doNotice : Boolean
true : 通知者に通知する / false : 登録者に通知しない
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数が設定されます。
ResultObject register (Event event)
イベントを登録します。

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

パラメータ
event : Event
イベント情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、Event が設定されます。
ResultObject updateReminder (EventKey eventKey, EventReminder reminder)
イベントのリマインダを更新します。

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

パラメータ
eventKey : EventKey
イベントキー
reminder : EventReminder
リマインダー情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、処理件数が設定されます。
ResultObject update (Event event)
イベントを更新します。

指定されたイベントに対する編集権限がある場合のみ更新が可能です。
権限判定処理を行う場合、編集権限のない参加者が存在すると更新できません。

パラメータ
event : Event
イベント情報
返却値
ResultObject
ResultObject 処理結果オブジェクト
data プロパティには、Event が設定されます。