Struct google_people1::api::PersonConnectionListCall
source · pub struct PersonConnectionListCall<'a, S>where
S: 'a,{ /* private fields */ }
Expand description
Provides a list of the authenticated user’s contacts. Sync tokens expire 7 days after the full sync. A request with an expired sync token will get an error with an google.rpc.ErrorInfo with reason “EXPIRED_SYNC_TOKEN”. In the case of such an error clients should make a full sync request without a sync_token
. The first page of a full sync request has an additional quota. If the quota is exceeded, a 429 error will be returned. This quota is fixed and can not be increased. When the sync_token
is specified, resources deleted since the last sync will be returned as a person with PersonMetadata.deleted
set to true. When the page_token
or sync_token
is specified, all other request parameters must match the first call. Writes may have a propagation delay of several minutes for sync requests. Incremental syncs are not intended for read-after-write use cases. See example usage at List the user’s contacts that have changed.
A builder for the connections.list method supported by a person resource.
It is not used directly, but through a PersonMethods
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("ipsum")
.add_sources("ipsum")
.sort_order("est")
.request_sync_token(true)
.request_mask_include_field(&Default::default())
.person_fields(&Default::default())
.page_token("ea")
.page_size(-99)
.doit().await;
Implementations§
source§impl<'a, S> PersonConnectionListCall<'a, S>
impl<'a, S> PersonConnectionListCall<'a, S>
sourcepub async fn doit(self) -> Result<(Response<Body>, ListConnectionsResponse)>
pub async fn doit(self) -> Result<(Response<Body>, ListConnectionsResponse)>
Perform the operation you have build so far.
sourcepub fn resource_name(self, new_value: &str) -> PersonConnectionListCall<'a, S>
pub fn resource_name(self, new_value: &str) -> PersonConnectionListCall<'a, S>
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.
sourcepub fn sync_token(self, new_value: &str) -> PersonConnectionListCall<'a, S>
pub fn sync_token(self, new_value: &str) -> PersonConnectionListCall<'a, S>
Optional. A sync token, received from a previous response next_sync_token
Provide this to retrieve only the resources changed since the last request. When syncing, all other parameters provided to people.connections.list
must match the first call that provided the sync token. More details about sync behavior at people.connections.list
.
Sets the sync token query property to the given value.
sourcepub fn add_sources(self, new_value: &str) -> PersonConnectionListCall<'a, S>
pub fn add_sources(self, new_value: &str) -> PersonConnectionListCall<'a, S>
Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT and READ_SOURCE_TYPE_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.
sourcepub fn sort_order(self, new_value: &str) -> PersonConnectionListCall<'a, S>
pub fn sort_order(self, new_value: &str) -> PersonConnectionListCall<'a, S>
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.
sourcepub fn request_sync_token(
self,
new_value: bool
) -> PersonConnectionListCall<'a, S>
pub fn request_sync_token( self, new_value: bool ) -> PersonConnectionListCall<'a, S>
Optional. Whether the response should return next_sync_token
on the last page of results. It can be used to get incremental changes since the last request by setting it on the request sync_token
. More details about sync behavior at people.connections.list
.
Sets the request sync token query property to the given value.
sourcepub fn request_mask_include_field(
self,
new_value: FieldMask
) -> PersonConnectionListCall<'a, S>
pub fn request_mask_include_field( self, new_value: FieldMask ) -> PersonConnectionListCall<'a, S>
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.
sourcepub fn person_fields(
self,
new_value: FieldMask
) -> PersonConnectionListCall<'a, S>
pub fn person_fields( self, new_value: FieldMask ) -> PersonConnectionListCall<'a, S>
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 * calendarUrls * clientData * coverPhotos * emailAddresses * events * externalIds * genders * imClients * interests * locales * locations * memberships * metadata * miscKeywords * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * sipAddresses * skills * urls * userDefined
Sets the person fields query property to the given value.
sourcepub fn page_token(self, new_value: &str) -> PersonConnectionListCall<'a, S>
pub fn page_token(self, new_value: &str) -> PersonConnectionListCall<'a, S>
Optional. A page token, received from a previous response next_page_token
. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to people.connections.list
must match the first call that provided the page token.
Sets the page token query property to the given value.
sourcepub fn page_size(self, new_value: i32) -> PersonConnectionListCall<'a, S>
pub fn page_size(self, new_value: i32) -> PersonConnectionListCall<'a, S>
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.
sourcepub fn delegate(
self,
new_value: &'a mut dyn Delegate
) -> PersonConnectionListCall<'a, S>
pub fn delegate( self, new_value: &'a mut dyn Delegate ) -> PersonConnectionListCall<'a, S>
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.
sourcepub fn param<T>(self, name: T, value: T) -> PersonConnectionListCall<'a, S>
pub fn param<T>(self, name: T, value: T) -> PersonConnectionListCall<'a, S>
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
- $.xgafv (query-string) - V1 error format.
- access_token (query-string) - OAuth access token.
- alt (query-string) - Data format for response.
- callback (query-string) - JSONP
- fields (query-string) - Selector specifying which fields to include in a partial response.
- 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.
- oauth_token (query-string) - OAuth 2.0 token for the current user.
- prettyPrint (query-boolean) - Returns response with indentations and line breaks.
- 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.
- uploadType (query-string) - Legacy upload protocol for media (e.g. “media”, “multipart”).
- upload_protocol (query-string) - Upload protocol for media (e.g. “raw”, “multipart”).
sourcepub fn add_scope<St>(self, scope: St) -> PersonConnectionListCall<'a, S>
pub fn add_scope<St>(self, scope: St) -> PersonConnectionListCall<'a, S>
Identifies the authorization scope for the method you are building.
Use this method to actively specify which scope should be used, instead of 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.
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.
sourcepub fn add_scopes<I, St>(self, scopes: I) -> PersonConnectionListCall<'a, S>
pub fn add_scopes<I, St>(self, scopes: I) -> PersonConnectionListCall<'a, S>
Identifies the authorization scope(s) for the method you are building.
See Self::add_scope()
for details.
sourcepub fn clear_scopes(self) -> PersonConnectionListCall<'a, S>
pub fn clear_scopes(self) -> PersonConnectionListCall<'a, S>
Removes all scopes, and no default scope will be used either.
In this case, you have to specify your API-key using the key
parameter (see Self::param()
for details).