Network.Google.Resource.Drive.Files.List

Lists or searches files.

See: Drive API Reference for drive.files.list.

REST Resource

type FilesListResource = "drive" :> ("v3" :> ("files" :> (QueryParam "corpora" Text :> (QueryParam "orderBy" Text :> (QueryParam "includeTeamDriveItems" Bool :> (QueryParam "q" Text :> (QueryParam "teamDriveId" Text :> (QueryParam "spaces" Text :> (QueryParam "corpus" FilesListCorpus :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "supportsTeamDrives" Bool :> (QueryParam "alt" AltJSON :> Get '[JSON] FileList)))))))))))))

A resource alias for drive.files.list method which the FilesList request conforms to.

Creating a Request

filesList :: FilesList

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

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

• flCorpora
• flOrderBy
• flIncludeTeamDriveItems
• flQ
• flTeamDriveId
• flSpaces
• flCorpus
• flPageToken
• flPageSize
• flSupportsTeamDrives

data FilesList

Lists or searches files.

See: filesList smart constructor.

Instances

Eq FilesList

Defined in Network.Google.Resource.Drive.Files.List

Methods

(==) :: FilesList -> FilesList -> Bool

(/=) :: FilesList -> FilesList -> Bool

Data FilesList

Defined in Network.Google.Resource.Drive.Files.List

Methods

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

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

toConstr :: FilesList -> Constr

dataTypeOf :: FilesList -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> FilesList -> FilesList

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

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

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

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

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

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

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

Show FilesList

Defined in Network.Google.Resource.Drive.Files.List

Methods

showsPrec :: Int -> FilesList -> ShowS

show :: FilesList -> String

showList :: [FilesList] -> ShowS

Generic FilesList

Defined in Network.Google.Resource.Drive.Files.List

Associated Types

type Rep FilesList :: Type -> Type

Methods

from :: FilesList -> Rep FilesList x

to :: Rep FilesList x -> FilesList

GoogleRequest FilesList

Defined in Network.Google.Resource.Drive.Files.List

Associated Types

type Rs FilesList :: Type

type Scopes FilesList :: [Symbol]

Methods

requestClient :: FilesList -> GClient (Rs FilesList)

type Rep FilesList

Defined in Network.Google.Resource.Drive.Files.List

type Rep FilesList = D1 (MetaData "FilesList" "Network.Google.Resource.Drive.Files.List" "gogol-drive-0.4.0-C4qjNjFgJei6ubblDJk14k" False) (C1 (MetaCons "FilesList'" PrefixI True) (((S1 (MetaSel (Just "_flCorpora") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_flOrderBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_flIncludeTeamDriveItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool) :*: (S1 (MetaSel (Just "_flQ") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_flTeamDriveId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 (MetaSel (Just "_flSpaces") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_flCorpus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe FilesListCorpus))) :*: (S1 (MetaSel (Just "_flPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_flPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int32)) :*: S1 (MetaSel (Just "_flSupportsTeamDrives") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool))))))

type Scopes FilesList

Defined in Network.Google.Resource.Drive.Files.List

type Scopes FilesList = "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 FilesList

Defined in Network.Google.Resource.Drive.Files.List

type Rs FilesList = FileList

Request Lenses

flCorpora :: Lens' FilesList (Maybe Text)

Comma-separated list of bodies of items (files/documents) to which the query applies. Supported bodies are 'user', 'domain', 'teamDrive' and 'allTeamDrives'. 'allTeamDrives' must be combined with 'user'; all other values must be used in isolation. Prefer 'user' or 'teamDrive' to 'allTeamDrives' for efficiency.

flOrderBy :: Lens' FilesList (Maybe Text)

A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedTime desc,name. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.

flIncludeTeamDriveItems :: Lens' FilesList Bool

Whether Team Drive items should be included in results.

flQ :: Lens' FilesList (Maybe Text)

A query for filtering the file results. See the "Search for Files" guide for supported syntax.

flTeamDriveId :: Lens' FilesList (Maybe Text)

ID of Team Drive to search.

flSpaces :: Lens' FilesList Text

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

flCorpus :: Lens' FilesList (Maybe FilesListCorpus)

The source of files to list. Deprecated: use 'corpora' instead.

flPageToken :: Lens' FilesList (Maybe Text)

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.

flPageSize :: Lens' FilesList Int32

The maximum number of files to return per page. Partial or empty result pages are possible even before the end of the files list has been reached.

flSupportsTeamDrives :: Lens' FilesList Bool

Whether the requesting application supports Team Drives.