Copyright	(c) 2015-2016 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.Drive.Changes.Watch

Contents

REST Resource
Creating a Request
Request Lenses

Description

Subscribes to changes for a user.

See: Drive API Reference for drive.changes.watch.

Synopsis

type ChangesWatchResource = "drive" :> ("v3" :> ("changes" :> ("watch" :> (QueryParam "pageToken" Text :> (QueryParam "includeTeamDriveItems" Bool :> (QueryParam "includeCorpusRemovals" Bool :> (QueryParam "teamDriveId" Text :> (QueryParam "restrictToMyDrive" Bool :> (QueryParam "spaces" Text :> (QueryParam "includeItemsFromAllDrives" Bool :> (QueryParam "supportsAllDrives" Bool :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "includeRemoved" Bool :> (QueryParam "supportsTeamDrives" Bool :> (QueryParam "driveId" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Channel :> Post '[JSON] Channel)))))))))))))))))
changesWatch :: Channel -> Text -> ChangesWatch
data ChangesWatch
cwIncludeTeamDriveItems :: Lens' ChangesWatch Bool
cwPayload :: Lens' ChangesWatch Channel
cwIncludeCorpusRemovals :: Lens' ChangesWatch Bool
cwTeamDriveId :: Lens' ChangesWatch (Maybe Text)
cwRestrictToMyDrive :: Lens' ChangesWatch Bool
cwSpaces :: Lens' ChangesWatch Text
cwIncludeItemsFromAllDrives :: Lens' ChangesWatch Bool
cwSupportsAllDrives :: Lens' ChangesWatch Bool
cwPageToken :: Lens' ChangesWatch Text
cwPageSize :: Lens' ChangesWatch Int32
cwIncludeRemoved :: Lens' ChangesWatch Bool
cwSupportsTeamDrives :: Lens' ChangesWatch Bool
cwDriveId :: Lens' ChangesWatch (Maybe Text)

REST Resource

type ChangesWatchResource = "drive" :> ("v3" :> ("changes" :> ("watch" :> (QueryParam "pageToken" Text :> (QueryParam "includeTeamDriveItems" Bool :> (QueryParam "includeCorpusRemovals" Bool :> (QueryParam "teamDriveId" Text :> (QueryParam "restrictToMyDrive" Bool :> (QueryParam "spaces" Text :> (QueryParam "includeItemsFromAllDrives" Bool :> (QueryParam "supportsAllDrives" Bool :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "includeRemoved" Bool :> (QueryParam "supportsTeamDrives" Bool :> (QueryParam "driveId" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Channel :> Post '[JSON] Channel))))))))))))))))) Source #

A resource alias for drive.changes.watch method which the ChangesWatch request conforms to.

Creating a Request

changesWatch Source #

Arguments

:: Channel	`cwPayload`
-> Text	`cwPageToken`
-> ChangesWatch

Creates a value of ChangesWatch with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data ChangesWatch Source #

Subscribes to changes for a user.

See: changesWatch smart constructor.

Instances

Eq ChangesWatch Source #
Instance details Defined in Network.Google.Resource.Drive.Changes.Watch Methods (==) :: ChangesWatch -> ChangesWatch -> Bool # (/=) :: ChangesWatch -> ChangesWatch -> Bool #
Data ChangesWatch Source #
Instance details Defined in Network.Google.Resource.Drive.Changes.Watch Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ChangesWatch -> c ChangesWatch # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ChangesWatch # toConstr :: ChangesWatch -> Constr # dataTypeOf :: ChangesWatch -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ChangesWatch) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ChangesWatch) # gmapT :: (forall b. Data b => b -> b) -> ChangesWatch -> ChangesWatch # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ChangesWatch -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ChangesWatch -> r # gmapQ :: (forall d. Data d => d -> u) -> ChangesWatch -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ChangesWatch -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ChangesWatch -> m ChangesWatch # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ChangesWatch -> m ChangesWatch # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ChangesWatch -> m ChangesWatch #
Show ChangesWatch Source #
Instance details Defined in Network.Google.Resource.Drive.Changes.Watch Methods showsPrec :: Int -> ChangesWatch -> ShowS # show :: ChangesWatch -> String # showList :: [ChangesWatch] -> ShowS #
Generic ChangesWatch Source #
Instance details Defined in Network.Google.Resource.Drive.Changes.Watch Associated Types type Rep ChangesWatch :: Type -> Type # Methods from :: ChangesWatch -> Rep ChangesWatch x # to :: Rep ChangesWatch x -> ChangesWatch #
GoogleRequest ChangesWatch Source #
Instance details Defined in Network.Google.Resource.Drive.Changes.Watch Associated Types type Rs ChangesWatch :: Type # type Scopes ChangesWatch :: [Symbol] # Methods requestClient :: ChangesWatch -> GClient (Rs ChangesWatch) #
type Rep ChangesWatch Source #
Instance details Defined in Network.Google.Resource.Drive.Changes.Watch type Rep ChangesWatch = D1 (MetaData "ChangesWatch" "Network.Google.Resource.Drive.Changes.Watch" "gogol-drive-0.5.0-6s3nRYEHDD4AYi9Kv61RlM" False) (C1 (MetaCons "ChangesWatch'" PrefixI True) (((S1 (MetaSel (Just "_cwIncludeTeamDriveItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool) :: (S1 (MetaSel (Just "_cwPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Channel) :: S1 (MetaSel (Just "_cwIncludeCorpusRemovals") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool))) :: (S1 (MetaSel (Just "_cwTeamDriveId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_cwRestrictToMyDrive") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool) :: S1 (MetaSel (Just "_cwSpaces") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))) :: ((S1 (MetaSel (Just "_cwIncludeItemsFromAllDrives") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool) :: (S1 (MetaSel (Just "_cwSupportsAllDrives") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool) :: S1 (MetaSel (Just "_cwPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :: ((S1 (MetaSel (Just "_cwPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int32)) :: S1 (MetaSel (Just "_cwIncludeRemoved") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) :: (S1 (MetaSel (Just "_cwSupportsTeamDrives") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool) :: S1 (MetaSel (Just "_cwDriveId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))
type Scopes ChangesWatch Source #
Instance details Defined in Network.Google.Resource.Drive.Changes.Watch type Scopes ChangesWatch = "https://www.googleapis.com/auth/drive" ': ("https://www.googleapis.com/auth/drive.appdata" ': ("https://www.googleapis.com/auth/drive.file" ': ("https://www.googleapis.com/auth/drive.metadata" ': ("https://www.googleapis.com/auth/drive.metadata.readonly" ': ("https://www.googleapis.com/auth/drive.photos.readonly" ': ("https://www.googleapis.com/auth/drive.readonly" ': ([] :: [Symbol])))))))
type Rs ChangesWatch Source #
Instance details Defined in Network.Google.Resource.Drive.Changes.Watch type Rs ChangesWatch = Channel

Request Lenses

cwIncludeTeamDriveItems :: Lens' ChangesWatch Bool Source #

Deprecated use includeItemsFromAllDrives instead.

cwPayload :: Lens' ChangesWatch Channel Source #

Multipart request metadata.

cwIncludeCorpusRemovals :: Lens' ChangesWatch Bool Source #

Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file.

cwTeamDriveId :: Lens' ChangesWatch (Maybe Text) Source #

Deprecated use driveId instead.

cwRestrictToMyDrive :: Lens' ChangesWatch Bool Source #

Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to files such as those in the Application Data folder or shared files which have not been added to My Drive.

cwSpaces :: Lens' ChangesWatch Text Source #

A comma-separated list of spaces to query within the user corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.

cwIncludeItemsFromAllDrives :: Lens' ChangesWatch Bool Source #

Whether both My Drive and shared drive items should be included in results.

cwSupportsAllDrives :: Lens' ChangesWatch Bool Source #

Whether the requesting application supports both My Drives and shared drives.

cwPageToken :: Lens' ChangesWatch Text Source #

The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method.

cwPageSize :: Lens' ChangesWatch Int32 Source #

The maximum number of changes to return per page.

cwIncludeRemoved :: Lens' ChangesWatch Bool Source #

Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.

cwSupportsTeamDrives :: Lens' ChangesWatch Bool Source #

Deprecated use supportsAllDrives instead.

cwDriveId :: Lens' ChangesWatch (Maybe Text) Source #

The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.