blob: ce76a76ba75d942429909761ee78608d3c3de765 [file] [log] [blame]
<!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>&nbsp;<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>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</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-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets&nbsp;the&nbsp;visibility&nbsp;of&nbsp;an&nbsp;existing&nbsp;activity.<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;activityId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;activity&nbsp;to&nbsp;get&nbsp;the&nbsp;visibility.&nbsp;(required)<br>
&nbsp;<br>
Returns:<br>
&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"orkut#visibility",&nbsp;#&nbsp;Identifies&nbsp;this&nbsp;resource&nbsp;as&nbsp;a&nbsp;visibility&nbsp;item.&nbsp;Value:&nbsp;"orkut#visibility"<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"visibility":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;visibility&nbsp;of&nbsp;the&nbsp;resource.&nbsp;Possible&nbsp;values&nbsp;are:<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;-&nbsp;default:&nbsp;not&nbsp;hidden&nbsp;by&nbsp;the&nbsp;user<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;-&nbsp;hidden:&nbsp;hidden<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"links":&nbsp;[&nbsp;#&nbsp;List&nbsp;of&nbsp;resources&nbsp;for&nbsp;the&nbsp;visibility&nbsp;item.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{&nbsp;#&nbsp;Links&nbsp;to&nbsp;resources&nbsp;related&nbsp;to&nbsp;the&nbsp;parent&nbsp;object.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"href":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;of&nbsp;the&nbsp;link.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Media&nbsp;type&nbsp;of&nbsp;the&nbsp;link.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rel":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Relation&nbsp;between&nbsp;the&nbsp;resource&nbsp;and&nbsp;the&nbsp;parent&nbsp;object.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;link.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
<dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates&nbsp;the&nbsp;visibility&nbsp;of&nbsp;an&nbsp;existing&nbsp;activity.&nbsp;This&nbsp;method&nbsp;supports&nbsp;patch&nbsp;semantics.<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
&nbsp;<br>
{<br>
&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"orkut#visibility",&nbsp;#&nbsp;Identifies&nbsp;this&nbsp;resource&nbsp;as&nbsp;a&nbsp;visibility&nbsp;item.&nbsp;Value:&nbsp;"orkut#visibility"<br>
&nbsp;&nbsp;&nbsp;&nbsp;"visibility":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;visibility&nbsp;of&nbsp;the&nbsp;resource.&nbsp;Possible&nbsp;values&nbsp;are:<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;-&nbsp;default:&nbsp;not&nbsp;hidden&nbsp;by&nbsp;the&nbsp;user<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;-&nbsp;hidden:&nbsp;hidden<br>
&nbsp;&nbsp;&nbsp;&nbsp;"links":&nbsp;[&nbsp;#&nbsp;List&nbsp;of&nbsp;resources&nbsp;for&nbsp;the&nbsp;visibility&nbsp;item.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{&nbsp;#&nbsp;Links&nbsp;to&nbsp;resources&nbsp;related&nbsp;to&nbsp;the&nbsp;parent&nbsp;object.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"href":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;of&nbsp;the&nbsp;link.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Media&nbsp;type&nbsp;of&nbsp;the&nbsp;link.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rel":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Relation&nbsp;between&nbsp;the&nbsp;resource&nbsp;and&nbsp;the&nbsp;parent&nbsp;object.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;link.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;],<br>
&nbsp;&nbsp;}<br>
&nbsp;<br>
&nbsp;&nbsp;activityId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;activity.&nbsp;(required)<br>
&nbsp;<br>
Returns:<br>
&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"orkut#visibility",&nbsp;#&nbsp;Identifies&nbsp;this&nbsp;resource&nbsp;as&nbsp;a&nbsp;visibility&nbsp;item.&nbsp;Value:&nbsp;"orkut#visibility"<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"visibility":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;visibility&nbsp;of&nbsp;the&nbsp;resource.&nbsp;Possible&nbsp;values&nbsp;are:<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;-&nbsp;default:&nbsp;not&nbsp;hidden&nbsp;by&nbsp;the&nbsp;user<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;-&nbsp;hidden:&nbsp;hidden<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"links":&nbsp;[&nbsp;#&nbsp;List&nbsp;of&nbsp;resources&nbsp;for&nbsp;the&nbsp;visibility&nbsp;item.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{&nbsp;#&nbsp;Links&nbsp;to&nbsp;resources&nbsp;related&nbsp;to&nbsp;the&nbsp;parent&nbsp;object.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"href":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;of&nbsp;the&nbsp;link.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Media&nbsp;type&nbsp;of&nbsp;the&nbsp;link.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rel":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Relation&nbsp;between&nbsp;the&nbsp;resource&nbsp;and&nbsp;the&nbsp;parent&nbsp;object.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;link.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
<dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates&nbsp;the&nbsp;visibility&nbsp;of&nbsp;an&nbsp;existing&nbsp;activity.<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;object&nbsp;takes&nbsp;the&nbsp;form&nbsp;of:<br>
&nbsp;<br>
{<br>
&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"orkut#visibility",&nbsp;#&nbsp;Identifies&nbsp;this&nbsp;resource&nbsp;as&nbsp;a&nbsp;visibility&nbsp;item.&nbsp;Value:&nbsp;"orkut#visibility"<br>
&nbsp;&nbsp;&nbsp;&nbsp;"visibility":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;visibility&nbsp;of&nbsp;the&nbsp;resource.&nbsp;Possible&nbsp;values&nbsp;are:<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;-&nbsp;default:&nbsp;not&nbsp;hidden&nbsp;by&nbsp;the&nbsp;user<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;-&nbsp;hidden:&nbsp;hidden<br>
&nbsp;&nbsp;&nbsp;&nbsp;"links":&nbsp;[&nbsp;#&nbsp;List&nbsp;of&nbsp;resources&nbsp;for&nbsp;the&nbsp;visibility&nbsp;item.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{&nbsp;#&nbsp;Links&nbsp;to&nbsp;resources&nbsp;related&nbsp;to&nbsp;the&nbsp;parent&nbsp;object.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"href":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;of&nbsp;the&nbsp;link.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Media&nbsp;type&nbsp;of&nbsp;the&nbsp;link.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rel":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Relation&nbsp;between&nbsp;the&nbsp;resource&nbsp;and&nbsp;the&nbsp;parent&nbsp;object.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;link.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;],<br>
&nbsp;&nbsp;}<br>
&nbsp;<br>
&nbsp;&nbsp;activityId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;activity.&nbsp;(required)<br>
&nbsp;<br>
Returns:<br>
&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"orkut#visibility",&nbsp;#&nbsp;Identifies&nbsp;this&nbsp;resource&nbsp;as&nbsp;a&nbsp;visibility&nbsp;item.&nbsp;Value:&nbsp;"orkut#visibility"<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"visibility":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;visibility&nbsp;of&nbsp;the&nbsp;resource.&nbsp;Possible&nbsp;values&nbsp;are:<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;-&nbsp;default:&nbsp;not&nbsp;hidden&nbsp;by&nbsp;the&nbsp;user<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;-&nbsp;hidden:&nbsp;hidden<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"links":&nbsp;[&nbsp;#&nbsp;List&nbsp;of&nbsp;resources&nbsp;for&nbsp;the&nbsp;visibility&nbsp;item.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{&nbsp;#&nbsp;Links&nbsp;to&nbsp;resources&nbsp;related&nbsp;to&nbsp;the&nbsp;parent&nbsp;object.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"href":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;of&nbsp;the&nbsp;link.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Media&nbsp;type&nbsp;of&nbsp;the&nbsp;link.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rel":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Relation&nbsp;between&nbsp;the&nbsp;resource&nbsp;and&nbsp;the&nbsp;parent&nbsp;object.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"title":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Title&nbsp;of&nbsp;the&nbsp;link.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;],<br>
&nbsp;&nbsp;&nbsp;&nbsp;}</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
</td></tr></table>
</body></html>