Class FilesResource.ListRequest
Lists the user's files.
Inheritance
Implements
Inherited Members
Namespace: Google.Apis.Drive.v2
Assembly: Google.Apis.Drive.v2.dll
Syntax
public class ListRequest : DriveBaseServiceRequest<FileList>, IClientServiceRequest<FileList>, IClientServiceRequest
Constructors
ListRequest(IClientService)
Constructs a new List request.
Declaration
public ListRequest(IClientService service)
Parameters
Type | Name | Description |
---|---|---|
Google.Apis.Services.IClientService | service |
Properties
Corpora
Groupings of files to which the query applies. Supported groupings are: 'user' (files created by, opened by, or shared directly with the user), 'drive' (files in the specified shared drive as indicated by the 'driveId'), 'domain' (files shared to the user's domain), and 'allDrives' (A combination of 'user' and 'drive' for all drives where the user is a member). When able, use 'user' or 'drive', instead of 'allDrives', for efficiency.
Declaration
[RequestParameter("corpora", RequestParameterType.Query)]
public virtual string Corpora { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Corpus
The body of items (files/documents) to which the query applies. Deprecated: use 'corpora' instead.
Declaration
[RequestParameter("corpus", RequestParameterType.Query)]
public virtual FilesResource.ListRequest.CorpusEnum? Corpus { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<FilesResource.ListRequest.CorpusEnum> |
DriveId
ID of the shared drive to search.
Declaration
[RequestParameter("driveId", RequestParameterType.Query)]
public virtual string DriveId { get; set; }
Property Value
Type | Description |
---|---|
System.String |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
System.String |
Overrides
IncludeItemsFromAllDrives
Whether both My Drive and shared drive items should be included in results.
Declaration
[RequestParameter("includeItemsFromAllDrives", RequestParameterType.Query)]
public virtual bool? IncludeItemsFromAllDrives { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Boolean> |
IncludePermissionsForView
Specifies which additional view's permissions to include in the response. Only 'published' is supported.
Declaration
[RequestParameter("includePermissionsForView", RequestParameterType.Query)]
public virtual string IncludePermissionsForView { get; set; }
Property Value
Type | Description |
---|---|
System.String |
IncludeTeamDriveItems
Deprecated use includeItemsFromAllDrives instead.
Declaration
[RequestParameter("includeTeamDriveItems", RequestParameterType.Query)]
public virtual bool? IncludeTeamDriveItems { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Boolean> |
MaxResults
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.
Declaration
[RequestParameter("maxResults", RequestParameterType.Query)]
public virtual int? MaxResults { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Int32> |
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
System.String |
Overrides
OrderBy
A comma-separated list of sort keys. Valid keys are 'createdDate', 'folder', 'lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', 'quotaBytesUsed', 'recency', 'sharedWithMeDate', 'starred', 'title', and 'title_natural'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.
Declaration
[RequestParameter("orderBy", RequestParameterType.Query)]
public virtual string OrderBy { get; set; }
Property Value
Type | Description |
---|---|
System.String |
PageToken
Page token for files.
Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Projection
This parameter is deprecated and has no function.
Declaration
[RequestParameter("projection", RequestParameterType.Query)]
public virtual FilesResource.ListRequest.ProjectionEnum? Projection { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<FilesResource.ListRequest.ProjectionEnum> |
Q
Query string for searching files.
Declaration
[RequestParameter("q", RequestParameterType.Query)]
public virtual string Q { get; set; }
Property Value
Type | Description |
---|---|
System.String |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
System.String |
Overrides
Spaces
A comma-separated list of spaces to query. Supported values are 'drive' and 'appDataFolder'.
Declaration
[RequestParameter("spaces", RequestParameterType.Query)]
public virtual string Spaces { get; set; }
Property Value
Type | Description |
---|---|
System.String |
SupportsAllDrives
Whether the requesting application supports both My Drives and shared drives.
Declaration
[RequestParameter("supportsAllDrives", RequestParameterType.Query)]
public virtual bool? SupportsAllDrives { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Boolean> |
SupportsTeamDrives
Deprecated use supportsAllDrives instead.
Declaration
[RequestParameter("supportsTeamDrives", RequestParameterType.Query)]
public virtual bool? SupportsTeamDrives { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Boolean> |
TeamDriveId
Deprecated use driveId instead.
Declaration
[RequestParameter("teamDriveId", RequestParameterType.Query)]
public virtual string TeamDriveId { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()