Struct google_drive3::FileListCall

pub struct FileListCall<'a, C, A> where
    C: 'a,
    A: 'a,  { /* fields omitted */ }

Lists or searches files.

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("Lorem")
             .supports_team_drives(true)
             .spaces("et")
             .q("duo")
             .page_token("et")
             .page_size(-40)
             .order_by("sanctus")
             .include_team_drive_items(true)
             .corpus("amet")
             .corpora("et")
             .doit();

Methods

impl<'a, C, A> FileListCall<'a, C, A> where     C: BorrowMut<Client>,     A: GetToken,

pub fn doit(self) -> Result<(Response, FileList)>

Perform the operation you have build so far.

pub fn team_drive_id(self, new_value: &str) -> FileListCall<'a, C, A>

ID of Team Drive to search.

Sets the team drive id query property to the given value.

pub fn supports_team_drives(self, new_value: bool) -> FileListCall<'a, C, A>

Whether the requesting application supports Team Drives.

Sets the supports team drives query property to the given value.

pub fn spaces(self, new_value: &str) -> FileListCall<'a, C, A>

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

Sets the spaces query property to the given value.

pub fn q(self, new_value: &str) -> FileListCall<'a, C, A>

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

Sets the q query property to the given value.

pub fn page_token(self, new_value: &str) -> FileListCall<'a, C, A>

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.

Sets the page token query property to the given value.

pub fn page_size(self, new_value: i32) -> FileListCall<'a, C, A>

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 page size query property to the given value.

pub fn order_by(self, new_value: &str) -> FileListCall<'a, C, A>

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.

Sets the order by query property to the given value.

pub fn include_team_drive_items(self, new_value: bool) -> FileListCall<'a, C, A>

Whether Team Drive items should be included in results.

Sets the include team drive items query property to the given value.

pub fn corpus(self, new_value: &str) -> FileListCall<'a, C, A>

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

Sets the corpus query property to the given value.

pub fn corpora(self, new_value: &str) -> FileListCall<'a, C, A>

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.

Sets the corpora query property to the given value.

pub fn delegate(self, new_value: &'a mut Delegate) -> FileListCall<'a, C, A>

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.

pub fn param<T>(self, name: T, value: T) -> FileListCall<'a, C, A> where     T: AsRef<str>,

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 paramters which have their own setter method. If done anyway, the request will fail.

Additional Parameters

• 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. Overrides userIp if both are provided.
• oauth_token (query-string) - OAuth 2.0 token for the current user.
• 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.
• prettyPrint (query-boolean) - Returns response with indentations and line breaks.
• userIp (query-string) - IP address of the site where the request originates. Use this if you want to enforce per-user limits.
• fields (query-string) - Selector specifying which fields to include in a partial response.
• alt (query-string) - Data format for the response.

pub fn add_scope<T, S>(self, scope: T) -> FileListCall<'a, C, A> where     T: Into<Option<S>>,     S: AsRef<str>,

Identifies the authorization scope for the method you are building.

Use this method to actively specify which scope should be used, instead the default Scope variant Scope::MetadataReadonly.

The scope will be added to a set of scopes. This is important as one can maintain access tokens for more than one scope. If None is specified, then all scopes will be removed and no default scope will be used either. In that case, you have to specify your API-key using the key parameter (see the param() function for details).

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.

Trait Implementations

impl<'a, C, A> CallBuilder for FileListCall<'a, C, A>