target.apidocs.com.google.api.services.people.v1.PeopleService.ContactGroups.html Maven / Gradle / Ivy

Go to download







PeopleService.ContactGroups (People API v1-rev20210330-1.31.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.people.v1
Class PeopleService.ContactGroups



java.lang.Object


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







Enclosing class:
PeopleService




public class PeopleService.ContactGroups
extends Object
The "contactGroups" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
PeopleService.ContactGroups.BatchGet 


class 
PeopleService.ContactGroups.Create 


class 
PeopleService.ContactGroups.Delete 


class 
PeopleService.ContactGroups.Get 


class 
PeopleService.ContactGroups.List 


class 
PeopleService.ContactGroups.Members
The "members" collection of methods.



class 
PeopleService.ContactGroups.Update 









Constructor Summary

Constructors 

Constructor and Description


ContactGroups() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


PeopleService.ContactGroups.BatchGet
batchGet()
Get a list of contact groups owned by the authenticated user by specifying a list of contact
 group resource names.



PeopleService.ContactGroups.Create
create(CreateContactGroupRequest content)
Create a new contact group owned by the authenticated user.



PeopleService.ContactGroups.Delete
delete(String resourceName)
Delete an existing contact group owned by the authenticated user by specifying a contact group
 resource name.



PeopleService.ContactGroups.Get
get(String resourceName)
Get a specific contact group owned by the authenticated user by specifying a contact group
 resource name.



PeopleService.ContactGroups.List
list()
List all contact groups owned by the authenticated user.



PeopleService.ContactGroups.Members
members()
An accessor for creating requests from the Members collection.



PeopleService.ContactGroups.Update
update(String resourceName,
      UpdateContactGroupRequest content)
Update the name of an existing contact group owned by the authenticated user.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





ContactGroups
public ContactGroups()









Method Detail





batchGet
public PeopleService.ContactGroups.BatchGet batchGet()
                                              throws IOException
Get a list of contact groups owned by the authenticated user by specifying a list of contact
 group resource names.

 Create a request for the method "contactGroups.batchGet".

 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








create
public PeopleService.ContactGroups.Create create(CreateContactGroupRequest content)
                                          throws IOException
Create a new contact group owned by the authenticated user.

 Create a request for the method "contactGroups.create".

 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 CreateContactGroupRequest
Returns:
the request
Throws:
IOException








delete
public PeopleService.ContactGroups.Delete delete(String resourceName)
                                          throws IOException
Delete an existing contact group owned by the authenticated user by specifying a contact group
 resource name.

 Create a request for the method "contactGroups.delete".

 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 group to delete.
Returns:
the request
Throws:
IOException








get
public PeopleService.ContactGroups.Get get(String resourceName)
                                    throws IOException
Get a specific contact group owned by the authenticated user by specifying a contact group
 resource name.

 Create a request for the method "contactGroups.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 contact group to get.
Returns:
the request
Throws:
IOException








list
public PeopleService.ContactGroups.List list()
                                      throws IOException
List all contact groups owned by the authenticated user. Members of the contact groups are not
 populated.

 Create a request for the method "contactGroups.list".

 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








update
public PeopleService.ContactGroups.Update update(String resourceName,
                                                 UpdateContactGroupRequest content)
                                          throws IOException
Update the name of an existing contact group owned by the authenticated user.

 Create a request for the method "contactGroups.update".

 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 contact group, assigned by the server. An ASCII string, in the form of
        `contactGroups/{contact_group_id}`.
content - the UpdateContactGroupRequest
Returns:
the request
Throws:
IOException








members
public PeopleService.ContactGroups.Members members()
An accessor for creating requests from the Members collection.

 The typical use is:
     PeopleService people = new PeopleService(...);
    PeopleService.Members.List request = people.members().list(parameters ...)
 

Returns:
the resource collection














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2021 Google. All rights reserved.

Modifier and Type	Class and Description
`class`	`PeopleService.ContactGroups.BatchGet`
`class`	`PeopleService.ContactGroups.Create`
`class`	`PeopleService.ContactGroups.Delete`
`class`	`PeopleService.ContactGroups.Get`
`class`	`PeopleService.ContactGroups.List`
`class`	`PeopleService.ContactGroups.Members` The "members" collection of methods.
`class`	`PeopleService.ContactGroups.Update`

Modifier and Type	Method and Description
`PeopleService.ContactGroups.BatchGet`	`batchGet()` Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names.
`PeopleService.ContactGroups.Create`	`create(CreateContactGroupRequest content)` Create a new contact group owned by the authenticated user.
`PeopleService.ContactGroups.Delete`	`delete(String resourceName)` Delete an existing contact group owned by the authenticated user by specifying a contact group resource name.
`PeopleService.ContactGroups.Get`	`get(String resourceName)` Get a specific contact group owned by the authenticated user by specifying a contact group resource name.
`PeopleService.ContactGroups.List`	`list()` List all contact groups owned by the authenticated user.
`PeopleService.ContactGroups.Members`	`members()` An accessor for creating requests from the Members collection.
`PeopleService.ContactGroups.Update`	`update(String resourceName, UpdateContactGroupRequest content)` Update the name of an existing contact group owned by the authenticated user.