| 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.CalendarList.Watch
Description
Watch for changes to CalendarList resources.
See: Calendar API Reference for calendar.calendarList.watch.
- type CalendarListWatchResource = "calendar" :> ("v3" :> ("users" :> ("me" :> ("calendarList" :> ("watch" :> (QueryParam "syncToken" Text :> (QueryParam "minAccessRole" CalendarListWatchMinAccessRole :> (QueryParam "showDeleted" Bool :> (QueryParam "showHidden" Bool :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> (ReqBody `[JSON]` Channel :> Post `[JSON]` Channel)))))))))))))
- calendarListWatch :: Channel -> CalendarListWatch
- data CalendarListWatch
- clwSyncToken :: Lens' CalendarListWatch (Maybe Text)
- clwMinAccessRole :: Lens' CalendarListWatch (Maybe CalendarListWatchMinAccessRole)
- clwShowDeleted :: Lens' CalendarListWatch (Maybe Bool)
- clwPayload :: Lens' CalendarListWatch Channel
- clwShowHidden :: Lens' CalendarListWatch (Maybe Bool)
- clwPageToken :: Lens' CalendarListWatch (Maybe Text)
- clwMaxResults :: Lens' CalendarListWatch (Maybe Int32)
REST Resource
type CalendarListWatchResource = "calendar" :> ("v3" :> ("users" :> ("me" :> ("calendarList" :> ("watch" :> (QueryParam "syncToken" Text :> (QueryParam "minAccessRole" CalendarListWatchMinAccessRole :> (QueryParam "showDeleted" Bool :> (QueryParam "showHidden" Bool :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> (ReqBody `[JSON]` Channel :> Post `[JSON]` Channel))))))))))))) Source
A resource alias for calendar.calendarList.watch method which the
CalendarListWatch request conforms to.
Creating a Request
Arguments
| :: Channel | |
| -> CalendarListWatch |
Creates a value of CalendarListWatch with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CalendarListWatch Source
Watch for changes to CalendarList resources.
See: calendarListWatch smart constructor.
Request Lenses
clwSyncToken :: Lens' CalendarListWatch (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. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. 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.
clwMinAccessRole :: Lens' CalendarListWatch (Maybe CalendarListWatchMinAccessRole) Source
The minimum access role for the user in the returned entries. Optional. The default is no restriction.
clwShowDeleted :: Lens' CalendarListWatch (Maybe Bool) Source
Whether to include deleted calendar list entries in the result. Optional. The default is False.
clwPayload :: Lens' CalendarListWatch Channel Source
Multipart request metadata.
clwShowHidden :: Lens' CalendarListWatch (Maybe Bool) Source
Whether to show hidden entries. Optional. The default is False.
clwPageToken :: Lens' CalendarListWatch (Maybe Text) Source
Token specifying which result page to return. Optional.
clwMaxResults :: Lens' CalendarListWatch (Maybe Int32) Source
Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.