| |
| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <html><head><title>Python: class Resource</title> |
| </head><body bgcolor="#f0f0f8"> |
| <p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#ffc8d8"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> |
| |
| <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| <td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr> |
| <tr><td> </td> |
| <td width="100%">Methods defined here:<br> |
| <dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="Resource-addContacts"><strong>addContacts</strong></a> = method(self, **kwargs)</dt><dd><tt>Adds contact(s) to the group.<br> |
| <br> |
| Args:<br> |
| body: object, The request body. (required)<br> |
| The object takes the form of:<br> |
| <br> |
| {<br> |
| "contactIds": [<br> |
| "A String",<br> |
| ],<br> |
| }<br> |
| <br> |
| userId: string, The user whose group is being updated. (required)<br> |
| groupId: string, The id of the group being updated. (required)<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "kind": "contacts#group", # Type of the resource. This is always "contacts#group".<br> |
| "name": "A String", # Group name.<br> |
| "lastUpdateTime": "A String", # Last updated time of the group.<br> |
| "deleted": True or False, # If this group has been deleted (boolean field).<br> |
| "extendedProperties": [ # Extended properties of the group. Available only in full projection.<br> |
| {<br> |
| "name": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "memberCount": 42, # Member count.<br> |
| "systemGroup": True or False, # Indication wheather the group is a system group.<br> |
| "id": "A String", # Group identifier.<br> |
| "selfLink": "A String", # URL pointing to this group. Used to retrieve, update, or delete this group.<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Delete a group entry.<br> |
| <br> |
| Args:<br> |
| userId: string, The user whose groups are being deleted. (required)<br> |
| groupId: string, The id of the group being deleted. (required)</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-deleteExtendedProperty"><strong>deleteExtendedProperty</strong></a> = method(self, **kwargs)</dt><dd><tt>Delete value of provided group's extended property for the given key.<br> |
| <br> |
| Args:<br> |
| userId: string, The user whose group's extended property is being deleted. (required)<br> |
| key: string, Extended property key whose value is being deleted. (required)<br> |
| groupId: string, Group whose extended property is being deleted. (required)</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets group details.<br> |
| <br> |
| Args:<br> |
| projection: string, Additional information to return.<br> |
| Allowed values<br> |
| FULL - Returns the extended properties of a group.<br> |
| THIN - Returns properties of a group.<br> |
| userId: string, The user whose groups are being requested. (required)<br> |
| groupId: string, The id of the group being requested. (required)<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "kind": "contacts#group", # Type of the resource. This is always "contacts#group".<br> |
| "name": "A String", # Group name.<br> |
| "lastUpdateTime": "A String", # Last updated time of the group.<br> |
| "deleted": True or False, # If this group has been deleted (boolean field).<br> |
| "extendedProperties": [ # Extended properties of the group. Available only in full projection.<br> |
| {<br> |
| "name": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "memberCount": 42, # Member count.<br> |
| "systemGroup": True or False, # Indication wheather the group is a system group.<br> |
| "id": "A String", # Group identifier.<br> |
| "selfLink": "A String", # URL pointing to this group. Used to retrieve, update, or delete this group.<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-getExtendedProperty"><strong>getExtendedProperty</strong></a> = method(self, **kwargs)</dt><dd><tt>Get value of provided groups's extended property for the given key.<br> |
| <br> |
| Args:<br> |
| userId: string, The user whose group's extended property is being requested. (required)<br> |
| key: string, Extended property key whose value is being requested. (required)<br> |
| groupId: string, Group whose extended property is being requested. (required)<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "value": "A String",<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Insert a group entry.<br> |
| <br> |
| Args:<br> |
| body: object, The request body. (required)<br> |
| The object takes the form of:<br> |
| <br> |
| {<br> |
| "kind": "contacts#group", # Type of the resource. This is always "contacts#group".<br> |
| "name": "A String", # Group name.<br> |
| "lastUpdateTime": "A String", # Last updated time of the group.<br> |
| "deleted": True or False, # If this group has been deleted (boolean field).<br> |
| "extendedProperties": [ # Extended properties of the group. Available only in full projection.<br> |
| {<br> |
| "name": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "memberCount": 42, # Member count.<br> |
| "systemGroup": True or False, # Indication wheather the group is a system group.<br> |
| "id": "A String", # Group identifier.<br> |
| "selfLink": "A String", # URL pointing to this group. Used to retrieve, update, or delete this group.<br> |
| }<br> |
| <br> |
| userId: string, The user whose groups are being requested. (required)<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "kind": "contacts#group", # Type of the resource. This is always "contacts#group".<br> |
| "name": "A String", # Group name.<br> |
| "lastUpdateTime": "A String", # Last updated time of the group.<br> |
| "deleted": True or False, # If this group has been deleted (boolean field).<br> |
| "extendedProperties": [ # Extended properties of the group. Available only in full projection.<br> |
| {<br> |
| "name": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "memberCount": 42, # Member count.<br> |
| "systemGroup": True or False, # Indication wheather the group is a system group.<br> |
| "id": "A String", # Group identifier.<br> |
| "selfLink": "A String", # URL pointing to this group. Used to retrieve, update, or delete this group.<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Retrieves list of groups for the provided user.<br> |
| <br> |
| Args:<br> |
| orderBy: string, Sorting criterion<br> |
| Allowed values<br> |
| LAST_MODIFIED - Order by last modified group<br> |
| projection: string, Additional information to return.<br> |
| Allowed values<br> |
| FULL - Returns properties of a group including extended properties.<br> |
| THIN - Returns properties of a group.<br> |
| pageToken: string, A continuation token that allows pagination.<br> |
| updatedMin: integer, The lower bound on entry update dates (seconds from epcoh).<br> |
| 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.<br> |
| userId: string, The user whose groups are being listed. (required)<br> |
| maxResults: integer, Maximum number of group entries to return.<br> |
| showDeleted: boolean, Flag to include deleted groups<br> |
| sortOrder: string, Sorting order of the result<br> |
| Allowed values<br> |
| ascending - Use ascending sort order<br> |
| descending - Use decending sort order<br> |
| alt: string, Specifies an alternative representation type.<br> |
| Allowed values<br> |
| json - Use JSON format<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "nextPageToken": "A String",<br> |
| "items": [<br> |
| {<br> |
| "kind": "contacts#group", # Type of the resource. This is always "contacts#group".<br> |
| "name": "A String", # Group name.<br> |
| "lastUpdateTime": "A String", # Last updated time of the group.<br> |
| "deleted": True or False, # If this group has been deleted (boolean field).<br> |
| "extendedProperties": [ # Extended properties of the group. Available only in full projection.<br> |
| {<br> |
| "name": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "memberCount": 42, # Member count.<br> |
| "systemGroup": True or False, # Indication wheather the group is a system group.<br> |
| "id": "A String", # Group identifier.<br> |
| "selfLink": "A String", # URL pointing to this group. Used to retrieve, update, or delete this group.<br> |
| },<br> |
| ],<br> |
| "kind": "contacts#groupList", # Type of the resource. This is always "contacts#groupList".<br> |
| "prevPageToken": "A String",<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br> |
| <br> |
| Args:<br> |
| previous_request: The request for the previous page.<br> |
| previous_response: The response from the request for the previous page.<br> |
| <br> |
| Returns:<br> |
| A request object that you can call 'execute()' on to request the next<br> |
| page. Returns None if there are no more items in the collection.</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Update a group entry. This method supports patch semantics.<br> |
| <br> |
| Args:<br> |
| body: object, The request body. (required)<br> |
| The object takes the form of:<br> |
| <br> |
| {<br> |
| "kind": "contacts#group", # Type of the resource. This is always "contacts#group".<br> |
| "name": "A String", # Group name.<br> |
| "lastUpdateTime": "A String", # Last updated time of the group.<br> |
| "deleted": True or False, # If this group has been deleted (boolean field).<br> |
| "extendedProperties": [ # Extended properties of the group. Available only in full projection.<br> |
| {<br> |
| "name": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "memberCount": 42, # Member count.<br> |
| "systemGroup": True or False, # Indication wheather the group is a system group.<br> |
| "id": "A String", # Group identifier.<br> |
| "selfLink": "A String", # URL pointing to this group. Used to retrieve, update, or delete this group.<br> |
| }<br> |
| <br> |
| userId: string, The user whose groups are being updated. (required)<br> |
| groupId: string, The id of the group being updated. (required)<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "kind": "contacts#group", # Type of the resource. This is always "contacts#group".<br> |
| "name": "A String", # Group name.<br> |
| "lastUpdateTime": "A String", # Last updated time of the group.<br> |
| "deleted": True or False, # If this group has been deleted (boolean field).<br> |
| "extendedProperties": [ # Extended properties of the group. Available only in full projection.<br> |
| {<br> |
| "name": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "memberCount": 42, # Member count.<br> |
| "systemGroup": True or False, # Indication wheather the group is a system group.<br> |
| "id": "A String", # Group identifier.<br> |
| "selfLink": "A String", # URL pointing to this group. Used to retrieve, update, or delete this group.<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-removeContacts"><strong>removeContacts</strong></a> = method(self, **kwargs)</dt><dd><tt>Removes contact(s) from the group.<br> |
| <br> |
| Args:<br> |
| body: object, The request body. (required)<br> |
| The object takes the form of:<br> |
| <br> |
| {<br> |
| "contactIds": [<br> |
| "A String",<br> |
| ],<br> |
| }<br> |
| <br> |
| userId: string, The user whose group is being updated. (required)<br> |
| groupId: string, The id of the group being updated. (required)<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "kind": "contacts#group", # Type of the resource. This is always "contacts#group".<br> |
| "name": "A String", # Group name.<br> |
| "lastUpdateTime": "A String", # Last updated time of the group.<br> |
| "deleted": True or False, # If this group has been deleted (boolean field).<br> |
| "extendedProperties": [ # Extended properties of the group. Available only in full projection.<br> |
| {<br> |
| "name": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "memberCount": 42, # Member count.<br> |
| "systemGroup": True or False, # Indication wheather the group is a system group.<br> |
| "id": "A String", # Group identifier.<br> |
| "selfLink": "A String", # URL pointing to this group. Used to retrieve, update, or delete this group.<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-setExtendedProperty"><strong>setExtendedProperty</strong></a> = method(self, **kwargs)</dt><dd><tt>Set value of provided group's extended property for the given key.<br> |
| <br> |
| Args:<br> |
| body: object, The request body. (required)<br> |
| The object takes the form of:<br> |
| <br> |
| {<br> |
| "value": "A String",<br> |
| }<br> |
| <br> |
| userId: string, The user whose group's extended property is being requested. (required)<br> |
| key: string, Extended property key whose value is being requested. (required)<br> |
| groupId: string, Group whose extended property is being requested. (required)<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "value": "A String",<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Update a group entry.<br> |
| <br> |
| Args:<br> |
| body: object, The request body. (required)<br> |
| The object takes the form of:<br> |
| <br> |
| {<br> |
| "kind": "contacts#group", # Type of the resource. This is always "contacts#group".<br> |
| "name": "A String", # Group name.<br> |
| "lastUpdateTime": "A String", # Last updated time of the group.<br> |
| "deleted": True or False, # If this group has been deleted (boolean field).<br> |
| "extendedProperties": [ # Extended properties of the group. Available only in full projection.<br> |
| {<br> |
| "name": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "memberCount": 42, # Member count.<br> |
| "systemGroup": True or False, # Indication wheather the group is a system group.<br> |
| "id": "A String", # Group identifier.<br> |
| "selfLink": "A String", # URL pointing to this group. Used to retrieve, update, or delete this group.<br> |
| }<br> |
| <br> |
| userId: string, The user whose groups are being updated. (required)<br> |
| groupId: string, The id of the group being updated. (required)<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "kind": "contacts#group", # Type of the resource. This is always "contacts#group".<br> |
| "name": "A String", # Group name.<br> |
| "lastUpdateTime": "A String", # Last updated time of the group.<br> |
| "deleted": True or False, # If this group has been deleted (boolean field).<br> |
| "extendedProperties": [ # Extended properties of the group. Available only in full projection.<br> |
| {<br> |
| "name": "A String",<br> |
| "value": "A String",<br> |
| },<br> |
| ],<br> |
| "memberCount": 42, # Member count.<br> |
| "systemGroup": True or False, # Indication wheather the group is a system group.<br> |
| "id": "A String", # Group identifier.<br> |
| "selfLink": "A String", # URL pointing to this group. Used to retrieve, update, or delete this group.<br> |
| }</tt></dd></dl> |
| |
| <hr> |
| Data descriptors defined here:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| </dl> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| </td></tr></table> |
| </body></html> |