Struct google_drive2::api::FileListCall
source · pub struct FileListCall<'a, S>where
S: 'a,{ /* private fields */ }Expand description
Lists the user’s files. This method accepts the q parameter, which is a search query combining one or more search terms. For more information, see the Search for files & folders guide. Note: This method returns all files by default, including trashed files. If you don’t want trashed files to appear in the list, use the trashed=false query parameter to remove trashed files from the results.
A builder for the list method supported by a file resource.
It is not used directly, but through a FileMethods instance.
§Example
Instantiate a resource method builder
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.files().list()
.team_drive_id("dolores")
.supports_team_drives(true)
.supports_all_drives(true)
.spaces("dolor")
.q("aliquyam")
.projection("magna")
.page_token("diam")
.order_by("nonumy")
.max_results(-18)
.include_team_drive_items(true)
.include_permissions_for_view("sed")
.include_labels("est")
.include_items_from_all_drives(false)
.drive_id("diam")
.corpus("At")
.corpora("erat")
.doit().await;Implementations§
source§impl<'a, S> FileListCall<'a, S>
impl<'a, S> FileListCall<'a, S>
sourcepub async fn doit(self) -> Result<(Response<Body>, FileList)>
pub async fn doit(self) -> Result<(Response<Body>, FileList)>
Perform the operation you have build so far.
sourcepub fn team_drive_id(self, new_value: &str) -> FileListCall<'a, S>
pub fn team_drive_id(self, new_value: &str) -> FileListCall<'a, S>
Deprecated: Use driveId instead.
Sets the team drive id query property to the given value.
sourcepub fn supports_team_drives(self, new_value: bool) -> FileListCall<'a, S>
pub fn supports_team_drives(self, new_value: bool) -> FileListCall<'a, S>
Deprecated: Use supportsAllDrives instead.
Sets the supports team drives query property to the given value.
sourcepub fn supports_all_drives(self, new_value: bool) -> FileListCall<'a, S>
pub fn supports_all_drives(self, new_value: bool) -> FileListCall<'a, S>
Whether the requesting application supports both My Drives and shared drives.
Sets the supports all drives query property to the given value.
sourcepub fn spaces(self, new_value: &str) -> FileListCall<'a, S>
pub fn spaces(self, new_value: &str) -> FileListCall<'a, S>
A comma-separated list of spaces to query. Supported values are drive, and appDataFolder.
Sets the spaces query property to the given value.
sourcepub fn q(self, new_value: &str) -> FileListCall<'a, S>
pub fn q(self, new_value: &str) -> FileListCall<'a, S>
Query string for searching files.
Sets the q query property to the given value.
sourcepub fn projection(self, new_value: &str) -> FileListCall<'a, S>
pub fn projection(self, new_value: &str) -> FileListCall<'a, S>
Deprecated: This parameter has no function.
Sets the projection query property to the given value.
sourcepub fn page_token(self, new_value: &str) -> FileListCall<'a, S>
pub fn page_token(self, new_value: &str) -> FileListCall<'a, S>
Page token for files.
Sets the page token query property to the given value.
sourcepub fn order_by(self, new_value: &str) -> FileListCall<'a, S>
pub fn order_by(self, new_value: &str) -> FileListCall<'a, S>
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.
Sets the order by query property to the given value.
sourcepub fn max_results(self, new_value: i32) -> FileListCall<'a, S>
pub fn max_results(self, new_value: i32) -> FileListCall<'a, S>
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.
Sets the max results query property to the given value.
sourcepub fn include_team_drive_items(self, new_value: bool) -> FileListCall<'a, S>
pub fn include_team_drive_items(self, new_value: bool) -> FileListCall<'a, S>
Deprecated: Use includeItemsFromAllDrives instead.
Sets the include team drive items query property to the given value.
sourcepub fn include_permissions_for_view(
self,
new_value: &str
) -> FileListCall<'a, S>
pub fn include_permissions_for_view( self, new_value: &str ) -> FileListCall<'a, S>
Specifies which additional view’s permissions to include in the response. Only published is supported.
Sets the include permissions for view query property to the given value.
sourcepub fn include_labels(self, new_value: &str) -> FileListCall<'a, S>
pub fn include_labels(self, new_value: &str) -> FileListCall<'a, S>
A comma-separated list of IDs of labels to include in the labelInfo part of the response.
Sets the include labels query property to the given value.
sourcepub fn include_items_from_all_drives(
self,
new_value: bool
) -> FileListCall<'a, S>
pub fn include_items_from_all_drives( self, new_value: bool ) -> FileListCall<'a, S>
Whether both My Drive and shared drive items should be included in results.
Sets the include items from all drives query property to the given value.
sourcepub fn drive_id(self, new_value: &str) -> FileListCall<'a, S>
pub fn drive_id(self, new_value: &str) -> FileListCall<'a, S>
ID of the shared drive to search.
Sets the drive id query property to the given value.
sourcepub fn corpus(self, new_value: &str) -> FileListCall<'a, S>
pub fn corpus(self, new_value: &str) -> FileListCall<'a, S>
Deprecated: The body of items (files/documents) to which the query applies. Use corpora instead.
Sets the corpus query property to the given value.
sourcepub fn corpora(self, new_value: &str) -> FileListCall<'a, S>
pub fn corpora(self, new_value: &str) -> FileListCall<'a, S>
Bodies of items (files/documents) to which the query applies. Supported bodies are default, domain, drive and allDrives. Prefer default or drive to allDrives for efficiency.
Sets the corpora query property to the given value.
sourcepub fn delegate(self, new_value: &'a mut dyn Delegate) -> FileListCall<'a, S>
pub fn delegate(self, new_value: &'a mut dyn Delegate) -> FileListCall<'a, S>
The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.
It should be used to handle progress information, and to implement a certain level of resilience.
Sets the delegate property to the given value.
sourcepub fn param<T>(self, name: T, value: T) -> FileListCall<'a, S>
pub fn param<T>(self, name: T, value: T) -> FileListCall<'a, S>
Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.
Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.
§Additional Parameters
- $.xgafv (query-string) - V1 error format.
- access_token (query-string) - OAuth access token.
- alt (query-string) - Data format for response.
- callback (query-string) - JSONP
- fields (query-string) - Selector specifying which fields to include in a partial response.
- key (query-string) - 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.
- oauth_token (query-string) - OAuth 2.0 token for the current user.
- prettyPrint (query-boolean) - Returns response with indentations and line breaks.
- quotaUser (query-string) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadType (query-string) - Legacy upload protocol for media (e.g. “media”, “multipart”).
- upload_protocol (query-string) - Upload protocol for media (e.g. “raw”, “multipart”).
sourcepub fn add_scope<St>(self, scope: St) -> FileListCall<'a, S>
pub fn add_scope<St>(self, scope: St) -> FileListCall<'a, S>
Identifies the authorization scope for the method you are building.
Use this method to actively specify which scope should be used, instead of the default Scope variant
Scope::AppReadonly.
The scope will be added to a set of scopes. This is important as one can maintain access
tokens for more than one scope.
Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.
sourcepub fn add_scopes<I, St>(self, scopes: I) -> FileListCall<'a, S>
pub fn add_scopes<I, St>(self, scopes: I) -> FileListCall<'a, S>
Identifies the authorization scope(s) for the method you are building.
See Self::add_scope() for details.
sourcepub fn clear_scopes(self) -> FileListCall<'a, S>
pub fn clear_scopes(self) -> FileListCall<'a, S>
Removes all scopes, and no default scope will be used either.
In this case, you have to specify your API-key using the key parameter (see Self::param()
for details).