Joe Gregorio | 2401bd6 | 2011-12-15 09:18:49 -0500 | [diff] [blame^] | 1 | |
| 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| 3 | <html><head><title>Python: class Resource</title> |
| 4 | </head><body bgcolor="#f0f0f8"> |
| 5 | <p> |
| 6 | <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| 7 | <tr bgcolor="#ffc8d8"> |
| 8 | <td colspan=3 valign=bottom> <br> |
| 9 | <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> |
| 10 | |
| 11 | <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| 12 | <td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr> |
| 13 | <tr><td> </td> |
| 14 | <td width="100%">Methods defined here:<br> |
| 15 | <dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl> |
| 16 | |
| 17 | <dl><dt><a name="Resource-addContacts"><strong>addContacts</strong></a> = method(self, **kwargs)</dt><dd><tt>Adds contact(s) to the group.<br> |
| 18 | <br> |
| 19 | Args:<br> |
| 20 | body: object, The request body. (required)<br> |
| 21 | The object takes the form of:<br> |
| 22 | <br> |
| 23 | {<br> |
| 24 | "contactIds": [<br> |
| 25 | "A String",<br> |
| 26 | ],<br> |
| 27 | }<br> |
| 28 | <br> |
| 29 | userId: string, The user whose group is being updated. (required)<br> |
| 30 | groupId: string, The id of the group being updated. (required)<br> |
| 31 | <br> |
| 32 | Returns:<br> |
| 33 | An object of the form<br> |
| 34 | <br> |
| 35 | {<br> |
| 36 | "kind": "contacts#group", # Type of the resource. This is always "contacts#group".<br> |
| 37 | "name": "A String", # Group name.<br> |
| 38 | "lastUpdateTime": "A String", # Last updated time of the group.<br> |
| 39 | "deleted": True or False, # If this group has been deleted (boolean field).<br> |
| 40 | "extendedProperties": [ # Extended properties of the group. Available only in full projection.<br> |
| 41 | {<br> |
| 42 | "name": "A String",<br> |
| 43 | "value": "A String",<br> |
| 44 | },<br> |
| 45 | ],<br> |
| 46 | "memberCount": 42, # Member count.<br> |
| 47 | "systemGroup": True or False, # Indication wheather the group is a system group.<br> |
| 48 | "id": "A String", # Group identifier.<br> |
| 49 | "selfLink": "A String", # URL pointing to this group. Used to retrieve, update, or delete this group.<br> |
| 50 | }</tt></dd></dl> |
| 51 | |
| 52 | <dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Delete a group entry.<br> |
| 53 | <br> |
| 54 | Args:<br> |
| 55 | userId: string, The user whose groups are being deleted. (required)<br> |
| 56 | groupId: string, The id of the group being deleted. (required)</tt></dd></dl> |
| 57 | |
| 58 | <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> |
| 59 | <br> |
| 60 | Args:<br> |
| 61 | userId: string, The user whose group's extended property is being deleted. (required)<br> |
| 62 | key: string, Extended property key whose value is being deleted. (required)<br> |
| 63 | groupId: string, Group whose extended property is being deleted. (required)</tt></dd></dl> |
| 64 | |
| 65 | <dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets group details.<br> |
| 66 | <br> |
| 67 | Args:<br> |
| 68 | projection: string, Additional information to return.<br> |
| 69 | Allowed values<br> |
| 70 | FULL - Returns the extended properties of a group.<br> |
| 71 | THIN - Returns properties of a group.<br> |
| 72 | userId: string, The user whose groups are being requested. (required)<br> |
| 73 | groupId: string, The id of the group being requested. (required)<br> |
| 74 | <br> |
| 75 | Returns:<br> |
| 76 | An object of the form<br> |
| 77 | <br> |
| 78 | {<br> |
| 79 | "kind": "contacts#group", # Type of the resource. This is always "contacts#group".<br> |
| 80 | "name": "A String", # Group name.<br> |
| 81 | "lastUpdateTime": "A String", # Last updated time of the group.<br> |
| 82 | "deleted": True or False, # If this group has been deleted (boolean field).<br> |
| 83 | "extendedProperties": [ # Extended properties of the group. Available only in full projection.<br> |
| 84 | {<br> |
| 85 | "name": "A String",<br> |
| 86 | "value": "A String",<br> |
| 87 | },<br> |
| 88 | ],<br> |
| 89 | "memberCount": 42, # Member count.<br> |
| 90 | "systemGroup": True or False, # Indication wheather the group is a system group.<br> |
| 91 | "id": "A String", # Group identifier.<br> |
| 92 | "selfLink": "A String", # URL pointing to this group. Used to retrieve, update, or delete this group.<br> |
| 93 | }</tt></dd></dl> |
| 94 | |
| 95 | <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> |
| 96 | <br> |
| 97 | Args:<br> |
| 98 | userId: string, The user whose group's extended property is being requested. (required)<br> |
| 99 | key: string, Extended property key whose value is being requested. (required)<br> |
| 100 | groupId: string, Group whose extended property is being requested. (required)<br> |
| 101 | <br> |
| 102 | Returns:<br> |
| 103 | An object of the form<br> |
| 104 | <br> |
| 105 | {<br> |
| 106 | "value": "A String",<br> |
| 107 | }</tt></dd></dl> |
| 108 | |
| 109 | <dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Insert a group entry.<br> |
| 110 | <br> |
| 111 | Args:<br> |
| 112 | body: object, The request body. (required)<br> |
| 113 | The object takes the form of:<br> |
| 114 | <br> |
| 115 | {<br> |
| 116 | "kind": "contacts#group", # Type of the resource. This is always "contacts#group".<br> |
| 117 | "name": "A String", # Group name.<br> |
| 118 | "lastUpdateTime": "A String", # Last updated time of the group.<br> |
| 119 | "deleted": True or False, # If this group has been deleted (boolean field).<br> |
| 120 | "extendedProperties": [ # Extended properties of the group. Available only in full projection.<br> |
| 121 | {<br> |
| 122 | "name": "A String",<br> |
| 123 | "value": "A String",<br> |
| 124 | },<br> |
| 125 | ],<br> |
| 126 | "memberCount": 42, # Member count.<br> |
| 127 | "systemGroup": True or False, # Indication wheather the group is a system group.<br> |
| 128 | "id": "A String", # Group identifier.<br> |
| 129 | "selfLink": "A String", # URL pointing to this group. Used to retrieve, update, or delete this group.<br> |
| 130 | }<br> |
| 131 | <br> |
| 132 | userId: string, The user whose groups are being requested. (required)<br> |
| 133 | <br> |
| 134 | Returns:<br> |
| 135 | An object of the form<br> |
| 136 | <br> |
| 137 | {<br> |
| 138 | "kind": "contacts#group", # Type of the resource. This is always "contacts#group".<br> |
| 139 | "name": "A String", # Group name.<br> |
| 140 | "lastUpdateTime": "A String", # Last updated time of the group.<br> |
| 141 | "deleted": True or False, # If this group has been deleted (boolean field).<br> |
| 142 | "extendedProperties": [ # Extended properties of the group. Available only in full projection.<br> |
| 143 | {<br> |
| 144 | "name": "A String",<br> |
| 145 | "value": "A String",<br> |
| 146 | },<br> |
| 147 | ],<br> |
| 148 | "memberCount": 42, # Member count.<br> |
| 149 | "systemGroup": True or False, # Indication wheather the group is a system group.<br> |
| 150 | "id": "A String", # Group identifier.<br> |
| 151 | "selfLink": "A String", # URL pointing to this group. Used to retrieve, update, or delete this group.<br> |
| 152 | }</tt></dd></dl> |
| 153 | |
| 154 | <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> |
| 155 | <br> |
| 156 | Args:<br> |
| 157 | orderBy: string, Sorting criterion<br> |
| 158 | Allowed values<br> |
| 159 | LAST_MODIFIED - Order by last modified group<br> |
| 160 | projection: string, Additional information to return.<br> |
| 161 | Allowed values<br> |
| 162 | FULL - Returns properties of a group including extended properties.<br> |
| 163 | THIN - Returns properties of a group.<br> |
| 164 | pageToken: string, A continuation token that allows pagination.<br> |
| 165 | updatedMin: integer, The lower bound on entry update dates (seconds from epcoh).<br> |
| 166 | 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> |
| 167 | userId: string, The user whose groups are being listed. (required)<br> |
| 168 | maxResults: integer, Maximum number of group entries to return.<br> |
| 169 | showDeleted: boolean, Flag to include deleted groups<br> |
| 170 | sortOrder: string, Sorting order of the result<br> |
| 171 | Allowed values<br> |
| 172 | ascending - Use ascending sort order<br> |
| 173 | descending - Use decending sort order<br> |
| 174 | alt: string, Specifies an alternative representation type.<br> |
| 175 | Allowed values<br> |
| 176 | json - Use JSON format<br> |
| 177 | <br> |
| 178 | Returns:<br> |
| 179 | An object of the form<br> |
| 180 | <br> |
| 181 | {<br> |
| 182 | "nextPageToken": "A String",<br> |
| 183 | "items": [<br> |
| 184 | {<br> |
| 185 | "kind": "contacts#group", # Type of the resource. This is always "contacts#group".<br> |
| 186 | "name": "A String", # Group name.<br> |
| 187 | "lastUpdateTime": "A String", # Last updated time of the group.<br> |
| 188 | "deleted": True or False, # If this group has been deleted (boolean field).<br> |
| 189 | "extendedProperties": [ # Extended properties of the group. Available only in full projection.<br> |
| 190 | {<br> |
| 191 | "name": "A String",<br> |
| 192 | "value": "A String",<br> |
| 193 | },<br> |
| 194 | ],<br> |
| 195 | "memberCount": 42, # Member count.<br> |
| 196 | "systemGroup": True or False, # Indication wheather the group is a system group.<br> |
| 197 | "id": "A String", # Group identifier.<br> |
| 198 | "selfLink": "A String", # URL pointing to this group. Used to retrieve, update, or delete this group.<br> |
| 199 | },<br> |
| 200 | ],<br> |
| 201 | "kind": "contacts#groupList", # Type of the resource. This is always "contacts#groupList".<br> |
| 202 | "prevPageToken": "A String",<br> |
| 203 | }</tt></dd></dl> |
| 204 | |
| 205 | <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> |
| 206 | <br> |
| 207 | Args:<br> |
| 208 | previous_request: The request for the previous page.<br> |
| 209 | previous_response: The response from the request for the previous page.<br> |
| 210 | <br> |
| 211 | Returns:<br> |
| 212 | A request object that you can call 'execute()' on to request the next<br> |
| 213 | page. Returns None if there are no more items in the collection.</tt></dd></dl> |
| 214 | |
| 215 | <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> |
| 216 | <br> |
| 217 | Args:<br> |
| 218 | body: object, The request body. (required)<br> |
| 219 | The object takes the form of:<br> |
| 220 | <br> |
| 221 | {<br> |
| 222 | "kind": "contacts#group", # Type of the resource. This is always "contacts#group".<br> |
| 223 | "name": "A String", # Group name.<br> |
| 224 | "lastUpdateTime": "A String", # Last updated time of the group.<br> |
| 225 | "deleted": True or False, # If this group has been deleted (boolean field).<br> |
| 226 | "extendedProperties": [ # Extended properties of the group. Available only in full projection.<br> |
| 227 | {<br> |
| 228 | "name": "A String",<br> |
| 229 | "value": "A String",<br> |
| 230 | },<br> |
| 231 | ],<br> |
| 232 | "memberCount": 42, # Member count.<br> |
| 233 | "systemGroup": True or False, # Indication wheather the group is a system group.<br> |
| 234 | "id": "A String", # Group identifier.<br> |
| 235 | "selfLink": "A String", # URL pointing to this group. Used to retrieve, update, or delete this group.<br> |
| 236 | }<br> |
| 237 | <br> |
| 238 | userId: string, The user whose groups are being updated. (required)<br> |
| 239 | groupId: string, The id of the group being updated. (required)<br> |
| 240 | <br> |
| 241 | Returns:<br> |
| 242 | An object of the form<br> |
| 243 | <br> |
| 244 | {<br> |
| 245 | "kind": "contacts#group", # Type of the resource. This is always "contacts#group".<br> |
| 246 | "name": "A String", # Group name.<br> |
| 247 | "lastUpdateTime": "A String", # Last updated time of the group.<br> |
| 248 | "deleted": True or False, # If this group has been deleted (boolean field).<br> |
| 249 | "extendedProperties": [ # Extended properties of the group. Available only in full projection.<br> |
| 250 | {<br> |
| 251 | "name": "A String",<br> |
| 252 | "value": "A String",<br> |
| 253 | },<br> |
| 254 | ],<br> |
| 255 | "memberCount": 42, # Member count.<br> |
| 256 | "systemGroup": True or False, # Indication wheather the group is a system group.<br> |
| 257 | "id": "A String", # Group identifier.<br> |
| 258 | "selfLink": "A String", # URL pointing to this group. Used to retrieve, update, or delete this group.<br> |
| 259 | }</tt></dd></dl> |
| 260 | |
| 261 | <dl><dt><a name="Resource-removeContacts"><strong>removeContacts</strong></a> = method(self, **kwargs)</dt><dd><tt>Removes contact(s) from the group.<br> |
| 262 | <br> |
| 263 | Args:<br> |
| 264 | body: object, The request body. (required)<br> |
| 265 | The object takes the form of:<br> |
| 266 | <br> |
| 267 | {<br> |
| 268 | "contactIds": [<br> |
| 269 | "A String",<br> |
| 270 | ],<br> |
| 271 | }<br> |
| 272 | <br> |
| 273 | userId: string, The user whose group is being updated. (required)<br> |
| 274 | groupId: string, The id of the group being updated. (required)<br> |
| 275 | <br> |
| 276 | Returns:<br> |
| 277 | An object of the form<br> |
| 278 | <br> |
| 279 | {<br> |
| 280 | "kind": "contacts#group", # Type of the resource. This is always "contacts#group".<br> |
| 281 | "name": "A String", # Group name.<br> |
| 282 | "lastUpdateTime": "A String", # Last updated time of the group.<br> |
| 283 | "deleted": True or False, # If this group has been deleted (boolean field).<br> |
| 284 | "extendedProperties": [ # Extended properties of the group. Available only in full projection.<br> |
| 285 | {<br> |
| 286 | "name": "A String",<br> |
| 287 | "value": "A String",<br> |
| 288 | },<br> |
| 289 | ],<br> |
| 290 | "memberCount": 42, # Member count.<br> |
| 291 | "systemGroup": True or False, # Indication wheather the group is a system group.<br> |
| 292 | "id": "A String", # Group identifier.<br> |
| 293 | "selfLink": "A String", # URL pointing to this group. Used to retrieve, update, or delete this group.<br> |
| 294 | }</tt></dd></dl> |
| 295 | |
| 296 | <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> |
| 297 | <br> |
| 298 | Args:<br> |
| 299 | body: object, The request body. (required)<br> |
| 300 | The object takes the form of:<br> |
| 301 | <br> |
| 302 | {<br> |
| 303 | "value": "A String",<br> |
| 304 | }<br> |
| 305 | <br> |
| 306 | userId: string, The user whose group's extended property is being requested. (required)<br> |
| 307 | key: string, Extended property key whose value is being requested. (required)<br> |
| 308 | groupId: string, Group whose extended property is being requested. (required)<br> |
| 309 | <br> |
| 310 | Returns:<br> |
| 311 | An object of the form<br> |
| 312 | <br> |
| 313 | {<br> |
| 314 | "value": "A String",<br> |
| 315 | }</tt></dd></dl> |
| 316 | |
| 317 | <dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Update a group entry.<br> |
| 318 | <br> |
| 319 | Args:<br> |
| 320 | body: object, The request body. (required)<br> |
| 321 | The object takes the form of:<br> |
| 322 | <br> |
| 323 | {<br> |
| 324 | "kind": "contacts#group", # Type of the resource. This is always "contacts#group".<br> |
| 325 | "name": "A String", # Group name.<br> |
| 326 | "lastUpdateTime": "A String", # Last updated time of the group.<br> |
| 327 | "deleted": True or False, # If this group has been deleted (boolean field).<br> |
| 328 | "extendedProperties": [ # Extended properties of the group. Available only in full projection.<br> |
| 329 | {<br> |
| 330 | "name": "A String",<br> |
| 331 | "value": "A String",<br> |
| 332 | },<br> |
| 333 | ],<br> |
| 334 | "memberCount": 42, # Member count.<br> |
| 335 | "systemGroup": True or False, # Indication wheather the group is a system group.<br> |
| 336 | "id": "A String", # Group identifier.<br> |
| 337 | "selfLink": "A String", # URL pointing to this group. Used to retrieve, update, or delete this group.<br> |
| 338 | }<br> |
| 339 | <br> |
| 340 | userId: string, The user whose groups are being updated. (required)<br> |
| 341 | groupId: string, The id of the group being updated. (required)<br> |
| 342 | <br> |
| 343 | Returns:<br> |
| 344 | An object of the form<br> |
| 345 | <br> |
| 346 | {<br> |
| 347 | "kind": "contacts#group", # Type of the resource. This is always "contacts#group".<br> |
| 348 | "name": "A String", # Group name.<br> |
| 349 | "lastUpdateTime": "A String", # Last updated time of the group.<br> |
| 350 | "deleted": True or False, # If this group has been deleted (boolean field).<br> |
| 351 | "extendedProperties": [ # Extended properties of the group. Available only in full projection.<br> |
| 352 | {<br> |
| 353 | "name": "A String",<br> |
| 354 | "value": "A String",<br> |
| 355 | },<br> |
| 356 | ],<br> |
| 357 | "memberCount": 42, # Member count.<br> |
| 358 | "systemGroup": True or False, # Indication wheather the group is a system group.<br> |
| 359 | "id": "A String", # Group identifier.<br> |
| 360 | "selfLink": "A String", # URL pointing to this group. Used to retrieve, update, or delete this group.<br> |
| 361 | }</tt></dd></dl> |
| 362 | |
| 363 | <hr> |
| 364 | Data descriptors defined here:<br> |
| 365 | <dl><dt><strong>__dict__</strong></dt> |
| 366 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 367 | </dl> |
| 368 | <dl><dt><strong>__weakref__</strong></dt> |
| 369 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 370 | </dl> |
| 371 | </td></tr></table> |
| 372 | </body></html> |