blob: 9648aa86e47dc1bce4a8ddcd2b6f53a00b7b8d92 [file] [log] [blame]
Joe Gregorioafc45f22011-02-20 16:11:28 -05001
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>&nbsp;<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>&nbsp;&nbsp;&nbsp;</tt></td>
12<td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
13<tr><td>&nbsp;</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-count"><strong>count</strong></a> = method(self, **kwargs)</dt><dd><tt>Get&nbsp;a&nbsp;count&nbsp;of&nbsp;link&nbsp;shares<br>
18&nbsp;<br>
19Args:<br>
20&nbsp;&nbsp;url:&nbsp;URLs&nbsp;for&nbsp;which&nbsp;to&nbsp;get&nbsp;share&nbsp;counts.<br>
21&nbsp;&nbsp;hl:&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.</tt></dd></dl>
22
23<dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Delete&nbsp;an&nbsp;activity<br>
24&nbsp;<br>
25Args:<br>
26&nbsp;&nbsp;scope:&nbsp;The&nbsp;collection&nbsp;to&nbsp;which&nbsp;the&nbsp;activity&nbsp;belongs.&nbsp;(required)<br>
27&nbsp;&nbsp;alt:&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
28&nbsp;&nbsp;postId:&nbsp;ID&nbsp;of&nbsp;the&nbsp;activity&nbsp;to&nbsp;delete.&nbsp;(required)<br>
29&nbsp;&nbsp;userId:&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;whose&nbsp;post&nbsp;to&nbsp;delete.&nbsp;(required)<br>
30&nbsp;&nbsp;hl:&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.</tt></dd></dl>
31
32<dl><dt><a name="Resource-extractPeopleFromSearch"><strong>extractPeopleFromSearch</strong></a> = method(self, **kwargs)</dt><dd><tt>Search&nbsp;for&nbsp;people&nbsp;by&nbsp;topic<br>
33&nbsp;<br>
34Args:<br>
35&nbsp;&nbsp;c:&nbsp;A&nbsp;continuation&nbsp;token&nbsp;that&nbsp;allows&nbsp;pagination.<br>
36&nbsp;&nbsp;pid:&nbsp;ID&nbsp;of&nbsp;a&nbsp;place&nbsp;to&nbsp;use&nbsp;in&nbsp;a&nbsp;geographic&nbsp;location&nbsp;query.<br>
37&nbsp;&nbsp;lon:&nbsp;Longitude&nbsp;to&nbsp;use&nbsp;in&nbsp;a&nbsp;geographic&nbsp;location&nbsp;query.<br>
38&nbsp;&nbsp;q:&nbsp;Full-text&nbsp;search&nbsp;query&nbsp;string.<br>
39&nbsp;&nbsp;max_results:&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;include.<br>
40&nbsp;&nbsp;radius:&nbsp;Radius&nbsp;to&nbsp;use&nbsp;in&nbsp;a&nbsp;geographic&nbsp;location&nbsp;query.<br>
41&nbsp;&nbsp;bbox:&nbsp;Bounding&nbsp;box&nbsp;to&nbsp;use&nbsp;in&nbsp;a&nbsp;geographic&nbsp;location&nbsp;query.<br>
42&nbsp;&nbsp;hl:&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
43&nbsp;&nbsp;lat:&nbsp;Latitude&nbsp;to&nbsp;use&nbsp;in&nbsp;a&nbsp;geographic&nbsp;location&nbsp;query.<br>
44&nbsp;&nbsp;alt:&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.</tt></dd></dl>
45
46<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Get&nbsp;an&nbsp;activity<br>
47&nbsp;<br>
48Args:<br>
49&nbsp;&nbsp;postId:&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;to&nbsp;get.&nbsp;(required)<br>
50&nbsp;&nbsp;userId:&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;whose&nbsp;post&nbsp;to&nbsp;get.&nbsp;(required)<br>
51&nbsp;&nbsp;truncateAtom:&nbsp;Truncate&nbsp;the&nbsp;value&nbsp;of&nbsp;the&nbsp;atom:content&nbsp;element.<br>
52&nbsp;&nbsp;hl:&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
53&nbsp;&nbsp;alt:&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
54&nbsp;&nbsp;max_comments:&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;comments&nbsp;to&nbsp;include.<br>
55&nbsp;&nbsp;max_liked:&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;likes&nbsp;to&nbsp;include.</tt></dd></dl>
56
57<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Create&nbsp;a&nbsp;new&nbsp;activity<br>
58&nbsp;<br>
59Args:<br>
60&nbsp;&nbsp;body:&nbsp;The&nbsp;request&nbsp;body.<br>
61&nbsp;&nbsp;alt:&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
62&nbsp;&nbsp;preview:&nbsp;If&nbsp;true,&nbsp;only&nbsp;preview&nbsp;the&nbsp;action.<br>
63&nbsp;&nbsp;userId:&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;being&nbsp;referenced.&nbsp;(required)<br>
64&nbsp;&nbsp;hl:&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.</tt></dd></dl>
65
66<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List&nbsp;activities<br>
67&nbsp;<br>
68Args:<br>
69&nbsp;&nbsp;c:&nbsp;A&nbsp;continuation&nbsp;token&nbsp;that&nbsp;allows&nbsp;pagination.<br>
70&nbsp;&nbsp;userId:&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;being&nbsp;referenced.&nbsp;(required)<br>
71&nbsp;&nbsp;truncateAtom:&nbsp;Truncate&nbsp;the&nbsp;value&nbsp;of&nbsp;the&nbsp;atom:content&nbsp;element.<br>
72&nbsp;&nbsp;max_results:&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;include.<br>
73&nbsp;&nbsp;hl:&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
74&nbsp;&nbsp;scope:&nbsp;The&nbsp;collection&nbsp;of&nbsp;activities&nbsp;to&nbsp;list.&nbsp;(required)<br>
75&nbsp;&nbsp;alt:&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
76&nbsp;&nbsp;max_comments:&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;comments&nbsp;to&nbsp;include.<br>
77&nbsp;&nbsp;max_liked:&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;likes&nbsp;to&nbsp;include.</tt></dd></dl>
78
79<dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous)</dt><dd><tt>Takes&nbsp;a&nbsp;single&nbsp;argument,&nbsp;'body',&nbsp;which&nbsp;is&nbsp;the&nbsp;results<br>
80from&nbsp;the&nbsp;last&nbsp;call,&nbsp;and&nbsp;returns&nbsp;the&nbsp;next&nbsp;set&nbsp;of&nbsp;items<br>
81in&nbsp;the&nbsp;collection.<br>
82&nbsp;<br>
83Returns&nbsp;None&nbsp;if&nbsp;there&nbsp;are&nbsp;no&nbsp;more&nbsp;items&nbsp;in<br>
84the&nbsp;collection.</tt></dd></dl>
85
86<dl><dt><a name="Resource-search"><strong>search</strong></a> = method(self, **kwargs)</dt><dd><tt>Search&nbsp;for&nbsp;activities<br>
87&nbsp;<br>
88Args:<br>
89&nbsp;&nbsp;c:&nbsp;A&nbsp;continuation&nbsp;token&nbsp;that&nbsp;allows&nbsp;pagination.<br>
90&nbsp;&nbsp;pid:&nbsp;ID&nbsp;of&nbsp;a&nbsp;place&nbsp;to&nbsp;use&nbsp;in&nbsp;a&nbsp;geographic&nbsp;location&nbsp;query.<br>
91&nbsp;&nbsp;lon:&nbsp;Longitude&nbsp;to&nbsp;use&nbsp;in&nbsp;a&nbsp;geographic&nbsp;location&nbsp;query.<br>
92&nbsp;&nbsp;q:&nbsp;Full-text&nbsp;search&nbsp;query&nbsp;string.<br>
93&nbsp;&nbsp;truncateAtom:&nbsp;Truncate&nbsp;the&nbsp;value&nbsp;of&nbsp;the&nbsp;atom:content&nbsp;element.<br>
94&nbsp;&nbsp;max_results:&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;include.<br>
95&nbsp;&nbsp;radius:&nbsp;Radius&nbsp;to&nbsp;use&nbsp;in&nbsp;a&nbsp;geographic&nbsp;location&nbsp;query.<br>
96&nbsp;&nbsp;bbox:&nbsp;Bounding&nbsp;box&nbsp;to&nbsp;use&nbsp;in&nbsp;a&nbsp;geographic&nbsp;location&nbsp;query.<br>
97&nbsp;&nbsp;hl:&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
98&nbsp;&nbsp;lat:&nbsp;Latitude&nbsp;to&nbsp;use&nbsp;in&nbsp;a&nbsp;geographic&nbsp;location&nbsp;query.<br>
99&nbsp;&nbsp;alt:&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.</tt></dd></dl>
100
101<dl><dt><a name="Resource-search_next"><strong>search_next</strong></a> = methodNext(self, previous)</dt><dd><tt>Takes&nbsp;a&nbsp;single&nbsp;argument,&nbsp;'body',&nbsp;which&nbsp;is&nbsp;the&nbsp;results<br>
102from&nbsp;the&nbsp;last&nbsp;call,&nbsp;and&nbsp;returns&nbsp;the&nbsp;next&nbsp;set&nbsp;of&nbsp;items<br>
103in&nbsp;the&nbsp;collection.<br>
104&nbsp;<br>
105Returns&nbsp;None&nbsp;if&nbsp;there&nbsp;are&nbsp;no&nbsp;more&nbsp;items&nbsp;in<br>
106the&nbsp;collection.</tt></dd></dl>
107
108<dl><dt><a name="Resource-track"><strong>track</strong></a> = method(self, **kwargs)</dt><dd><tt>Get&nbsp;real-time&nbsp;activity&nbsp;tracking&nbsp;information<br>
109&nbsp;<br>
110Args:<br>
111&nbsp;&nbsp;c:&nbsp;A&nbsp;continuation&nbsp;token&nbsp;that&nbsp;allows&nbsp;pagination.<br>
112&nbsp;&nbsp;pid:&nbsp;ID&nbsp;of&nbsp;a&nbsp;place&nbsp;to&nbsp;use&nbsp;in&nbsp;a&nbsp;geographic&nbsp;location&nbsp;query.<br>
113&nbsp;&nbsp;lon:&nbsp;Longitude&nbsp;to&nbsp;use&nbsp;in&nbsp;a&nbsp;geographic&nbsp;location&nbsp;query.<br>
114&nbsp;&nbsp;q:&nbsp;Full-text&nbsp;search&nbsp;query&nbsp;string.<br>
115&nbsp;&nbsp;max_results:&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;include.<br>
116&nbsp;&nbsp;radius:&nbsp;Radius&nbsp;to&nbsp;use&nbsp;in&nbsp;a&nbsp;geographic&nbsp;location&nbsp;query.<br>
117&nbsp;&nbsp;bbox:&nbsp;Bounding&nbsp;box&nbsp;to&nbsp;use&nbsp;in&nbsp;a&nbsp;geographic&nbsp;location&nbsp;query.<br>
118&nbsp;&nbsp;hl:&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
119&nbsp;&nbsp;lat:&nbsp;Latitude&nbsp;to&nbsp;use&nbsp;in&nbsp;a&nbsp;geographic&nbsp;location&nbsp;query.<br>
120&nbsp;&nbsp;alt:&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.</tt></dd></dl>
121
122<dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Update&nbsp;an&nbsp;activity<br>
123&nbsp;<br>
124Args:<br>
125&nbsp;&nbsp;body:&nbsp;The&nbsp;request&nbsp;body.<br>
126&nbsp;&nbsp;userId:&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;whose&nbsp;post&nbsp;to&nbsp;update.&nbsp;(required)<br>
127&nbsp;&nbsp;abuseType:&nbsp;A&nbsp;parameter<br>
128&nbsp;&nbsp;hl:&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
129&nbsp;&nbsp;scope:&nbsp;The&nbsp;collection&nbsp;to&nbsp;which&nbsp;the&nbsp;activity&nbsp;belongs.&nbsp;(required)<br>
130&nbsp;&nbsp;alt:&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
131&nbsp;&nbsp;postId:&nbsp;ID&nbsp;of&nbsp;the&nbsp;activity&nbsp;to&nbsp;update.&nbsp;(required)</tt></dd></dl>
132
133<hr>
134Data descriptors defined here:<br>
135<dl><dt><strong>__dict__</strong></dt>
136<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
137</dl>
138<dl><dt><strong>__weakref__</strong></dt>
139<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
140</dl>
141</td></tr></table>
142</body></html>