Documentation

Google_Service_PeopleService_Resource_ContactGroups extends Google_Service_Resource
in package

Application

The "contactGroups" collection of methods.

Typical usage is: $peopleService = new Google_Service_PeopleService(...); $contactGroups = $peopleService->contactGroups;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
batchGet() : Google_Service_PeopleService_BatchGetContactGroupsResponse: Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names. (contactGroups.batchGet)
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
create() : Google_Service_PeopleService_ContactGroup: Create a new contact group owned by the authenticated user.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_PeopleService_PeopleEmpty: Delete an existing contact group owned by the authenticated user by specifying a contact group resource name. (contactGroups.delete)
get() : Google_Service_PeopleService_ContactGroup: Get a specific contact group owned by the authenticated user by specifying a contact group resource name. (contactGroups.get)
listContactGroups() : Google_Service_PeopleService_ListContactGroupsResponse: List all contact groups owned by the authenticated user. Members of the contact groups are not populated. (contactGroups.listContactGroups)
update() : Google_Service_PeopleService_ContactGroup: Update the name of an existing contact group owned by the authenticated user.
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

batchGet()

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


    public
                batchGet([array<string|int, mixed> $optParams = array() ]) : Google_Service_PeopleService_BatchGetContactGroupsResponse

Parameters

$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_PeopleService_BatchGetContactGroupsResponse —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

create()

Create a new contact group owned by the authenticated user.


    public
                create(Google_Service_PeopleService_CreateContactGroupRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_PeopleService_ContactGroup

(contactGroups.create)

Parameters

$postBody : Google_Service_PeopleService_CreateContactGroupRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_PeopleService_ContactGroup —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

delete()

Delete an existing contact group owned by the authenticated user by specifying a contact group resource name. (contactGroups.delete)


    public
                delete(string $resourceName[, array<string|int, mixed> $optParams = array() ]) : Google_Service_PeopleService_PeopleEmpty

Parameters

$resourceName : string: Required. The resource name of the contact group to delete.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_PeopleService_PeopleEmpty —

get()

Get a specific contact group owned by the authenticated user by specifying a contact group resource name. (contactGroups.get)


    public
                get(string $resourceName[, array<string|int, mixed> $optParams = array() ]) : Google_Service_PeopleService_ContactGroup

Parameters

$resourceName : string: Required. The resource name of the contact group to get.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_PeopleService_ContactGroup —

listContactGroups()

List all contact groups owned by the authenticated user. Members of the contact groups are not populated. (contactGroups.listContactGroups)


    public
                listContactGroups([array<string|int, mixed> $optParams = array() ]) : Google_Service_PeopleService_ListContactGroupsResponse

Parameters

$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_PeopleService_ListContactGroupsResponse —

update()

Update the name of an existing contact group owned by the authenticated user.


    public
                update(string $resourceName, Google_Service_PeopleService_UpdateContactGroupRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_PeopleService_ContactGroup

(contactGroups.update)

Parameters

$resourceName : string: The resource name for the contact group, assigned by the server. An ASCII string, in the form of contactGroups/{contact_group_id}.
$postBody : Google_Service_PeopleService_UpdateContactGroupRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_PeopleService_ContactGroup —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —