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.CalendarList.List

Contents

Description

Returns the calendars on the user's calendar list.

See: Calendar API Reference for calendar.calendarList.list.

Synopsis

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 the calendars on the user's calendar list.

See: calendarListList smart constructor.

Instances
Eq CalendarListList Source # 
Instance details

Defined in Network.Google.Resource.Calendar.CalendarList.List

Data CalendarListList Source # 
Instance details

Defined in Network.Google.Resource.Calendar.CalendarList.List

Methods

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

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

toConstr :: CalendarListList -> Constr #

dataTypeOf :: CalendarListList -> DataType #

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

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

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

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

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

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

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

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

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

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

Show CalendarListList Source # 
Instance details

Defined in Network.Google.Resource.Calendar.CalendarList.List

Generic CalendarListList Source # 
Instance details

Defined in Network.Google.Resource.Calendar.CalendarList.List

Associated Types

type Rep CalendarListList :: Type -> Type #

GoogleRequest CalendarListList Source # 
Instance details

Defined in Network.Google.Resource.Calendar.CalendarList.List

Associated Types

type Rs CalendarListList :: Type #

type Scopes CalendarListList :: [Symbol] #

type Rep CalendarListList Source # 
Instance details

Defined in Network.Google.Resource.Calendar.CalendarList.List

type Rep CalendarListList = D1 (MetaData "CalendarListList" "Network.Google.Resource.Calendar.CalendarList.List" "gogol-apps-calendar-0.4.0-JhVPsEbzg60HmmguA3hcFJ" False) (C1 (MetaCons "CalendarListList'" PrefixI True) ((S1 (MetaSel (Just "_cllSyncToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_cllMinAccessRole") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CalendarListListMinAccessRole)) :*: S1 (MetaSel (Just "_cllShowDeleted") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 (MetaSel (Just "_cllShowHidden") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 (MetaSel (Just "_cllPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cllMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))))))
type Scopes CalendarListList Source # 
Instance details

Defined in Network.Google.Resource.Calendar.CalendarList.List

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

Defined in Network.Google.Resource.Calendar.CalendarList.List

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.