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 |
Lists or searches files.
See: Drive API Reference for drive.files.list
.
Synopsis
- type FilesListResource = "drive" :> ("v3" :> ("files" :> (QueryParam "corpora" Text :> (QueryParam "orderBy" Text :> (QueryParam "includeTeamDriveItems" Bool :> (QueryParam "q" Text :> (QueryParam "teamDriveId" Text :> (QueryParam "spaces" Text :> (QueryParam "includeItemsFromAllDrives" Bool :> (QueryParam "supportsAllDrives" Bool :> (QueryParam "corpus" FilesListCorpus :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "supportsTeamDrives" Bool :> (QueryParam "driveId" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] FileList))))))))))))))))
- filesList :: FilesList
- data FilesList
- flCorpora :: Lens' FilesList (Maybe Text)
- flOrderBy :: Lens' FilesList (Maybe Text)
- flIncludeTeamDriveItems :: Lens' FilesList Bool
- flQ :: Lens' FilesList (Maybe Text)
- flTeamDriveId :: Lens' FilesList (Maybe Text)
- flSpaces :: Lens' FilesList Text
- flIncludeItemsFromAllDrives :: Lens' FilesList Bool
- flSupportsAllDrives :: Lens' FilesList Bool
- flCorpus :: Lens' FilesList (Maybe FilesListCorpus)
- flPageToken :: Lens' FilesList (Maybe Text)
- flPageSize :: Lens' FilesList Int32
- flSupportsTeamDrives :: Lens' FilesList Bool
- flDriveId :: Lens' FilesList (Maybe Text)
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 "includeItemsFromAllDrives" Bool :> (QueryParam "supportsAllDrives" Bool :> (QueryParam "corpus" FilesListCorpus :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "supportsTeamDrives" Bool :> (QueryParam "driveId" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] FileList)))))))))))))))) Source #
A resource alias for drive.files.list
method which the
FilesList
request conforms to.
Creating a Request
filesList :: FilesList Source #
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:
Lists or searches files.
See: filesList
smart constructor.
Instances
Request Lenses
flCorpora :: Lens' FilesList (Maybe Text) Source #
Bodies of items (files/documents) to which the query applies. Supported bodies are 'user', 'domain', 'drive' and 'allDrives'. Prefer 'user' or 'drive' to 'allDrives' for efficiency.
flOrderBy :: Lens' FilesList (Maybe Text) Source #
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 Source #
Deprecated use includeItemsFromAllDrives instead.
flQ :: Lens' FilesList (Maybe Text) Source #
A query for filtering the file results. See the "Search for Files" guide for supported syntax.
flSpaces :: Lens' FilesList Text Source #
A comma-separated list of spaces to query within the corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.
flIncludeItemsFromAllDrives :: Lens' FilesList Bool Source #
Whether both My Drive and shared drive items should be included in results.
flSupportsAllDrives :: Lens' FilesList Bool Source #
Whether the requesting application supports both My Drives and shared drives.
flCorpus :: Lens' FilesList (Maybe FilesListCorpus) Source #
The source of files to list. Deprecated: use 'corpora' instead.
flPageToken :: Lens' FilesList (Maybe 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.