Crate google_people1 [−] [src]
This documentation was generated from people crate version 1.0.0+20160210, where 20160210 is the exact revision of the people:v1 schema built by the mako code generator v1.0.0.
Everything else about the people v1 API can be found at the official documentation site. The original source code is on github.
Features
Handle the following Resources with ease from the central hub ...
- people
Not what you are looking for ? Find all other Google APIs in their Rust documentation index.
Structure of this Library
The API is structured into the following primary items:
- Hub
- a central object to maintain state and allow accessing all Activities
- creates Method Builders which in turn allow access to individual Call Builders
- Resources
- primary types that you can apply Activities to
- a collection of properties and Parts
- Parts
- a collection of properties
- never directly used in Activities
- Activities
- operations to apply to Resources
All structures are marked with applicable traits to further categorize them and ease browsing.
Generally speaking, you can invoke Activities like this:
let r = hub.resource().activity(...).doit()
Or specifically ...
let r = hub.people().get(...).doit()
The resource()
and activity(...)
calls create builders. The second one dealing with Activities
supports various methods to configure the impending operation (not shown here). It is made such that all required arguments have to be
specified right away (i.e. (...)
), whereas all optional ones can be build up as desired.
The doit()
method performs the actual communication with the server and returns the respective result.
Usage
Setting up your Project
To use this library, you would put the following lines into your Cargo.toml
file:
[dependencies]
google-people1 = "*"
A complete example
extern crate hyper; extern crate yup_oauth2 as oauth2; extern crate google_people1 as people1; use people1::{Result, Error}; use std::default::Default; use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage}; use people1::People; // Get an ApplicationSecret instance by some means. It contains the `client_id` and // `client_secret`, among other things. let secret: ApplicationSecret = Default::default(); // Instantiate the authenticator. It will choose a suitable authentication flow for you, // unless you replace `None` with the desired Flow. // Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about // what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and // retrieve them from storage. let auth = Authenticator::new(&secret, DefaultAuthenticatorDelegate, hyper::Client::new(), <MemoryStorage as Default>::default(), None); let mut hub = People::new(hyper::Client::new(), auth); // 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().get("resourceName") .request_mask_include_field("dolores") .doit(); match result { Err(e) => match e { // The Error enum provides details about what exactly happened. // You can also just use its `Debug`, `Display` or `Error` traits Error::HttpError(_) |Error::MissingAPIKey |Error::MissingToken(_) |Error::Cancelled |Error::UploadSizeLimitExceeded(_, _) |Error::Failure(_) |Error::BadRequest(_) |Error::FieldClash(_) |Error::JsonDecodeError(_, _) => println!("{}", e), }, Ok(res) => println!("Success: {:?}", res), }
Handling Errors
All errors produced by the system are provided either as Result enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the Hub Delegate, or the Authenticator Delegate.
When delegates handle errors or intermediate values, they may have a chance to instruct the system to retry. This makes the system potentially resilient to all kinds of errors.
Uploads and Downloads
If a method supports downloads, the response body, which is part of the Result, should be
read by you to obtain the media.
If such a method also supports a Response Result, it will return that by default.
You can see it as meta-data for the actual media. To trigger a media download, you will have to set up the builder by making
this call: .param("alt", "media")
.
Methods supporting uploads can do so using up to 2 different protocols:
simple and resumable. The distinctiveness of each is represented by customized
doit(...)
methods, which are then named upload(...)
and upload_resumable(...)
respectively.
Customization and Callbacks
You may alter the way an doit()
method is called by providing a delegate to the
Method Builder before making the final doit()
call.
Respective methods will be called to provide progress information, as well as determine whether the system should
retry on failure.
The delegate trait is default-implemented, allowing you to customize it with minimal effort.
Optional Parts in Server-Requests
All structures provided by this library are made to be enocodable and decodable via json. Optionals are used to indicate that partial requests are responses are valid. Most optionals are are considered Parts which are identifiable by name, which will be sent to the server to indicate either the set parts of the request or the desired parts in the response.
Builder Arguments
Using method builders, you are able to prepare an action call by repeatedly calling it's methods. These will always take a single argument, for which the following statements are true.
- PODs are handed by copy
- strings are passed as
&str
- request values are moved
Arguments will always be copied or cloned into the builder, to make them independent of their original life times.
Structs
Address |
A person's physical address. May be a P.O. box or street address. All fields are optional. |
Biography |
A person's short biography. |
Birthday |
A person's birthday. At least one of the |
BraggingRights |
A person's bragging rights. |
ContactGroupMembership |
A Google contact group membership. |
CoverPhoto |
A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about. |
Date |
Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. |
DefaultDelegate |
A delegate with a conservative default implementation, which is used if no other delegate is set. |
DomainMembership |
A Google Apps Domain membership. |
EmailAddress |
A person's email address. |
ErrorResponse |
A utility to represent detailed errors we might see in case there are BadRequests. The latter happen if the sent parameters or request structures are unsound |
Event |
An event related to the person. |
FieldMetadata |
Metadata about a field. |
Gender |
A person's gender. |
GetPeopleResponse |
There is no detailed description. |
ImClient |
A person's instant messaging client. |
Interest |
One of the person's interests. |
ListConnectionsResponse |
There is no detailed description. |
Locale |
A person's locale preference. |
Membership |
A person's membership in a group. |
MethodInfo |
Contains information about an API request. |
MultiPartReader |
Provides a |
Name |
A person's name. If the name is a mononym, the family name is empty. |
Nickname |
A person's nickname. |
Occupation |
A person's occupation. |
Organization |
A person's past or current organization. Overlapping date ranges are permitted. |
People |
Central instance to access all People related resource activities |
PeopleConnectionListCall |
Provides a list of the authenticated user's contacts merged with any linked profiles. |
PeopleGetBatchGetCall |
Provides information about a list of specific people by specifying a list of requested resource names. Use |
PeopleGetCall |
Provides information about a person resource for a resource name. Use |
PeopleMethods |
A builder providing access to all methods supported on people resources.
It is not used directly, but through the |
Person |
Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Fields other than IDs, metadata, and group memberships are user-edited. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with |
PersonMetadata |
Metadata about a person. |
PersonResponse |
The response for a single person |
PhoneNumber |
A person's phone number. |
Photo |
A person's photo. A picture shown next to the person's name to help others recognize the person. |
Relation |
A person's relation to another person. |
RelationshipInterest |
The kind of relationship the person is looking for. |
RelationshipStatus |
A person's relationship status. |
Residence |
A person's past or current residence. |
Skill |
A skill that the person has. |
Source |
The source of a field. |
Tagline |
A brief one-line description of the person. |
Url |
A person's associated URLs. |
Enums
Error | |
Scope |
Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token. |
Traits
CallBuilder |
Identifies types which represent builders for a particular resource method |
Delegate |
A trait specifying functionality to help controlling any request performed by the API. The trait has a conservative default implementation. |
Hub |
Identifies the Hub. There is only one per library, this trait is supposed to make intended use more explicit. The hub allows to access all resource methods more easily. |
MethodsBuilder |
Identifies types for building methods of a particular resource type |
NestedType |
Identifies types which are only used by other types internally. They have no special meaning, this trait just marks them for completeness. |
Part |
Identifies types which are only used as part of other types, which
usually are carrying the |
ReadSeek |
A utility to specify reader types which provide seeking capabilities too |
RequestValue |
Identifies types which are used in API requests. |
Resource |
Identifies types which can be inserted and deleted. Types with this trait are most commonly used by clients of this API. |
ResponseResult |
Identifies types which are used in API responses. |
ToParts |
A trait for all types that can convert themselves into a parts string |
Functions
remove_json_null_values |
Type Definitions
Result |
A universal result type used as return for all calls. |