Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 2b781287174b9335b6a77f14f87f2c28e6cfad8e / . / docs / dyn / plus.v1.people.html
blob: 1c0d75970ac72d291411863196f2c7462e50a2b7 [file] [log] [blame]
Joe Gregorio761c4562011-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>&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-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Get&nbsp;a&nbsp;person's&nbsp;profile.<br>
18&nbsp;<br>
19Args:<br>
20&nbsp;&nbsp;userId:&nbsp;string,&nbsp;The&nbsp;ID&nbsp;of&nbsp;the&nbsp;person&nbsp;to&nbsp;get&nbsp;the&nbsp;profile&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)</tt></dd></dl>
21
22<dl><dt><a name="Resource-listByActivity"><strong>listByActivity</strong></a> = method(self, **kwargs)</dt><dd><tt>List&nbsp;all&nbsp;of&nbsp;the&nbsp;people&nbsp;in&nbsp;the&nbsp;specified&nbsp;collection&nbsp;for&nbsp;a&nbsp;particular&nbsp;activity.<br>
23&nbsp;<br>
24Args:<br>
25&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>
26&nbsp;&nbsp;maxResults:&nbsp;integer,&nbsp;The&nbsp;maximum&nbsp;number&nbsp;of&nbsp;people&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>
27&nbsp;&nbsp;activityId:&nbsp;string,&nbsp;The&nbsp;ID&nbsp;of&nbsp;the&nbsp;activity&nbsp;to&nbsp;get&nbsp;the&nbsp;list&nbsp;of&nbsp;people&nbsp;for.&nbsp;(required)<br>
28&nbsp;&nbsp;collection:&nbsp;string,&nbsp;The&nbsp;collection&nbsp;of&nbsp;people&nbsp;to&nbsp;list.&nbsp;(required)<br>
29&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
30&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;plusoners&nbsp;-&nbsp;List&nbsp;all&nbsp;people&nbsp;who&nbsp;have&nbsp;+1'd&nbsp;this&nbsp;activity.<br>
31&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;resharers&nbsp;-&nbsp;List&nbsp;all&nbsp;people&nbsp;who&nbsp;have&nbsp;reshared&nbsp;this&nbsp;activity.</tt></dd></dl>
32
33<dl><dt><a name="Resource-listByActivity_next"><strong>listByActivity_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves&nbsp;the&nbsp;next&nbsp;page&nbsp;of&nbsp;results.<br>
34&nbsp;<br>
35Args:<br>
36&nbsp;&nbsp;previous_request:&nbsp;The&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
37&nbsp;&nbsp;previous_response:&nbsp;The&nbsp;response&nbsp;from&nbsp;the&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
38&nbsp;<br>
39Returns:<br>
40&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>
41&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>
42
43<dl><dt><a name="Resource-search"><strong>search</strong></a> = method(self, **kwargs)</dt><dd><tt>Search&nbsp;all&nbsp;public&nbsp;profiles.<br>
44&nbsp;<br>
45Args:<br>
Joe Gregorioc4fc0952011-11-09 12:21:11 -0500[diff] [blame]46&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>
Joe Gregorio761c4562011-10-28 14:36:24 -0400[diff] [blame]47&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>
48&nbsp;&nbsp;maxResults:&nbsp;integer,&nbsp;The&nbsp;maximum&nbsp;number&nbsp;of&nbsp;people&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>
Joe Gregorioc4fc0952011-11-09 12:21:11 -0500[diff] [blame]49&nbsp;&nbsp;query:&nbsp;string,&nbsp;Full-text&nbsp;search&nbsp;query&nbsp;string.&nbsp;(required)</tt></dd></dl>
Joe Gregorio761c4562011-10-28 14:36:24 -0400[diff] [blame]50
51<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>
52&nbsp;<br>
53Args:<br>
54&nbsp;&nbsp;previous_request:&nbsp;The&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
55&nbsp;&nbsp;previous_response:&nbsp;The&nbsp;response&nbsp;from&nbsp;the&nbsp;request&nbsp;for&nbsp;the&nbsp;previous&nbsp;page.<br>
56&nbsp;<br>
57Returns:<br>
58&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>
59&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>
60
61<hr>
62Data descriptors defined here:<br>
63<dl><dt><strong>__dict__</strong></dt>
64<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
65</dl>
66<dl><dt><strong>__weakref__</strong></dt>
67<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
68</dl>
69</td></tr></table>
70</body></html>