| 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.List
Description
Returns entries on the user's calendar list.
See: Calendar API Reference for calendar.calendarList.list.
- type CalendarListListResource = "calendar" :> ("v3" :> ("users" :> ("me" :> ("calendarList" :> (QueryParam "syncToken" Text :> (QueryParam "minAccessRole" CalendarListListMinAccessRole :> (QueryParam "showDeleted" Bool :> (QueryParam "showHidden" Bool :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` CalendarList)))))))))))
- calendarListList :: CalendarListList
- data CalendarListList
- cllSyncToken :: Lens' CalendarListList (Maybe Text)
- cllMinAccessRole :: Lens' CalendarListList (Maybe CalendarListListMinAccessRole)
- cllShowDeleted :: Lens' CalendarListList (Maybe Bool)
- cllShowHidden :: Lens' CalendarListList (Maybe Bool)
- cllPageToken :: Lens' CalendarListList (Maybe Text)
- cllMaxResults :: Lens' CalendarListList (Maybe Int32)
REST Resource
type CalendarListListResource = "calendar" :> ("v3" :> ("users" :> ("me" :> ("calendarList" :> (QueryParam "syncToken" Text :> (QueryParam "minAccessRole" CalendarListListMinAccessRole :> (QueryParam "showDeleted" Bool :> (QueryParam "showHidden" Bool :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` CalendarList))))))))))) Source
A resource alias for calendar.calendarList.list method which the
CalendarListList request conforms to.
Creating a Request
calendarListList :: CalendarListList Source
Creates a value of CalendarListList with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CalendarListList Source
Returns entries on the user's calendar list.
See: calendarListList smart constructor.
Request Lenses
cllSyncToken :: Lens' CalendarListList (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.
cllMinAccessRole :: Lens' CalendarListList (Maybe CalendarListListMinAccessRole) Source
The minimum access role for the user in the returned entries. Optional. The default is no restriction.
cllShowDeleted :: Lens' CalendarListList (Maybe Bool) Source
Whether to include deleted calendar list entries in the result. Optional. The default is False.
cllShowHidden :: Lens' CalendarListList (Maybe Bool) Source
Whether to show hidden entries. Optional. The default is False.
cllPageToken :: Lens' CalendarListList (Maybe Text) Source
Token specifying which result page to return. Optional.
cllMaxResults :: Lens' CalendarListList (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.