Struct google_plus1::api::PeopleSearchCall
source · [−]pub struct PeopleSearchCall<'a> { /* private fields */ }
Expand description
Shut down. See https://developers.google.com/+/api-shutdown for more details.
A builder for the search 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().search("query")
.page_token("no")
.max_results(86)
.language("kasd")
.doit().await;
Implementations
sourceimpl<'a> PeopleSearchCall<'a>
impl<'a> PeopleSearchCall<'a>
sourcepub async fn doit(self) -> Result<(Response<Body>, PeopleFeed)>
pub async fn doit(self) -> Result<(Response<Body>, PeopleFeed)>
Perform the operation you have build so far.
sourcepub fn query(self, new_value: &str) -> PeopleSearchCall<'a>
pub fn query(self, new_value: &str) -> PeopleSearchCall<'a>
Specify a query string for full text search of public text in all profiles.
Sets the query query 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 page_token(self, new_value: &str) -> PeopleSearchCall<'a>
pub fn page_token(self, new_value: &str) -> PeopleSearchCall<'a>
The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of “nextPageToken” from the previous response. This token can be of any length.
Sets the page token query property to the given value.
sourcepub fn max_results(self, new_value: u32) -> PeopleSearchCall<'a>
pub fn max_results(self, new_value: u32) -> PeopleSearchCall<'a>
The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.
Sets the max results query property to the given value.
sourcepub fn language(self, new_value: &str) -> PeopleSearchCall<'a>
pub fn language(self, new_value: &str) -> PeopleSearchCall<'a>
Specify the preferred language to search with. See search language codes for available values.
Sets the language query property to the given value.
sourcepub fn delegate(self, new_value: &'a mut dyn Delegate) -> PeopleSearchCall<'a>
pub fn delegate(self, new_value: &'a mut dyn Delegate) -> PeopleSearchCall<'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.
sourcepub fn param<T>(self, name: T, value: T) -> PeopleSearchCall<'a> where
T: AsRef<str>,
pub fn param<T>(self, name: T, value: T) -> PeopleSearchCall<'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
- alt (query-string) - Data format for the response.
- 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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- userIp (query-string) - Deprecated. Please use quotaUser instead.
sourcepub fn add_scope<T, S>(self, scope: T) -> PeopleSearchCall<'a> where
T: Into<Option<S>>,
S: AsRef<str>,
pub fn add_scope<T, S>(self, scope: T) -> PeopleSearchCall<'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::Login
.
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> CallBuilder for PeopleSearchCall<'a>
Auto Trait Implementations
impl<'a> !RefUnwindSafe for PeopleSearchCall<'a>
impl<'a> Send for PeopleSearchCall<'a>
impl<'a> !Sync for PeopleSearchCall<'a>
impl<'a> Unpin for PeopleSearchCall<'a>
impl<'a> !UnwindSafe for PeopleSearchCall<'a>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more