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 Object

The "people" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PeopleService.People.BatchCreateContacts
class	PeopleService.People.BatchDeleteContacts
class	PeopleService.People.BatchUpdateContacts
class	PeopleService.People.Connections The "connections" collection of methods.
class	PeopleService.People.CreateContact
class	PeopleService.People.DeleteContact
class	PeopleService.People.DeleteContactPhoto
class	PeopleService.People.Get
class	PeopleService.People.GetBatchGet
class	PeopleService.People.ListDirectoryPeople
class	PeopleService.People.SearchContacts
class	PeopleService.People.SearchDirectoryPeople
class	PeopleService.People.UpdateContact
class	PeopleService.People.UpdateContactPhoto

Constructor Summary

Constructors

Constructor and Description
People()

Method Summary

Modifier and Type	Method and Description
PeopleService.People.BatchCreateContacts	batchCreateContacts(BatchCreateContactsRequest content) Create a batch of new contacts and return the PersonResponses for the newly Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.
PeopleService.People.BatchDeleteContacts	batchDeleteContacts(BatchDeleteContactsRequest content) Delete a batch of contacts.
PeopleService.People.BatchUpdateContacts	batchUpdateContacts(BatchUpdateContactsRequest content) Update a batch of contacts and return a map of resource names to PersonResponses for the updated contacts.
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(String resourceName) Delete a contact person.
PeopleService.People.DeleteContactPhoto	deleteContactPhoto(String resourceName) Delete a contact's photo.
PeopleService.People.Get	get(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.ListDirectoryPeople	listDirectoryPeople() Provides a list of domain profiles and domain contacts in the authenticated user's domain directory.
PeopleService.People.SearchContacts	searchContacts() Provides a list of contacts in the authenticated user's grouped contacts that matches the search query.
PeopleService.People.SearchDirectoryPeople	searchDirectoryPeople() Provides a list of domain profiles and domain contacts in the authenticated user's domain directory that match the search query.
PeopleService.People.UpdateContact	updateContact(String resourceName, Person content) Update contact data for an existing contact person.
PeopleService.People.UpdateContactPhoto	updateContactPhoto(String resourceName, UpdateContactPhotoRequest content) Update a contact's photo.

Methods inherited from class java.lang.Object

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

Constructor Detail

People

public People()

Method Detail

batchCreateContacts

public PeopleService.People.BatchCreateContacts batchCreateContacts(BatchCreateContactsRequest content)
                                                             throws IOException

Create a batch of new contacts and return the PersonResponses for the newly Mutate requests for the same user should be sent sequentially to avoid increased latency and failures. Create a request for the method "people.batchCreateContacts". 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 BatchCreateContactsRequest

Returns:

the request

Throws:

IOException

batchDeleteContacts

public PeopleService.People.BatchDeleteContacts batchDeleteContacts(BatchDeleteContactsRequest content)
                                                             throws IOException

Delete a batch of contacts. Any non-contact data will not be deleted. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures. Create a request for the method "people.batchDeleteContacts". 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 BatchDeleteContactsRequest

Returns:

the request

Throws:

IOException

batchUpdateContacts

public PeopleService.People.BatchUpdateContacts batchUpdateContacts(BatchUpdateContactsRequest content)
                                                             throws IOException

Update a batch of contacts and return a map of resource names to PersonResponses for the updated contacts. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures. Create a request for the method "people.batchUpdateContacts". 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 BatchUpdateContactsRequest

Returns:

the request

Throws:

IOException

createContact

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

Create a new contact and return the person resource for that contact. The request returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names Mutate requests for the same user should be sent sequentially to avoid increased latency and failures. 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:

IOException

deleteContact

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

Delete a contact person. Any non-contact data will not be deleted. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures. 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 - Required. The resource name of the contact to delete.

Returns:

the request

Throws:

IOException

deleteContactPhoto

public PeopleService.People.DeleteContactPhoto deleteContactPhoto(String resourceName)
                                                           throws IOException

Delete a contact's photo. Mutate requests for the same user should be done sequentially to avoid // lock contention. Create a request for the method "people.deleteContactPhoto". 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 - Required. The resource name of the contact whose photo will be deleted.

Returns:

the request

Throws:

IOException

get

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

Provides information about a person by specifying a resource name. Use `people/me` to indicate the authenticated user. The request returns 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 - Required. 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`.

Returns:

the request

Throws:

IOException

getBatchGet

public PeopleService.People.GetBatchGet getBatchGet()
                                             throws 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 returns 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:

IOException

listDirectoryPeople

public PeopleService.People.ListDirectoryPeople listDirectoryPeople()
                                                             throws IOException

Provides a list of domain profiles and domain contacts in the authenticated user's domain directory. 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 directory people that have changed](/people/v1/directory#list_the_directory_people_that_have_changed). Create a request for the method "people.listDirectoryPeople". 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:

IOException

searchContacts

public PeopleService.People.SearchContacts searchContacts()
                                                   throws IOException

Provides a list of contacts in the authenticated user's grouped contacts that matches the search query. The query matches on a contact's `names`, `nickNames`, `emailAddresses`, `phoneNumbers`, and `organizations` fields that are from the CONTACT source. **IMPORTANT**: Before searching, clients should send a warmup request with an empty query to update the cache. See https://developers.google.com/people/v1/contacts#search_the_users_contacts Create a request for the method "people.searchContacts". 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:

IOException

searchDirectoryPeople

public PeopleService.People.SearchDirectoryPeople searchDirectoryPeople()
                                                                 throws IOException

Provides a list of domain profiles and domain contacts in the authenticated user's domain directory that match the search query. Create a request for the method "people.searchDirectoryPeople". 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:

IOException

updateContact

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

Update contact data for an existing contact person. Any non-contact data will not be modified. Any non-contact data in the person to update will be ignored. All fields specified in the `update_mask` will be replaced. The server returns a 400 error if `person.metadata.sources` is not specified for the contact to be updated or if there is no contact source. The server returns a 400 error with reason `"failedPrecondition"` 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 merge their updates into the latest person. If making sequential updates to the same person, the etag from the `updateContact` response should be used to avoid failures. The server returns a 400 error if `memberships` are being updated and there are no contact group memberships specified on the person. The server returns a 400 error if more than one field is specified on a field that is a singleton for contact sources: * biographies * birthdays * genders * names Mutate requests for the same user should be sent sequentially to avoid increased latency and failures. 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 in the form of `people/{person_id}`.

content - the Person

Returns:

the request

Throws:

IOException

updateContactPhoto

public PeopleService.People.UpdateContactPhoto updateContactPhoto(String resourceName,
                                                                  UpdateContactPhotoRequest content)
                                                           throws IOException

Update a contact's photo. Mutate requests for the same user should be sent sequentially to avoid increased latency and failures. Create a request for the method "people.updateContactPhoto". 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 - Required. Person resource name

content - the UpdateContactPhotoRequest

Returns:

the request

Throws:

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