Struct google_photoslibrary1::SharedAlbumListCall

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

Lists all shared albums available in the Sharing tab of the user's Google Photos app.

A builder for the list method supported by a sharedAlbum resource. It is not used directly, but through a SharedAlbumMethods 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.shared_albums().list()
             .page_token("aliquyam")
             .page_size(-66)
             .exclude_non_app_created_data(false)
             .doit();

Methods

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

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

Perform the operation you have build so far.

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

A continuation token to get the next page of the results. Adding this to the request returns the rows after the pageToken. The pageToken should be the value returned in the nextPageToken parameter in the response to the listSharedAlbums request.

Sets the page token query property to the given value.

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

Maximum number of albums to return in the response. The default number of albums to return at a time is 20. The maximum pageSize is 50.

Sets the page size query property to the given value.

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

If set, the results exclude media items that were not created by this app. Defaults to false (all albums are returned). This field is ignored if the photoslibrary.readonly.appcreateddata scope is used.

Sets the exclude non app created data query property to the given value.

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

• upload_protocol (query-string) - Upload protocol for media (e.g. "raw", "multipart").
• prettyPrint (query-boolean) - Returns response with indentations and line breaks.
• access_token (query-string) - OAuth access token.
• fields (query-string) - Selector specifying which fields to include in a partial response.
• 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.
• callback (query-string) - JSONP
• 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.
• uploadType (query-string) - Legacy upload protocol for media (e.g. "media", "multipart").
• alt (query-string) - Data format for response.
• $.xgafv (query-string) - V1 error format.

pub fn add_scope<T, S>(self, scope: T) -> SharedAlbumListCall<'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::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. 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 SharedAlbumListCall<'a, C, A>