drive  v3
Public Types | Public Member Functions | Protected Member Functions | Properties | List of all members
Google.Apis.Drive.v3.FilesResource.ListRequest Class Reference

Lists or searches files. More...

Inheritance diagram for Google.Apis.Drive.v3.FilesResource.ListRequest:
Google.Apis.Drive.v3.DriveBaseServiceRequest< Google.Apis.Drive.v3.Data.FileList >

Public Types

enum  CorpusEnum { CorpusEnum.Domain, CorpusEnum.User }
 The source of files to list. Deprecated: use 'corpora' instead. More...
 

Public Member Functions

 ListRequest (Google.Apis.Services.IClientService service)
 Constructs a new List request. More...
 

Protected Member Functions

override void InitParameters ()
 Initializes List parameter list. More...
 
- Protected Member Functions inherited from Google.Apis.Drive.v3.DriveBaseServiceRequest< Google.Apis.Drive.v3.Data.FileList >
 DriveBaseServiceRequest (Google.Apis.Services.IClientService service)
 Constructs a new DriveBaseServiceRequest instance. More...
 
override void InitParameters ()
 Initializes Drive parameter list. More...
 

Properties

virtual string Corpora [get, set]
 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. More...
 
virtual System.Nullable< CorpusEnumCorpus [get, set]
 The source of files to list. Deprecated: use 'corpora' instead. More...
 
virtual string DriveId [get, set]
 ID of the shared drive to search. More...
 
virtual System.Nullable< bool > IncludeItemsFromAllDrives [get, set]
 Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results. More...
 
virtual System.Nullable< bool > IncludeTeamDriveItems [get, set]
 Deprecated use includeItemsFromAllDrives instead. More...
 
virtual string OrderBy [get, set]
 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. More...
 
virtual System.Nullable< int > PageSize [get, set]
 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. More...
 
virtual string PageToken [get, set]
 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. More...
 
virtual string Q [get, set]
 A query for filtering the file results. See the "Search for Files" guide for supported syntax. More...
 
virtual string Spaces [get, set]
 A comma-separated list of spaces to query within the corpus. Supported values are 'drive', 'appDataFolder' and 'photos'. More...
 
virtual System.Nullable< bool > SupportsAllDrives [get, set]
 Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. More...
 
virtual System.Nullable< bool > SupportsTeamDrives [get, set]
 Deprecated use supportsAllDrives instead. More...
 
virtual string TeamDriveId [get, set]
 Deprecated use driveId instead. More...
 
override string MethodName [get]
 summary>Gets the HTTP method. More...
 
override string HttpMethod [get]
 summary>Gets the REST path. More...
 
override string RestPath [get]
 
- Properties inherited from Google.Apis.Drive.v3.DriveBaseServiceRequest< Google.Apis.Drive.v3.Data.FileList >
virtual System.Nullable< AltEnum > Alt [get, set]
 Data format for the response. More...
 
virtual string Fields [get, set]
 Selector specifying which fields to include in a partial response. More...
 
virtual string Key [get, set]
 API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. More...
 
virtual string OauthToken [get, set]
 OAuth 2.0 token for the current user. More...
 
virtual System.Nullable< bool > PrettyPrint [get, set]
 Returns response with indentations and line breaks. More...
 
virtual string QuotaUser [get, set]
 An opaque string that represents a user for quota purposes. Must not exceed 40 characters. More...
 
virtual string UserIp [get, set]
 Deprecated. Please use quotaUser instead. More...
 

Detailed Description

Lists or searches files.

Member Enumeration Documentation

◆ CorpusEnum

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

Enumerator
Domain 

Files shared to the user's domain.

User 

Files owned by or shared to the user.

Constructor & Destructor Documentation

◆ ListRequest()

Google.Apis.Drive.v3.FilesResource.ListRequest.ListRequest ( Google.Apis.Services.IClientService  service)
inline

Constructs a new List request.

Member Function Documentation

◆ InitParameters()

override void Google.Apis.Drive.v3.FilesResource.ListRequest.InitParameters ( )
inlineprotected

Initializes List parameter list.

Property Documentation

◆ Corpora

virtual string Google.Apis.Drive.v3.FilesResource.ListRequest.Corpora
getset

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.

◆ Corpus

virtual System.Nullable<CorpusEnum> Google.Apis.Drive.v3.FilesResource.ListRequest.Corpus
getset

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

◆ DriveId

virtual string Google.Apis.Drive.v3.FilesResource.ListRequest.DriveId
getset

ID of the shared drive to search.

◆ HttpMethod

override string Google.Apis.Drive.v3.FilesResource.ListRequest.HttpMethod
get

summary>Gets the REST path.

◆ IncludeItemsFromAllDrives

virtual System.Nullable<bool> Google.Apis.Drive.v3.FilesResource.ListRequest.IncludeItemsFromAllDrives
getset

Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results.

[default: false]

◆ IncludeTeamDriveItems

virtual System.Nullable<bool> Google.Apis.Drive.v3.FilesResource.ListRequest.IncludeTeamDriveItems
getset

Deprecated use includeItemsFromAllDrives instead.

[default: false]

◆ MethodName

override string Google.Apis.Drive.v3.FilesResource.ListRequest.MethodName
get

summary>Gets the HTTP method.

◆ OrderBy

virtual string Google.Apis.Drive.v3.FilesResource.ListRequest.OrderBy
getset

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.

◆ PageSize

virtual System.Nullable<int> Google.Apis.Drive.v3.FilesResource.ListRequest.PageSize
getset

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.

[default: 100] [minimum: 1] [maximum: 1000]

◆ PageToken

virtual string Google.Apis.Drive.v3.FilesResource.ListRequest.PageToken
getset

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.

◆ Q

virtual string Google.Apis.Drive.v3.FilesResource.ListRequest.Q
getset

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

◆ Spaces

virtual string Google.Apis.Drive.v3.FilesResource.ListRequest.Spaces
getset

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

[default: drive]

◆ SupportsAllDrives

virtual System.Nullable<bool> Google.Apis.Drive.v3.FilesResource.ListRequest.SupportsAllDrives
getset

Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.

[default: false]

◆ SupportsTeamDrives

virtual System.Nullable<bool> Google.Apis.Drive.v3.FilesResource.ListRequest.SupportsTeamDrives
getset

Deprecated use supportsAllDrives instead.

[default: false]

◆ TeamDriveId

virtual string Google.Apis.Drive.v3.FilesResource.ListRequest.TeamDriveId
getset

Deprecated use driveId instead.

summary>Gets the method name.


The documentation for this class was generated from the following file: