| Copyright | (c) 2015 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 |
Network.Google.Resource.Calendar.Events.Get
Description
Returns an event.
See: Calendar API Reference for calendar.events.get.
- type EventsGetResource = "calendar" :> ("v3" :> ("calendars" :> (Capture "calendarId" Text :> ("events" :> (Capture "eventId" Text :> (QueryParam "maxAttendees" (Textual Int32) :> (QueryParam "timeZone" Text :> (QueryParam "alwaysIncludeEmail" Bool :> (QueryParam "alt" AltJSON :> Get `[JSON]` Event)))))))))
- eventsGet :: Text -> Text -> EventsGet
- data EventsGet
- egCalendarId :: Lens' EventsGet Text
- egMaxAttendees :: Lens' EventsGet (Maybe Int32)
- egTimeZone :: Lens' EventsGet (Maybe Text)
- egAlwaysIncludeEmail :: Lens' EventsGet (Maybe Bool)
- egEventId :: Lens' EventsGet Text
REST Resource
type EventsGetResource = "calendar" :> ("v3" :> ("calendars" :> (Capture "calendarId" Text :> ("events" :> (Capture "eventId" Text :> (QueryParam "maxAttendees" (Textual Int32) :> (QueryParam "timeZone" Text :> (QueryParam "alwaysIncludeEmail" Bool :> (QueryParam "alt" AltJSON :> Get `[JSON]` Event))))))))) Source
A resource alias for calendar.events.get method which the
EventsGet request conforms to.
Creating a Request
Creates a value of EventsGet with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Returns an event.
See: eventsGet smart constructor.
Request Lenses
egCalendarId :: Lens' EventsGet 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.
egMaxAttendees :: Lens' EventsGet (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.
egTimeZone :: Lens' EventsGet (Maybe Text) Source
Time zone used in the response. Optional. The default is the time zone of the calendar.
egAlwaysIncludeEmail :: Lens' EventsGet (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.