Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 58037ab884820a66a879b114d0bc8825fbb7188d / . / docs / dyn / buzz.v1.people.html
blob: 2aa47da13b6b0362aba9d95037ad792acb14788d [file] [log] [blame]
Joe Gregorioafc45f22011-02-20 16:11:28 -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>&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-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Remove&nbsp;a&nbsp;person&nbsp;from&nbsp;a&nbsp;group<br>
18&nbsp;<br>
19Args:<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500[diff] [blame]20&nbsp;&nbsp;personId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;person&nbsp;to&nbsp;remove&nbsp;from&nbsp;the&nbsp;group.&nbsp;(required)<br>
21&nbsp;&nbsp;userId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;owner&nbsp;of&nbsp;the&nbsp;group.&nbsp;(required)<br>
22&nbsp;&nbsp;hl:&nbsp;string,&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
23&nbsp;&nbsp;alt:&nbsp;string,&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
24&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
25&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;atom&nbsp;-&nbsp;Use&nbsp;Atom&nbsp;XML&nbsp;format<br>
26&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;json&nbsp;-&nbsp;Use&nbsp;JSON&nbsp;format<br>
27&nbsp;&nbsp;groupId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;group&nbsp;from&nbsp;which&nbsp;to&nbsp;remove&nbsp;the&nbsp;person.&nbsp;(required)</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -0500[diff] [blame]28
29<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Get&nbsp;a&nbsp;user&nbsp;profile<br>
30&nbsp;<br>
31Args:<br>
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]32&nbsp;&nbsp;userId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;being&nbsp;referenced.&nbsp;(required)<br>
33&nbsp;&nbsp;hl:&nbsp;string,&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500[diff] [blame]34&nbsp;&nbsp;alt:&nbsp;string,&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
35&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
36&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;atom&nbsp;-&nbsp;Use&nbsp;Atom&nbsp;XML&nbsp;format<br>
Joe Gregorio20a5aa92011-04-01 17:44:25 -0400[diff] [blame]37&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;json&nbsp;-&nbsp;Use&nbsp;JSON&nbsp;format</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -0500[diff] [blame]38
39<dl><dt><a name="Resource-liked"><strong>liked</strong></a> = method(self, **kwargs)</dt><dd><tt>Get&nbsp;people&nbsp;who&nbsp;liked&nbsp;an&nbsp;activity<br>
40&nbsp;<br>
41Args:<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500[diff] [blame]42&nbsp;&nbsp;c:&nbsp;string,&nbsp;A&nbsp;continuation&nbsp;token&nbsp;that&nbsp;allows&nbsp;pagination.<br>
43&nbsp;&nbsp;userId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;being&nbsp;referenced.&nbsp;(required)<br>
44&nbsp;&nbsp;max_results:&nbsp;integer,&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;include.<br>
45&nbsp;&nbsp;hl:&nbsp;string,&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
46&nbsp;&nbsp;scope:&nbsp;string,&nbsp;A&nbsp;parameter&nbsp;(required)<br>
47&nbsp;&nbsp;alt:&nbsp;string,&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
48&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
49&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;atom&nbsp;-&nbsp;Use&nbsp;Atom&nbsp;XML&nbsp;format<br>
50&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;json&nbsp;-&nbsp;Use&nbsp;JSON&nbsp;format<br>
51&nbsp;&nbsp;postId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;activity&nbsp;that&nbsp;was&nbsp;liked.&nbsp;(required)<br>
52&nbsp;&nbsp;groupId:&nbsp;string,&nbsp;A&nbsp;parameter&nbsp;(required)<br>
53&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
54&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;@liked&nbsp;-&nbsp;People&nbsp;who&nbsp;liked&nbsp;this&nbsp;activity.</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -0500[diff] [blame]55
Joe Gregorio761c4562011-10-28 14:36:24 -0400[diff] [blame]56<dl><dt><a name="Resource-liked_next"><strong>liked_next</strong></a> = methodNext(self, previous)</dt><dd><tt>Retrieve&nbsp;the&nbsp;next&nbsp;page&nbsp;of&nbsp;results.<br>
57&nbsp;<br>
58Takes&nbsp;a&nbsp;single&nbsp;argument,&nbsp;'body',&nbsp;which&nbsp;is&nbsp;the&nbsp;results<br>
Joe Gregorioafc45f22011-02-20 16:11:28 -0500[diff] [blame]59from&nbsp;the&nbsp;last&nbsp;call,&nbsp;and&nbsp;returns&nbsp;the&nbsp;next&nbsp;set&nbsp;of&nbsp;items<br>
60in&nbsp;the&nbsp;collection.<br>
61&nbsp;<br>
Joe Gregorio761c4562011-10-28 14:36:24 -0400[diff] [blame]62Returns:<br>
63&nbsp;&nbsp;None&nbsp;if&nbsp;there&nbsp;are&nbsp;no&nbsp;more&nbsp;items&nbsp;in&nbsp;the&nbsp;collection.</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -0500[diff] [blame]64
65<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Get&nbsp;people&nbsp;in&nbsp;a&nbsp;group<br>
66&nbsp;<br>
67Args:<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500[diff] [blame]68&nbsp;&nbsp;c:&nbsp;string,&nbsp;A&nbsp;continuation&nbsp;token&nbsp;that&nbsp;allows&nbsp;pagination.<br>
69&nbsp;&nbsp;userId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;being&nbsp;referenced.&nbsp;(required)<br>
70&nbsp;&nbsp;max_results:&nbsp;integer,&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;include.<br>
71&nbsp;&nbsp;hl:&nbsp;string,&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
72&nbsp;&nbsp;alt:&nbsp;string,&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
73&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
74&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;atom&nbsp;-&nbsp;Use&nbsp;Atom&nbsp;XML&nbsp;format<br>
75&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;json&nbsp;-&nbsp;Use&nbsp;JSON&nbsp;format<br>
76&nbsp;&nbsp;groupId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;group&nbsp;for&nbsp;which&nbsp;to&nbsp;list&nbsp;users.&nbsp;(required)</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -0500[diff] [blame]77
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]78<dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Add&nbsp;a&nbsp;person&nbsp;to&nbsp;a&nbsp;group.&nbsp;This&nbsp;method&nbsp;supports&nbsp;patch&nbsp;semantics.<br>
79&nbsp;<br>
80Args:<br>
81&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
82&nbsp;&nbsp;personId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;person&nbsp;to&nbsp;add&nbsp;to&nbsp;the&nbsp;group.&nbsp;(required)<br>
83&nbsp;&nbsp;userId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;owner&nbsp;of&nbsp;the&nbsp;group.&nbsp;(required)<br>
84&nbsp;&nbsp;hl:&nbsp;string,&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
85&nbsp;&nbsp;alt:&nbsp;string,&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
86&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
87&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;atom&nbsp;-&nbsp;Use&nbsp;Atom&nbsp;XML&nbsp;format<br>
88&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;json&nbsp;-&nbsp;Use&nbsp;JSON&nbsp;format<br>
89&nbsp;&nbsp;groupId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;group&nbsp;to&nbsp;which&nbsp;to&nbsp;add&nbsp;the&nbsp;person.&nbsp;(required)</tt></dd></dl>
90
Joe Gregorioafc45f22011-02-20 16:11:28 -0500[diff] [blame]91<dl><dt><a name="Resource-reshared"><strong>reshared</strong></a> = method(self, **kwargs)</dt><dd><tt>Get&nbsp;people&nbsp;who&nbsp;reshared&nbsp;an&nbsp;activity<br>
92&nbsp;<br>
93Args:<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500[diff] [blame]94&nbsp;&nbsp;c:&nbsp;string,&nbsp;A&nbsp;continuation&nbsp;token&nbsp;that&nbsp;allows&nbsp;pagination.<br>
95&nbsp;&nbsp;userId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;being&nbsp;referenced.&nbsp;(required)<br>
96&nbsp;&nbsp;max_results:&nbsp;integer,&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;include.<br>
97&nbsp;&nbsp;hl:&nbsp;string,&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
98&nbsp;&nbsp;scope:&nbsp;string,&nbsp;A&nbsp;parameter&nbsp;(required)<br>
99&nbsp;&nbsp;alt:&nbsp;string,&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
100&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
101&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;atom&nbsp;-&nbsp;Use&nbsp;Atom&nbsp;XML&nbsp;format<br>
102&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;json&nbsp;-&nbsp;Use&nbsp;JSON&nbsp;format<br>
103&nbsp;&nbsp;postId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;activity&nbsp;that&nbsp;was&nbsp;reshared.&nbsp;(required)<br>
104&nbsp;&nbsp;groupId:&nbsp;string,&nbsp;A&nbsp;parameter&nbsp;(required)<br>
105&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
106&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;@reshared&nbsp;-&nbsp;People&nbsp;who&nbsp;reshared&nbsp;this&nbsp;activity.</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -0500[diff] [blame]107
108<dl><dt><a name="Resource-search"><strong>search</strong></a> = method(self, **kwargs)</dt><dd><tt>Search&nbsp;for&nbsp;people<br>
109&nbsp;<br>
110Args:<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500[diff] [blame]111&nbsp;&nbsp;c:&nbsp;string,&nbsp;A&nbsp;continuation&nbsp;token&nbsp;that&nbsp;allows&nbsp;pagination.<br>
112&nbsp;&nbsp;q:&nbsp;string,&nbsp;Full-text&nbsp;search&nbsp;query&nbsp;string.<br>
113&nbsp;&nbsp;max_results:&nbsp;integer,&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;include.<br>
114&nbsp;&nbsp;hl:&nbsp;string,&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
115&nbsp;&nbsp;alt:&nbsp;string,&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
116&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
117&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;atom&nbsp;-&nbsp;Use&nbsp;Atom&nbsp;XML&nbsp;format<br>
118&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;json&nbsp;-&nbsp;Use&nbsp;JSON&nbsp;format</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -0500[diff] [blame]119
120<dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Add&nbsp;a&nbsp;person&nbsp;to&nbsp;a&nbsp;group<br>
121&nbsp;<br>
122Args:<br>
Joe Gregorio93841702011-03-02 16:12:05 -0800[diff] [blame]123&nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
Joe Gregorioad258e22011-02-22 22:53:30 -0500[diff] [blame]124&nbsp;&nbsp;personId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;person&nbsp;to&nbsp;add&nbsp;to&nbsp;the&nbsp;group.&nbsp;(required)<br>
125&nbsp;&nbsp;userId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;owner&nbsp;of&nbsp;the&nbsp;group.&nbsp;(required)<br>
126&nbsp;&nbsp;hl:&nbsp;string,&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
127&nbsp;&nbsp;alt:&nbsp;string,&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
128&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
129&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;atom&nbsp;-&nbsp;Use&nbsp;Atom&nbsp;XML&nbsp;format<br>
130&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;json&nbsp;-&nbsp;Use&nbsp;JSON&nbsp;format<br>
131&nbsp;&nbsp;groupId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;group&nbsp;to&nbsp;which&nbsp;to&nbsp;add&nbsp;the&nbsp;person.&nbsp;(required)</tt></dd></dl>
Joe Gregorioafc45f22011-02-20 16:11:28 -0500[diff] [blame]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>