Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Updates an event.
See: Calendar API Reference for calendar.events.update
.
Synopsis
- type EventsUpdateResource = "calendar" :> ("v3" :> ("calendars" :> (Capture "calendarId" Text :> ("events" :> (Capture "eventId" Text :> (QueryParam "conferenceDataVersion" (Textual Int32) :> (QueryParam "maxAttendees" (Textual Int32) :> (QueryParam "sendNotifications" Bool :> (QueryParam "supportsAttachments" Bool :> (QueryParam "sendUpdates" EventsUpdateSendUpdates :> (QueryParam "alwaysIncludeEmail" Bool :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Event :> Put '[JSON] Event)))))))))))))
- eventsUpdate :: Text -> Event -> Text -> EventsUpdate
- data EventsUpdate
- euConferenceDataVersion :: Lens' EventsUpdate (Maybe Int32)
- euCalendarId :: Lens' EventsUpdate Text
- euPayload :: Lens' EventsUpdate Event
- euMaxAttendees :: Lens' EventsUpdate (Maybe Int32)
- euSendNotifications :: Lens' EventsUpdate (Maybe Bool)
- euSupportsAttachments :: Lens' EventsUpdate (Maybe Bool)
- euSendUpdates :: Lens' EventsUpdate (Maybe EventsUpdateSendUpdates)
- euAlwaysIncludeEmail :: Lens' EventsUpdate (Maybe Bool)
- euEventId :: Lens' EventsUpdate Text
REST Resource
type EventsUpdateResource = "calendar" :> ("v3" :> ("calendars" :> (Capture "calendarId" Text :> ("events" :> (Capture "eventId" Text :> (QueryParam "conferenceDataVersion" (Textual Int32) :> (QueryParam "maxAttendees" (Textual Int32) :> (QueryParam "sendNotifications" Bool :> (QueryParam "supportsAttachments" Bool :> (QueryParam "sendUpdates" EventsUpdateSendUpdates :> (QueryParam "alwaysIncludeEmail" Bool :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Event :> Put '[JSON] Event))))))))))))) Source #
A resource alias for calendar.events.update
method which the
EventsUpdate
request conforms to.
Creating a Request
Creates a value of EventsUpdate
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data EventsUpdate Source #
Updates an event.
See: eventsUpdate
smart constructor.
Instances
Request Lenses
euConferenceDataVersion :: Lens' EventsUpdate (Maybe Int32) Source #
Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.
euCalendarId :: Lens' EventsUpdate Text Source #
Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
euMaxAttendees :: Lens' EventsUpdate (Maybe Int32) Source #
The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
euSendNotifications :: Lens' EventsUpdate (Maybe Bool) Source #
Deprecated. Please use sendUpdates instead. Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.
euSupportsAttachments :: Lens' EventsUpdate (Maybe Bool) Source #
Whether API client performing operation supports event attachments. Optional. The default is False.
euSendUpdates :: Lens' EventsUpdate (Maybe EventsUpdateSendUpdates) Source #
Guests who should receive notifications about the event update (for example, title changes, etc.).
euAlwaysIncludeEmail :: Lens' EventsUpdate (Maybe Bool) Source #
Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.