|
Methods defined here:
- __init__(self)
- addContacts = method(self, **kwargs)
- Adds contact(s) to the group.
Args:
body: object, The request body. (required)
The object takes the form of:
{
"contactIds": [
"A String",
],
}
userId: string, The user whose group is being updated. (required)
groupId: string, The id of the group being updated. (required)
Returns:
An object of the form
{
"kind": "contacts#group", # Type of the resource. This is always "contacts#group".
"name": "A String", # Group name.
"lastUpdateTime": "A String", # Last updated time of the group.
"deleted": True or False, # If this group has been deleted (boolean field).
"extendedProperties": [ # Extended properties of the group. Available only in full projection.
{
"name": "A String",
"value": "A String",
},
],
"memberCount": 42, # Member count.
"systemGroup": True or False, # Indication wheather the group is a system group.
"id": "A String", # Group identifier.
"selfLink": "A String", # URL pointing to this group. Used to retrieve, update, or delete this group.
}
- delete = method(self, **kwargs)
- Delete a group entry.
Args:
userId: string, The user whose groups are being deleted. (required)
groupId: string, The id of the group being deleted. (required)
- deleteExtendedProperty = method(self, **kwargs)
- Delete value of provided group's extended property for the given key.
Args:
userId: string, The user whose group's extended property is being deleted. (required)
key: string, Extended property key whose value is being deleted. (required)
groupId: string, Group whose extended property is being deleted. (required)
- get = method(self, **kwargs)
- Gets group details.
Args:
projection: string, Additional information to return.
Allowed values
FULL - Returns the extended properties of a group.
THIN - Returns properties of a group.
userId: string, The user whose groups are being requested. (required)
groupId: string, The id of the group being requested. (required)
Returns:
An object of the form
{
"kind": "contacts#group", # Type of the resource. This is always "contacts#group".
"name": "A String", # Group name.
"lastUpdateTime": "A String", # Last updated time of the group.
"deleted": True or False, # If this group has been deleted (boolean field).
"extendedProperties": [ # Extended properties of the group. Available only in full projection.
{
"name": "A String",
"value": "A String",
},
],
"memberCount": 42, # Member count.
"systemGroup": True or False, # Indication wheather the group is a system group.
"id": "A String", # Group identifier.
"selfLink": "A String", # URL pointing to this group. Used to retrieve, update, or delete this group.
}
- getExtendedProperty = method(self, **kwargs)
- Get value of provided groups's extended property for the given key.
Args:
userId: string, The user whose group's extended property is being requested. (required)
key: string, Extended property key whose value is being requested. (required)
groupId: string, Group whose extended property is being requested. (required)
Returns:
An object of the form
{
"value": "A String",
}
- insert = method(self, **kwargs)
- Insert a group entry.
Args:
body: object, The request body. (required)
The object takes the form of:
{
"kind": "contacts#group", # Type of the resource. This is always "contacts#group".
"name": "A String", # Group name.
"lastUpdateTime": "A String", # Last updated time of the group.
"deleted": True or False, # If this group has been deleted (boolean field).
"extendedProperties": [ # Extended properties of the group. Available only in full projection.
{
"name": "A String",
"value": "A String",
},
],
"memberCount": 42, # Member count.
"systemGroup": True or False, # Indication wheather the group is a system group.
"id": "A String", # Group identifier.
"selfLink": "A String", # URL pointing to this group. Used to retrieve, update, or delete this group.
}
userId: string, The user whose groups are being requested. (required)
Returns:
An object of the form
{
"kind": "contacts#group", # Type of the resource. This is always "contacts#group".
"name": "A String", # Group name.
"lastUpdateTime": "A String", # Last updated time of the group.
"deleted": True or False, # If this group has been deleted (boolean field).
"extendedProperties": [ # Extended properties of the group. Available only in full projection.
{
"name": "A String",
"value": "A String",
},
],
"memberCount": 42, # Member count.
"systemGroup": True or False, # Indication wheather the group is a system group.
"id": "A String", # Group identifier.
"selfLink": "A String", # URL pointing to this group. Used to retrieve, update, or delete this group.
}
- list = method(self, **kwargs)
- Retrieves list of groups for the provided user.
Args:
orderBy: string, Sorting criterion
Allowed values
LAST_MODIFIED - Order by last modified group
projection: string, Additional information to return.
Allowed values
FULL - Returns properties of a group including extended properties.
THIN - Returns properties of a group.
pageToken: string, A continuation token that allows pagination.
updatedMin: integer, The lower bound on entry update dates (seconds from epcoh).
requireAllDeleted: boolean, Only relevant if showdeleted and updated-min are also provided.It dictates the behavior of the server in case it detect that placeholders of some entries deleted since the point in time specified as updated-min may have been lost.
userId: string, The user whose groups are being listed. (required)
maxResults: integer, Maximum number of group entries to return.
showDeleted: boolean, Flag to include deleted groups
sortOrder: string, Sorting order of the result
Allowed values
ascending - Use ascending sort order
descending - Use decending sort order
alt: string, Specifies an alternative representation type.
Allowed values
json - Use JSON format
Returns:
An object of the form
{
"nextPageToken": "A String",
"items": [
{
"kind": "contacts#group", # Type of the resource. This is always "contacts#group".
"name": "A String", # Group name.
"lastUpdateTime": "A String", # Last updated time of the group.
"deleted": True or False, # If this group has been deleted (boolean field).
"extendedProperties": [ # Extended properties of the group. Available only in full projection.
{
"name": "A String",
"value": "A String",
},
],
"memberCount": 42, # Member count.
"systemGroup": True or False, # Indication wheather the group is a system group.
"id": "A String", # Group identifier.
"selfLink": "A String", # URL pointing to this group. Used to retrieve, update, or delete this group.
},
],
"kind": "contacts#groupList", # Type of the resource. This is always "contacts#groupList".
"prevPageToken": "A String",
}
- list_next = methodNext(self, previous_request, previous_response)
- Retrieves the next page of results.
Args:
previous_request: The request for the previous page.
previous_response: The response from the request for the previous page.
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
- patch = method(self, **kwargs)
- Update a group entry. This method supports patch semantics.
Args:
body: object, The request body. (required)
The object takes the form of:
{
"kind": "contacts#group", # Type of the resource. This is always "contacts#group".
"name": "A String", # Group name.
"lastUpdateTime": "A String", # Last updated time of the group.
"deleted": True or False, # If this group has been deleted (boolean field).
"extendedProperties": [ # Extended properties of the group. Available only in full projection.
{
"name": "A String",
"value": "A String",
},
],
"memberCount": 42, # Member count.
"systemGroup": True or False, # Indication wheather the group is a system group.
"id": "A String", # Group identifier.
"selfLink": "A String", # URL pointing to this group. Used to retrieve, update, or delete this group.
}
userId: string, The user whose groups are being updated. (required)
groupId: string, The id of the group being updated. (required)
Returns:
An object of the form
{
"kind": "contacts#group", # Type of the resource. This is always "contacts#group".
"name": "A String", # Group name.
"lastUpdateTime": "A String", # Last updated time of the group.
"deleted": True or False, # If this group has been deleted (boolean field).
"extendedProperties": [ # Extended properties of the group. Available only in full projection.
{
"name": "A String",
"value": "A String",
},
],
"memberCount": 42, # Member count.
"systemGroup": True or False, # Indication wheather the group is a system group.
"id": "A String", # Group identifier.
"selfLink": "A String", # URL pointing to this group. Used to retrieve, update, or delete this group.
}
- removeContacts = method(self, **kwargs)
- Removes contact(s) from the group.
Args:
body: object, The request body. (required)
The object takes the form of:
{
"contactIds": [
"A String",
],
}
userId: string, The user whose group is being updated. (required)
groupId: string, The id of the group being updated. (required)
Returns:
An object of the form
{
"kind": "contacts#group", # Type of the resource. This is always "contacts#group".
"name": "A String", # Group name.
"lastUpdateTime": "A String", # Last updated time of the group.
"deleted": True or False, # If this group has been deleted (boolean field).
"extendedProperties": [ # Extended properties of the group. Available only in full projection.
{
"name": "A String",
"value": "A String",
},
],
"memberCount": 42, # Member count.
"systemGroup": True or False, # Indication wheather the group is a system group.
"id": "A String", # Group identifier.
"selfLink": "A String", # URL pointing to this group. Used to retrieve, update, or delete this group.
}
- setExtendedProperty = method(self, **kwargs)
- Set value of provided group's extended property for the given key.
Args:
body: object, The request body. (required)
The object takes the form of:
{
"value": "A String",
}
userId: string, The user whose group's extended property is being requested. (required)
key: string, Extended property key whose value is being requested. (required)
groupId: string, Group whose extended property is being requested. (required)
Returns:
An object of the form
{
"value": "A String",
}
- update = method(self, **kwargs)
- Update a group entry.
Args:
body: object, The request body. (required)
The object takes the form of:
{
"kind": "contacts#group", # Type of the resource. This is always "contacts#group".
"name": "A String", # Group name.
"lastUpdateTime": "A String", # Last updated time of the group.
"deleted": True or False, # If this group has been deleted (boolean field).
"extendedProperties": [ # Extended properties of the group. Available only in full projection.
{
"name": "A String",
"value": "A String",
},
],
"memberCount": 42, # Member count.
"systemGroup": True or False, # Indication wheather the group is a system group.
"id": "A String", # Group identifier.
"selfLink": "A String", # URL pointing to this group. Used to retrieve, update, or delete this group.
}
userId: string, The user whose groups are being updated. (required)
groupId: string, The id of the group being updated. (required)
Returns:
An object of the form
{
"kind": "contacts#group", # Type of the resource. This is always "contacts#group".
"name": "A String", # Group name.
"lastUpdateTime": "A String", # Last updated time of the group.
"deleted": True or False, # If this group has been deleted (boolean field).
"extendedProperties": [ # Extended properties of the group. Available only in full projection.
{
"name": "A String",
"value": "A String",
},
],
"memberCount": 42, # Member count.
"systemGroup": True or False, # Indication wheather the group is a system group.
"id": "A String", # Group identifier.
"selfLink": "A String", # URL pointing to this group. Used to retrieve, update, or delete this group.
}
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
|