Struct google_people1::PeopleConnectionListCall

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

Provides a list of the authenticated user's contacts.

The request throws a 400 error if 'personFields' is not specified.

A builder for the connections.list method supported by a people resource. It is not used directly, but through a PeopleMethods 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.people().connections_list("resourceName")
             .sync_token("eos")
             .add_sources("erat")
             .sort_order("sadipscing")
             .request_sync_token(true)
             .request_mask_include_field("eirmod")
             .person_fields("elitr")
             .page_token("amet")
             .page_size(-60)
             .doit();

Implementations

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

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

Perform the operation you have build so far.

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

Required. The resource name to return connections for. Only people/me is valid.

Sets the resource name 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 sync_token(self, new_value: &str) -> PeopleConnectionListCall<'a, C, A>

Optional. A sync token, received from a previous ListConnections call. Provide this to retrieve only the resources changed since the last request. Sync requests that specify sync_token have an additional rate limit.

When syncing, all other parameters provided to ListConnections must match the call that provided the sync token.

Sets the sync token query property to the given value.

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

Optional. A mask of what source types to return. Defaults to ReadSourceType.CONTACT and ReadSourceType.PROFILE if not set.

Append the given value to the sources query property. Each appended value will retain its original ordering and be '/'-separated in the URL's parameters.

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

Optional. The order in which the connections should be sorted. Defaults to LAST_MODIFIED_ASCENDING.

Sets the sort order query property to the given value.

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

Optional. Whether the response should include next_sync_token, which can be used to get all changes since the last request. For subsequent sync requests use the sync_token param instead. Initial sync requests that specify request_sync_token have an additional rate limit.

Sets the request sync token query property to the given value.

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

Required. Comma-separated list of person fields to be included in the response. Each path should start with person.: for example, person.names or person.photos.

Sets the request mask.include field query property to the given value.

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

Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are:

• addresses
• ageRanges
• biographies
• birthdays
• coverPhotos
• emailAddresses
• events
• genders
• imClients
• interests
• locales
• memberships
• metadata
• names
• nicknames
• occupations
• organizations
• phoneNumbers
• photos
• relations
• residences
• sipAddresses
• skills
• urls
• userDefined

Sets the person fields query property to the given value.

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

Optional. A page token, received from a previous ListConnections call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListConnections must match the call that provided the page token.

Sets the page token query property to the given value.

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

Optional. The number of connections to include in the response. Valid values are between 1 and 1000, inclusive. Defaults to 100 if not set or set to 0.

Sets the page size query property to the given value.

pub fn delegate(
    self,
    new_value: &'a mut dyn Delegate
) -> PeopleConnectionListCall<'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) -> PeopleConnectionListCall<'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 parameters 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) -> PeopleConnectionListCall<'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::ContactReadonly.

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