Struct google_drive2::FileWatchCall

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

Subscribe to changes on a file

This method supports media download. To enable it, adjust the builder like this: .param("alt", "media"). Please note that due to missing multi-part support on the server side, you will only receive the media, but not the Channel structure that you would usually get. The latter will be a default value.

A builder for the watch method supported by a file resource. It is not used directly, but through a FileMethods instance.

Example

Instantiate a resource method builder

use drive2::Channel;
 
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = Channel::default();
 
// 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().watch(req, "fileId")
             .update_viewed_date(false)
             .supports_team_drives(false)
             .revision_id("sea")
             .projection("et")
             .acknowledge_abuse(false)
             .doit();

Methods

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

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

Perform the operation you have build so far.

pub fn request(self, new_value: Channel) -> FileWatchCall<'a, C, A>

Sets the request property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

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

The ID for the file in question.

Sets the file id path property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

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

Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.

Sets the update viewed date query property to the given value.

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

Whether the requesting application supports Team Drives.

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

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

Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.

Sets the revision id query property to the given value.

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

This parameter is deprecated and has no function.

Sets the projection query property to the given value.

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

Whether the user is acknowledging the risk of downloading known malware or other abusive files.

Sets the acknowledge abuse query property to the given value.

pub fn delegate(self, new_value: &'a mut Delegate) -> FileWatchCall<'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) -> FileWatchCall<'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) -> FileWatchCall<'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::Full.

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 FileWatchCall<'a, C, A>