Class Google_Service_PeopleService_ContactGroups_Resource
The "contactGroups" collection of methods. Typical usage is:
$peopleService = new Google_Service_PeopleService(...);
$contactGroups = $peopleService->contactGroups;
-
Google_Service_Resource
-
Google_Service_PeopleService_ContactGroups_Resource
Located at PeopleService.php
Methods summary
public
Google_Service_PeopleService_BatchGetContactGroupsResponse
|
#
batchGet( array $optParams = array() )
Get a list of contact groups owned by the authenticated user by specifying a
list of contact group resource names. (contactGroups.batchGet)
Get a list of contact groups owned by the authenticated user by specifying a
list of contact group resource names. (contactGroups.batchGet)
Parameters
- $optParams
- Optional parameters.
Returns
Opt_param
int maxMembers Optional. Specifies the maximum number of members to return for
each group. Defaults to 0 if not set, which will return zero members.
string resourceNames Required. The resource names of the contact groups to get.
|
public
Google_Service_PeopleService_ContactGroup
|
#
create( Google_Service_PeopleService_CreateContactGroupRequest $postBody, array $optParams = array() )
Create a new contact group owned by the authenticated user.
(contactGroups.create)
Create a new contact group owned by the authenticated user.
(contactGroups.create)
Parameters
- $postBody
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_PeopleService_PeopleEmpty
|
#
delete( string $resourceName, array $optParams = array() )
Delete an existing contact group owned by the authenticated user by
specifying a contact group resource name. (contactGroups.delete)
Delete an existing contact group owned by the authenticated user by
specifying a contact group resource name. (contactGroups.delete)
Parameters
- $resourceName
- Required. The resource name of the contact group to delete.
- $optParams
- Optional parameters.
Returns
Opt_param
bool deleteContacts Optional. Set to true to also delete the contacts in the
specified group.
|
public
Google_Service_PeopleService_ContactGroup
|
#
get( string $resourceName, array $optParams = array() )
Get a specific contact group owned by the authenticated user by specifying a
contact group resource name. (contactGroups.get)
Get a specific contact group owned by the authenticated user by specifying a
contact group resource name. (contactGroups.get)
Parameters
- $resourceName
- Required. The resource name of the contact group to get.
- $optParams
- Optional parameters.
Returns
Opt_param
int maxMembers Optional. Specifies the maximum number of members to return.
Defaults to 0 if not set, which will return zero members.
|
public
Google_Service_PeopleService_ListContactGroupsResponse
|
#
listContactGroups( array $optParams = array() )
List all contact groups owned by the authenticated user. Members of the
contact groups are not populated. (contactGroups.listContactGroups)
List all contact groups owned by the authenticated user. Members of the
contact groups are not populated. (contactGroups.listContactGroups)
Parameters
- $optParams
- Optional parameters.
Returns
Opt_param
string syncToken Optional. A sync token, returned by a previous call to
contactgroups.list. Only resources changed since the sync token was
created will be returned.
string pageToken Optional. The next_page_token value returned from a previous
call to ListContactGroups.
Requests the next page of resources.
int pageSize Optional. The maximum number of resources to return. Valid values
are between 1 and 1000, inclusive. Defaults to 30 if not set or set to 0.
|
public
Google_Service_PeopleService_ContactGroup
|
#
update( string $resourceName, Google_Service_PeopleService_UpdateContactGroupRequest $postBody, array $optParams = array() )
Update the name of an existing contact group owned by the authenticated user.
(contactGroups.update)
Update the name of an existing contact group owned by the authenticated user.
(contactGroups.update)
Parameters
- $resourceName
- The resource name for the contact group, assigned by the server. An ASCII
string, in the form of <code>contactGroups/{contact_group_id}</code>.
- $postBody
- $optParams
- Optional parameters.
Returns
|