Joe Gregorio | 761c456 | 2011-10-28 14:36:24 -0400 | [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-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets the visibility of an existing activity.<br> |
| 18 | <br> |
| 19 | Args:<br> |
Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame] | 20 | activityId: string, ID of the activity to get the visibility. (required)<br> |
| 21 | <br> |
| 22 | Returns:<br> |
| 23 | An object of the form<br> |
| 24 | <br> |
| 25 | {<br> |
| 26 | "kind": "orkut#visibility", # Identifies this resource as a visibility item. Value: "orkut#visibility"<br> |
| 27 | "visibility": "A String", # The visibility of the resource. Possible values are:<br> |
| 28 | # - default: not hidden by the user<br> |
| 29 | # - hidden: hidden<br> |
| 30 | "links": [ # List of resources for the visibility item.<br> |
| 31 | { # Links to resources related to the parent object.<br> |
| 32 | "href": "A String", # URL of the link.<br> |
| 33 | "type": "A String", # Media type of the link.<br> |
| 34 | "rel": "A String", # Relation between the resource and the parent object.<br> |
| 35 | "title": "A String", # Title of the link.<br> |
| 36 | },<br> |
| 37 | ],<br> |
| 38 | }</tt></dd></dl> |
Joe Gregorio | 761c456 | 2011-10-28 14:36:24 -0400 | [diff] [blame] | 39 | |
| 40 | <dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates the visibility of an existing activity. This method supports patch semantics.<br> |
| 41 | <br> |
| 42 | Args:<br> |
| 43 | body: object, The request body. (required)<br> |
Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame] | 44 | The object takes the form of:<br> |
| 45 | <br> |
| 46 | {<br> |
| 47 | "kind": "orkut#visibility", # Identifies this resource as a visibility item. Value: "orkut#visibility"<br> |
| 48 | "visibility": "A String", # The visibility of the resource. Possible values are:<br> |
| 49 | # - default: not hidden by the user<br> |
| 50 | # - hidden: hidden<br> |
| 51 | "links": [ # List of resources for the visibility item.<br> |
| 52 | { # Links to resources related to the parent object.<br> |
| 53 | "href": "A String", # URL of the link.<br> |
| 54 | "type": "A String", # Media type of the link.<br> |
| 55 | "rel": "A String", # Relation between the resource and the parent object.<br> |
| 56 | "title": "A String", # Title of the link.<br> |
| 57 | },<br> |
| 58 | ],<br> |
| 59 | }<br> |
| 60 | <br> |
| 61 | activityId: string, ID of the activity. (required)<br> |
| 62 | <br> |
| 63 | Returns:<br> |
| 64 | An object of the form<br> |
| 65 | <br> |
| 66 | {<br> |
| 67 | "kind": "orkut#visibility", # Identifies this resource as a visibility item. Value: "orkut#visibility"<br> |
| 68 | "visibility": "A String", # The visibility of the resource. Possible values are:<br> |
| 69 | # - default: not hidden by the user<br> |
| 70 | # - hidden: hidden<br> |
| 71 | "links": [ # List of resources for the visibility item.<br> |
| 72 | { # Links to resources related to the parent object.<br> |
| 73 | "href": "A String", # URL of the link.<br> |
| 74 | "type": "A String", # Media type of the link.<br> |
| 75 | "rel": "A String", # Relation between the resource and the parent object.<br> |
| 76 | "title": "A String", # Title of the link.<br> |
| 77 | },<br> |
| 78 | ],<br> |
| 79 | }</tt></dd></dl> |
Joe Gregorio | 761c456 | 2011-10-28 14:36:24 -0400 | [diff] [blame] | 80 | |
| 81 | <dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates the visibility of an existing activity.<br> |
| 82 | <br> |
| 83 | Args:<br> |
| 84 | body: object, The request body. (required)<br> |
Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame] | 85 | The object takes the form of:<br> |
| 86 | <br> |
| 87 | {<br> |
| 88 | "kind": "orkut#visibility", # Identifies this resource as a visibility item. Value: "orkut#visibility"<br> |
| 89 | "visibility": "A String", # The visibility of the resource. Possible values are:<br> |
| 90 | # - default: not hidden by the user<br> |
| 91 | # - hidden: hidden<br> |
| 92 | "links": [ # List of resources for the visibility item.<br> |
| 93 | { # Links to resources related to the parent object.<br> |
| 94 | "href": "A String", # URL of the link.<br> |
| 95 | "type": "A String", # Media type of the link.<br> |
| 96 | "rel": "A String", # Relation between the resource and the parent object.<br> |
| 97 | "title": "A String", # Title of the link.<br> |
| 98 | },<br> |
| 99 | ],<br> |
| 100 | }<br> |
| 101 | <br> |
| 102 | activityId: string, ID of the activity. (required)<br> |
| 103 | <br> |
| 104 | Returns:<br> |
| 105 | An object of the form<br> |
| 106 | <br> |
| 107 | {<br> |
| 108 | "kind": "orkut#visibility", # Identifies this resource as a visibility item. Value: "orkut#visibility"<br> |
| 109 | "visibility": "A String", # The visibility of the resource. Possible values are:<br> |
| 110 | # - default: not hidden by the user<br> |
| 111 | # - hidden: hidden<br> |
| 112 | "links": [ # List of resources for the visibility item.<br> |
| 113 | { # Links to resources related to the parent object.<br> |
| 114 | "href": "A String", # URL of the link.<br> |
| 115 | "type": "A String", # Media type of the link.<br> |
| 116 | "rel": "A String", # Relation between the resource and the parent object.<br> |
| 117 | "title": "A String", # Title of the link.<br> |
| 118 | },<br> |
| 119 | ],<br> |
| 120 | }</tt></dd></dl> |
Joe Gregorio | 761c456 | 2011-10-28 14:36:24 -0400 | [diff] [blame] | 121 | |
| 122 | <hr> |
| 123 | Data descriptors defined here:<br> |
| 124 | <dl><dt><strong>__dict__</strong></dt> |
| 125 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 126 | </dl> |
| 127 | <dl><dt><strong>__weakref__</strong></dt> |
| 128 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 129 | </dl> |
| 130 | </td></tr></table> |
| 131 | </body></html> |