com.google.api.services.people.v1

Class PeopleService.People

java.lang.Object

com.google.api.services.people.v1.PeopleService.People

Enclosing class:

PeopleService

public class PeopleService.People
extends java.lang.Object

The "people" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PeopleService.People.Connections The "connections" collection of methods.
class	PeopleService.People.CreateContact
class	PeopleService.People.DeleteContact
class	PeopleService.People.Get
class	PeopleService.People.GetBatchGet
class	PeopleService.People.UpdateContact

Constructor Summary

Constructors

Constructor and Description
PeopleService.People()

Method Summary

Methods

Modifier and Type	Method and Description
PeopleService.People.Connections	connections() An accessor for creating requests from the Connections collection.
PeopleService.People.CreateContact	createContact(Person content) Create a new contact and return the person resource for that contact.
PeopleService.People.DeleteContact	deleteContact(java.lang.String resourceName) Delete a contact person.
PeopleService.People.Get	get(java.lang.String resourceName) Provides information about a person by specifying a resource name.
PeopleService.People.GetBatchGet	getBatchGet() Provides information about a list of specific people by specifying a list of requested resource names.
PeopleService.People.UpdateContact	updateContact(java.lang.String resourceName, Person content) Update contact data for an existing contact person.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PeopleService.People

public PeopleService.People()

Method Detail

createContact

public PeopleService.People.CreateContact createContact(Person content)
                                                 throws java.io.IOException

Create a new contact and return the person resource for that contact. Create a request for the method "people.createContact". This request holds the parameters needed by the people server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

content - the Person

Returns:

the request

Throws:

java.io.IOException

deleteContact

public PeopleService.People.DeleteContact deleteContact(java.lang.String resourceName)
                                                 throws java.io.IOException

Delete a contact person. Any non-contact data will not be deleted. Create a request for the method "people.deleteContact". This request holds the parameters needed by the people server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

resourceName - The resource name of the contact to delete.

Returns:

the request

Throws:

java.io.IOException

get

public PeopleService.People.Get get(java.lang.String resourceName)
                             throws java.io.IOException

Provides information about a person by specifying a resource name. Use `people/me` to indicate the authenticated user. The request throws a 400 error if 'personFields' is not specified. Create a request for the method "people.get". This request holds the parameters needed by the people server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

resourceName - The resource name of the person to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/`account_id. - To get information about a contact, specify the resource name that identifies the contact as returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list).

Returns:

the request

Throws:

java.io.IOException

getBatchGet

public PeopleService.People.GetBatchGet getBatchGet()
                                             throws java.io.IOException

Provides information about a list of specific people by specifying a list of requested resource names. Use `people/me` to indicate the authenticated user. The request throws a 400 error if 'personFields' is not specified. Create a request for the method "people.getBatchGet". This request holds the parameters needed by the people server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Returns:

the request

Throws:

java.io.IOException

updateContact

public PeopleService.People.UpdateContact updateContact(java.lang.String resourceName,
                                               Person content)
                                                 throws java.io.IOException

Update contact data for an existing contact person. Any non-contact data will not be modified. The request throws a 400 error if `updatePersonFields` is not specified. The request throws a 400 error if `person.metadata.sources` is not specified for the contact to be updated. The request throws a 412 error if `person.metadata.sources.etag` is different than the contact's etag, which indicates the contact has changed since its data was read. Clients should get the latest person and re-apply their updates to the latest person. Create a request for the method "people.updateContact". This request holds the parameters needed by the people server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

resourceName - The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of `people/`person_id.

content - the Person

Returns:

the request

Throws:

java.io.IOException

connections

public PeopleService.People.Connections connections()

An accessor for creating requests from the Connections collection.

The typical use is:

   PeopleService people = new PeopleService(...);
   PeopleService.Connections.List request = people.connections().list(parameters ...)
 

Returns:

the resource collection