gogol-apps-calendar-0.4.0: Google Calendar SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.Calendar.Events.Watch

Contents

Description

Watch for changes to Events resources.

See: Calendar API Reference for calendar.events.watch.

Synopsis

REST Resource

type EventsWatchResource = "calendar" :> ("v3" :> ("calendars" :> (Capture "calendarId" Text :> ("events" :> ("watch" :> (QueryParam "syncToken" Text :> (QueryParam "timeMin" DateTime' :> (QueryParam "orderBy" EventsWatchOrderBy :> (QueryParam "singleEvents" Bool :> (QueryParams "privateExtendedProperty" Text :> (QueryParam "showDeleted" Bool :> (QueryParam "q" Text :> (QueryParams "sharedExtendedProperty" Text :> (QueryParam "maxAttendees" (Textual Int32) :> (QueryParam "iCalUID" Text :> (QueryParam "updatedMin" DateTime' :> (QueryParam "pageToken" Text :> (QueryParam "timeZone" Text :> (QueryParam "showHiddenInvitations" Bool :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alwaysIncludeEmail" Bool :> (QueryParam "timeMax" DateTime' :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Channel :> Post '[JSON] Channel)))))))))))))))))))))))) Source #

A resource alias for calendar.events.watch method which the EventsWatch request conforms to.

Creating a Request

data EventsWatch Source #

Watch for changes to Events resources.

See: eventsWatch smart constructor.

Instances
Eq EventsWatch Source # 
Instance details

Defined in Network.Google.Resource.Calendar.Events.Watch

Data EventsWatch Source # 
Instance details

Defined in Network.Google.Resource.Calendar.Events.Watch

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EventsWatch -> c EventsWatch #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EventsWatch #

toConstr :: EventsWatch -> Constr #

dataTypeOf :: EventsWatch -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c EventsWatch) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EventsWatch) #

gmapT :: (forall b. Data b => b -> b) -> EventsWatch -> EventsWatch #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EventsWatch -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EventsWatch -> r #

gmapQ :: (forall d. Data d => d -> u) -> EventsWatch -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> EventsWatch -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> EventsWatch -> m EventsWatch #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EventsWatch -> m EventsWatch #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EventsWatch -> m EventsWatch #

Show EventsWatch Source # 
Instance details

Defined in Network.Google.Resource.Calendar.Events.Watch

Generic EventsWatch Source # 
Instance details

Defined in Network.Google.Resource.Calendar.Events.Watch

Associated Types

type Rep EventsWatch :: Type -> Type #

GoogleRequest EventsWatch Source # 
Instance details

Defined in Network.Google.Resource.Calendar.Events.Watch

Associated Types

type Rs EventsWatch :: Type #

type Scopes EventsWatch :: [Symbol] #

type Rep EventsWatch Source # 
Instance details

Defined in Network.Google.Resource.Calendar.Events.Watch

type Rep EventsWatch = D1 (MetaData "EventsWatch" "Network.Google.Resource.Calendar.Events.Watch" "gogol-apps-calendar-0.4.0-JhVPsEbzg60HmmguA3hcFJ" False) (C1 (MetaCons "EventsWatch'" PrefixI True) ((((S1 (MetaSel (Just "_ewSyncToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ewCalendarId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :*: (S1 (MetaSel (Just "_ewTimeMin") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DateTime')) :*: S1 (MetaSel (Just "_ewOrderBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EventsWatchOrderBy)))) :*: ((S1 (MetaSel (Just "_ewSingleEvents") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_ewPrivateExtendedProperty") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 (MetaSel (Just "_ewShowDeleted") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 (MetaSel (Just "_ewPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Channel) :*: S1 (MetaSel (Just "_ewQ") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 (MetaSel (Just "_ewSharedExtendedProperty") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_ewMaxAttendees") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))) :*: (S1 (MetaSel (Just "_ewICalUId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_ewUpdatedMin") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DateTime')) :*: S1 (MetaSel (Just "_ewPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 (MetaSel (Just "_ewTimeZone") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ewShowHiddenInvitations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 (MetaSel (Just "_ewMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int32)) :*: (S1 (MetaSel (Just "_ewAlwaysIncludeEmail") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_ewTimeMax") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DateTime'))))))))
type Scopes EventsWatch Source # 
Instance details

Defined in Network.Google.Resource.Calendar.Events.Watch

type Scopes EventsWatch = "https://www.googleapis.com/auth/calendar" ': ("https://www.googleapis.com/auth/calendar.events" ': ("https://www.googleapis.com/auth/calendar.events.readonly" ': ("https://www.googleapis.com/auth/calendar.readonly" ': ([] :: [Symbol]))))
type Rs EventsWatch Source # 
Instance details

Defined in Network.Google.Resource.Calendar.Events.Watch

Request Lenses

ewSyncToken :: Lens' EventsWatch (Maybe Text) Source #

Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. These are: - iCalUID - orderBy - privateExtendedProperty - q - sharedExtendedProperty - timeMin - timeMax - updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.

ewCalendarId :: Lens' EventsWatch 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.

ewTimeMin :: Lens' EventsWatch (Maybe UTCTime) Source #

Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored. If timeMax is set, timeMin must be smaller than timeMax.

ewOrderBy :: Lens' EventsWatch (Maybe EventsWatchOrderBy) Source #

The order of the events returned in the result. Optional. The default is an unspecified, stable order.

ewSingleEvents :: Lens' EventsWatch (Maybe Bool) Source #

Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.

ewPrivateExtendedProperty :: Lens' EventsWatch [Text] Source #

Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.

ewShowDeleted :: Lens' EventsWatch (Maybe Bool) Source #

Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.

ewPayload :: Lens' EventsWatch Channel Source #

Multipart request metadata.

ewQ :: Lens' EventsWatch (Maybe Text) Source #

Free text search terms to find events that match these terms in any field, except for extended properties. Optional.

ewSharedExtendedProperty :: Lens' EventsWatch [Text] Source #

Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.

ewMaxAttendees :: Lens' EventsWatch (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.

ewICalUId :: Lens' EventsWatch (Maybe Text) Source #

Specifies event ID in the iCalendar format to be included in the response. Optional.

ewUpdatedMin :: Lens' EventsWatch (Maybe UTCTime) Source #

Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.

ewPageToken :: Lens' EventsWatch (Maybe Text) Source #

Token specifying which result page to return. Optional.

ewTimeZone :: Lens' EventsWatch (Maybe Text) Source #

Time zone used in the response. Optional. The default is the time zone of the calendar.

ewShowHiddenInvitations :: Lens' EventsWatch (Maybe Bool) Source #

Whether to include hidden invitations in the result. Optional. The default is False.

ewMaxResults :: Lens' EventsWatch Int32 Source #

Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.

ewAlwaysIncludeEmail :: Lens' EventsWatch (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.

ewTimeMax :: Lens' EventsWatch (Maybe UTCTime) Source #

Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, e.g., 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but will be ignored. If timeMin is set, timeMax must be greater than timeMin.