blob: 8aa998e9a39e4cf0f53155f18106bc7a4e4972f8 [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>Get&nbsp;an&nbsp;activity.<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;activityId:&nbsp;string,&nbsp;The&nbsp;ID&nbsp;of&nbsp;the&nbsp;activity&nbsp;to&nbsp;get.&nbsp;(required)<br>
&nbsp;&nbsp;alt:&nbsp;string,&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;json&nbsp;-&nbsp;Use&nbsp;JSON&nbsp;format</tt></dd></dl>
<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List&nbsp;all&nbsp;of&nbsp;the&nbsp;activities&nbsp;in&nbsp;the&nbsp;specified&nbsp;collection&nbsp;for&nbsp;a&nbsp;particular&nbsp;user.<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;pageToken:&nbsp;string,&nbsp;The&nbsp;continuation&nbsp;token,&nbsp;used&nbsp;to&nbsp;page&nbsp;through&nbsp;large&nbsp;result&nbsp;sets.&nbsp;To&nbsp;get&nbsp;the&nbsp;next&nbsp;page&nbsp;of&nbsp;results,&nbsp;set&nbsp;this&nbsp;parameter&nbsp;to&nbsp;the&nbsp;value&nbsp;of&nbsp;"nextPageToken"&nbsp;from&nbsp;the&nbsp;previous&nbsp;response.<br>
&nbsp;&nbsp;userId:&nbsp;string,&nbsp;The&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;to&nbsp;get&nbsp;activities&nbsp;for.&nbsp;The&nbsp;special&nbsp;value&nbsp;"me"&nbsp;can&nbsp;be&nbsp;used&nbsp;to&nbsp;indicate&nbsp;the&nbsp;authenticated&nbsp;user.&nbsp;(required)<br>
&nbsp;&nbsp;maxResults:&nbsp;integer,&nbsp;The&nbsp;maximum&nbsp;number&nbsp;of&nbsp;activities&nbsp;to&nbsp;include&nbsp;in&nbsp;the&nbsp;response,&nbsp;used&nbsp;for&nbsp;paging.&nbsp;For&nbsp;any&nbsp;response,&nbsp;the&nbsp;actual&nbsp;number&nbsp;returned&nbsp;may&nbsp;be&nbsp;less&nbsp;than&nbsp;the&nbsp;specified&nbsp;maxResults.<br>
&nbsp;&nbsp;collection:&nbsp;string,&nbsp;The&nbsp;collection&nbsp;of&nbsp;activities&nbsp;to&nbsp;list.&nbsp;(required)<br>
&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;-&nbsp;All&nbsp;public&nbsp;activities&nbsp;created&nbsp;by&nbsp;the&nbsp;specified&nbsp;user.<br>
&nbsp;&nbsp;alt:&nbsp;string,&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;json&nbsp;-&nbsp;Use&nbsp;JSON&nbsp;format</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&nbsp;the&nbsp;next&nbsp;page&nbsp;of&nbsp;results.<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;previous_request:&nbsp;The&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
&nbsp;&nbsp;previous_response:&nbsp;The&nbsp;response&nbsp;from&nbsp;the&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
&nbsp;<br>
Returns:<br>
&nbsp;&nbsp;A&nbsp;request&nbsp;object&nbsp;that&nbsp;you&nbsp;can&nbsp;call&nbsp;'execute()'&nbsp;on&nbsp;to&nbsp;request&nbsp;the&nbsp;next<br>
&nbsp;&nbsp;page.&nbsp;Returns&nbsp;None&nbsp;if&nbsp;there&nbsp;are&nbsp;no&nbsp;more&nbsp;items&nbsp;in&nbsp;the&nbsp;collection.</tt></dd></dl>
<dl><dt><a name="Resource-search"><strong>search</strong></a> = method(self, **kwargs)</dt><dd><tt>Search&nbsp;public&nbsp;activities.<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;orderBy:&nbsp;string,&nbsp;Specifies&nbsp;how&nbsp;to&nbsp;order&nbsp;search&nbsp;results.<br>
&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;best&nbsp;-&nbsp;Sort&nbsp;activities&nbsp;by&nbsp;relevance&nbsp;to&nbsp;the&nbsp;user,&nbsp;most&nbsp;relevant&nbsp;first.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;recent&nbsp;-&nbsp;Sort&nbsp;activities&nbsp;by&nbsp;published&nbsp;date,&nbsp;most&nbsp;recent&nbsp;first.<br>
&nbsp;&nbsp;language:&nbsp;string,&nbsp;Specify&nbsp;the&nbsp;preferred&nbsp;language&nbsp;to&nbsp;search&nbsp;with.&nbsp;See&nbsp;Language&nbsp;Codes&nbsp;for&nbsp;available&nbsp;values.<br>
&nbsp;&nbsp;pageToken:&nbsp;string,&nbsp;The&nbsp;continuation&nbsp;token,&nbsp;used&nbsp;to&nbsp;page&nbsp;through&nbsp;large&nbsp;result&nbsp;sets.&nbsp;To&nbsp;get&nbsp;the&nbsp;next&nbsp;page&nbsp;of&nbsp;results,&nbsp;set&nbsp;this&nbsp;parameter&nbsp;to&nbsp;the&nbsp;value&nbsp;of&nbsp;"nextPageToken"&nbsp;from&nbsp;the&nbsp;previous&nbsp;response.&nbsp;This&nbsp;token&nbsp;may&nbsp;be&nbsp;of&nbsp;any&nbsp;length.<br>
&nbsp;&nbsp;maxResults:&nbsp;integer,&nbsp;The&nbsp;maximum&nbsp;number&nbsp;of&nbsp;activities&nbsp;to&nbsp;include&nbsp;in&nbsp;the&nbsp;response,&nbsp;used&nbsp;for&nbsp;paging.&nbsp;For&nbsp;any&nbsp;response,&nbsp;the&nbsp;actual&nbsp;number&nbsp;returned&nbsp;may&nbsp;be&nbsp;less&nbsp;than&nbsp;the&nbsp;specified&nbsp;maxResults.<br>
&nbsp;&nbsp;query:&nbsp;string,&nbsp;Full-text&nbsp;search&nbsp;query&nbsp;string.&nbsp;(required)</tt></dd></dl>
<dl><dt><a name="Resource-search_next"><strong>search_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves&nbsp;the&nbsp;next&nbsp;page&nbsp;of&nbsp;results.<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;previous_request:&nbsp;The&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
&nbsp;&nbsp;previous_response:&nbsp;The&nbsp;response&nbsp;from&nbsp;the&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
&nbsp;<br>
Returns:<br>
&nbsp;&nbsp;A&nbsp;request&nbsp;object&nbsp;that&nbsp;you&nbsp;can&nbsp;call&nbsp;'execute()'&nbsp;on&nbsp;to&nbsp;request&nbsp;the&nbsp;next<br>
&nbsp;&nbsp;page.&nbsp;Returns&nbsp;None&nbsp;if&nbsp;there&nbsp;are&nbsp;no&nbsp;more&nbsp;items&nbsp;in&nbsp;the&nbsp;collection.</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>