blob: 5e51c46f22663e40da2c7476a7d46ada38253dd2 [file] [log] [blame]
Joe Gregorio945cca12012-02-21 11:59:48 -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
Joe Gregoriodf70dfc2012-04-23 08:31:37 -040017<dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Removes&nbsp;a&nbsp;user&nbsp;from&nbsp;the&nbsp;followers&nbsp;of&nbsp;a&nbsp;community.<br>
Joe Gregorio945cca12012-02-21 11:59:48 -050018&nbsp;<br>
19Args:<br>
20&nbsp;&nbsp;userId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;user.&nbsp;(required)<br>
21&nbsp;&nbsp;communityId:&nbsp;integer,&nbsp;ID&nbsp;of&nbsp;the&nbsp;community.&nbsp;(required)</tt></dd></dl>
22
Joe Gregoriodf70dfc2012-04-23 08:31:37 -040023<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Adds&nbsp;a&nbsp;user&nbsp;as&nbsp;a&nbsp;follower&nbsp;of&nbsp;a&nbsp;community.<br>
Joe Gregorio945cca12012-02-21 11:59:48 -050024&nbsp;<br>
25Args:<br>
26&nbsp;&nbsp;userId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;user.&nbsp;(required)<br>
27&nbsp;&nbsp;communityId:&nbsp;integer,&nbsp;ID&nbsp;of&nbsp;the&nbsp;community.&nbsp;(required)<br>
28&nbsp;<br>
29Returns:<br>
30&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
31&nbsp;<br>
32&nbsp;&nbsp;&nbsp;&nbsp;{<br>
33&nbsp;&nbsp;&nbsp;&nbsp;"communityMembershipStatus":&nbsp;{&nbsp;#&nbsp;Status&nbsp;and&nbsp;permissions&nbsp;of&nbsp;the&nbsp;user&nbsp;related&nbsp;to&nbsp;the&nbsp;community.<br>
34&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"status":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;status&nbsp;of&nbsp;the&nbsp;current&nbsp;link&nbsp;between&nbsp;the&nbsp;community&nbsp;and&nbsp;the&nbsp;user.<br>
35&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"isFollowing":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Whether&nbsp;the&nbsp;user&nbsp;is&nbsp;following&nbsp;this&nbsp;community.<br>
36&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"isRestoreAvailable":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Whether&nbsp;the&nbsp;restore&nbsp;operation&nbsp;is&nbsp;available&nbsp;for&nbsp;the&nbsp;community.<br>
37&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"isModerator":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Whether&nbsp;the&nbsp;session&nbsp;user&nbsp;is&nbsp;a&nbsp;community&nbsp;moderator.<br>
38&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"orkut#communityMembershipStatus",&nbsp;#&nbsp;Kind&nbsp;of&nbsp;this&nbsp;item.&nbsp;Always&nbsp;orkut#communityMembershipStatus.<br>
39&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"isCoOwner":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Whether&nbsp;the&nbsp;session&nbsp;user&nbsp;is&nbsp;a&nbsp;community&nbsp;co-owner.<br>
40&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"canCreatePoll":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Whether&nbsp;the&nbsp;user&nbsp;can&nbsp;create&nbsp;a&nbsp;poll&nbsp;in&nbsp;this&nbsp;community.<br>
41&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"canShout":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Whether&nbsp;the&nbsp;user&nbsp;can&nbsp;perform&nbsp;a&nbsp;shout&nbsp;operation&nbsp;in&nbsp;this&nbsp;community.<br>
42&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"isOwner":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Whether&nbsp;the&nbsp;session&nbsp;user&nbsp;is&nbsp;the&nbsp;community&nbsp;owner.<br>
43&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"canCreateTopic":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Whether&nbsp;the&nbsp;user&nbsp;can&nbsp;create&nbsp;a&nbsp;topic&nbsp;in&nbsp;this&nbsp;community.<br>
44&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"isTakebackAvailable":&nbsp;True&nbsp;or&nbsp;False,&nbsp;#&nbsp;Whether&nbsp;the&nbsp;take-back&nbsp;operation&nbsp;is&nbsp;available&nbsp;for&nbsp;the&nbsp;community.<br>
45&nbsp;&nbsp;&nbsp;&nbsp;},<br>
46&nbsp;&nbsp;&nbsp;&nbsp;"person":&nbsp;{&nbsp;#&nbsp;Description&nbsp;of&nbsp;the&nbsp;community&nbsp;member.<br>
47&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&nbsp;{&nbsp;#&nbsp;An&nbsp;object&nbsp;that&nbsp;encapsulates&nbsp;the&nbsp;individual&nbsp;components&nbsp;of&nbsp;a&nbsp;person's&nbsp;name.<br>
48&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"givenName":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;given&nbsp;name&nbsp;(first&nbsp;name)&nbsp;of&nbsp;this&nbsp;person.<br>
49&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"familyName":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;family&nbsp;name&nbsp;(last&nbsp;name)&nbsp;of&nbsp;this&nbsp;person.<br>
50&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
51&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;person's&nbsp;profile&nbsp;url.&nbsp;This&nbsp;is&nbsp;adapted&nbsp;from&nbsp;Google+&nbsp;and&nbsp;was&nbsp;originaly&nbsp;introduced&nbsp;as&nbsp;extra&nbsp;OpenSocial&nbsp;convenience&nbsp;fields.<br>
52&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gender":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;person's&nbsp;gender.&nbsp;Values&nbsp;include&nbsp;"male",&nbsp;"female",&nbsp;and&nbsp;"other".<br>
53&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"image":&nbsp;{&nbsp;#&nbsp;The&nbsp;person's&nbsp;profile&nbsp;photo.&nbsp;This&nbsp;is&nbsp;adapted&nbsp;from&nbsp;Google+&nbsp;and&nbsp;was&nbsp;originaly&nbsp;introduced&nbsp;as&nbsp;extra&nbsp;OpenSocial&nbsp;convenience&nbsp;fields.<br>
54&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;URL&nbsp;of&nbsp;the&nbsp;person's&nbsp;profile&nbsp;photo.<br>
55&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
56&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"birthday":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;person's&nbsp;date&nbsp;of&nbsp;birth,&nbsp;represented&nbsp;as&nbsp;YYYY-MM-DD.<br>
57&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;person's&nbsp;opensocial&nbsp;ID.<br>
58&nbsp;&nbsp;&nbsp;&nbsp;},<br>
59&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"orkut#communityMembers",&nbsp;#&nbsp;Kind&nbsp;of&nbsp;this&nbsp;item.&nbsp;Always&nbsp;orkut#communityMembers.<br>
60&nbsp;&nbsp;}</tt></dd></dl>
61
62<hr>
63Data descriptors defined here:<br>
64<dl><dt><strong>__dict__</strong></dt>
65<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
66</dl>
67<dl><dt><strong>__weakref__</strong></dt>
68<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
69</dl>
70</td></tr></table>
71</body></html>