docs/dyn/orkut.v2.communityFollow.html - platform/external/python/google-api-python-client - Gitiles


 <!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-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Removes&nbsp;an&nbsp;user&nbsp;from&nbsp;the&nbsp;followers&nbsp;of&nbsp;a&nbsp;community.<br>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;userId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;user.&nbsp;(required)<br>
 &nbsp;&nbsp;communityId:&nbsp;integer,&nbsp;ID&nbsp;of&nbsp;the&nbsp;community.&nbsp;(required)</tt></dd></dl>

 <dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Adds&nbsp;an&nbsp;user&nbsp;as&nbsp;a&nbsp;follower&nbsp;of&nbsp;a&nbsp;community.<br>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;userId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;user.&nbsp;(required)<br>
 &nbsp;&nbsp;communityId:&nbsp;integer,&nbsp;ID&nbsp;of&nbsp;the&nbsp;community.&nbsp;(required)<br>
 &nbsp;<br>
 Returns:<br>
 &nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
 &nbsp;<br>
 &nbsp;&nbsp;&nbsp;&nbsp;{<br>
 &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>
 &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>
 &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>
 &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>
 &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>
 &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>
 &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>
 &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>
 &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>
 &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>
 &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>
 &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>
 &nbsp;&nbsp;&nbsp;&nbsp;},<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"person":&nbsp;{&nbsp;#&nbsp;Description&nbsp;of&nbsp;the&nbsp;community&nbsp;member.<br>
 &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>
 &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>
 &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>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
 &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>
 &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>
 &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>
 &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>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
 &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>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;person's&nbsp;opensocial&nbsp;ID.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;},<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"orkut#communityMembers",&nbsp;#&nbsp;Kind&nbsp;of&nbsp;this&nbsp;item.&nbsp;Always&nbsp;orkut#communityMembers.<br>
 &nbsp;&nbsp;}</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>

	<!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> <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>   </tt></td>
	<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
	<tr><td> </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-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Removes an user from the followers of a community.<br>
	<br>
	Args:<br>
	userId: string, ID of the user. (required)<br>
	communityId: integer, ID of the community. (required)</tt></dd></dl>

	<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Adds an user as a follower of a community.<br>
	<br>
	Args:<br>
	userId: string, ID of the user. (required)<br>
	communityId: integer, ID of the community. (required)<br>
	<br>
	Returns:<br>
	An object of the form<br>
	<br>
	{<br>
	"communityMembershipStatus": { # Status and permissions of the user related to the community.<br>
	"status": "A String", # The status of the current link between the community and the user.<br>
	"isFollowing": True or False, # Whether the user is following this community.<br>
	"isRestoreAvailable": True or False, # Whether the restore operation is available for the community.<br>
	"isModerator": True or False, # Whether the session user is a community moderator.<br>
	"kind": "orkut#communityMembershipStatus", # Kind of this item. Always orkut#communityMembershipStatus.<br>
	"isCoOwner": True or False, # Whether the session user is a community co-owner.<br>
	"canCreatePoll": True or False, # Whether the user can create a poll in this community.<br>
	"canShout": True or False, # Whether the user can perform a shout operation in this community.<br>
	"isOwner": True or False, # Whether the session user is the community owner.<br>
	"canCreateTopic": True or False, # Whether the user can create a topic in this community.<br>
	"isTakebackAvailable": True or False, # Whether the take-back operation is available for the community.<br>
	},<br>
	"person": { # Description of the community member.<br>
	"name": { # An object that encapsulates the individual components of a person's name.<br>
	"givenName": "A String", # The given name (first name) of this person.<br>
	"familyName": "A String", # The family name (last name) of this person.<br>
	},<br>
	"url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.<br>
	"gender": "A String", # The person's gender. Values include "male", "female", and "other".<br>
	"image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.<br>
	"url": "A String", # The URL of the person's profile photo.<br>
	},<br>
	"birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.<br>
	"id": "A String", # The person's opensocial ID.<br>
	},<br>
	"kind": "orkut#communityMembers", # Kind of this item. Always orkut#communityMembers.<br>
	}</tt></dd></dl>

	<hr>
	Data descriptors defined here:<br>
	<dl><dt><strong>__dict__</strong></dt>
	<dd><tt>dictionary for instance variables (if defined)</tt></dd>
	</dl>
	<dl><dt><strong>__weakref__</strong></dt>
	<dd><tt>list of weak references to the object (if defined)</tt></dd>
	</dl>
	</td></tr></table>
	</body></html>