Struct google_drive3::CommentListCall

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

Lists a file’s comments.

A builder for the list method supported by a comment resource. It is not used directly, but through a CommentMethods 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.comments().list("fileId")
             .start_modified_time("Lorem")
             .page_token("et")
             .page_size(-13)
             .include_deleted(true)
             .doit();

Implementations

impl<'a, C, A> CommentListCall<'a, C, A>

where C: BorrowMut<Client>, A: GetToken,

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

Perform the operation you have build so far.

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

The ID of the file.

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 start_modified_time(self, new_value: &str) -> CommentListCall<'a, C, A>

The minimum value of ‘modifiedTime’ for the result comments (RFC 3339 date-time).

Sets the start modified time query property to the given value.

pub fn page_token(self, new_value: &str) -> CommentListCall<'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) -> CommentListCall<'a, C, A>

The maximum number of comments to return per page.

Sets the page size query property to the given value.

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

Whether to include deleted comments. Deleted comments will not include their original content.

Sets the include deleted query property to the given value.

pub fn delegate( self, new_value: &'a mut dyn Delegate, ) -> CommentListCall<'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) -> CommentListCall<'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>(self, scope: T) -> CommentListCall<'a, C, A>

where T: 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::Readonly.

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.

Trait Implementations

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