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

Joe Gregorio

945cca1

2012-02-21 11:59:48 -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">

<a name="Resource">class Resource</a>(<a href="__builtin__.html#object">__builtin__.object</a>)</td></tr>

10

11

12

<td colspan=2><tt>A class for interacting with a resource.  </tt></td></tr>

13

14

<td width="100%">Methods defined here:

15

16

Joe Gregorio

df70dfc

2012-04-23 08:31:37 -0400

[diff] [blame]

17

<dl><dt><a name="Resource-delete">delete</a> = method(self, **kwargs)</dt><dd><tt>Removes a user from the followers of a community.

Joe Gregorio

945cca1

2012-02-21 11:59:48 -0500

[diff] [blame]

18

19

Args:

20

userId: string, ID of the user. (required)

21

communityId: integer, ID of the community. (required)</tt></dd></dl>

22

Joe Gregorio

df70dfc

2012-04-23 08:31:37 -0400

[diff] [blame]

23

<dl><dt><a name="Resource-insert">insert</a> = method(self, **kwargs)</dt><dd><tt>Adds a user as a follower of a community.

Joe Gregorio

945cca1

2012-02-21 11:59:48 -0500

[diff] [blame]

24

25

Args:

26

userId: string, ID of the user. (required)

27

communityId: integer, ID of the community. (required)

28

29

Returns:

30

An object of the form

31

32

{

33

"communityMembershipStatus": { # Status and permissions of the user related to the community.

34

"status": "A String", # The status of the current link between the community and the user.

35

"isFollowing": True or False, # Whether the user is following this community.

36

"isRestoreAvailable": True or False, # Whether the restore operation is available for the community.

37

"isModerator": True or False, # Whether the session user is a community moderator.

38

"kind": "orkut#communityMembershipStatus", # Kind of this item. Always orkut#communityMembershipStatus.

39

"isCoOwner": True or False, # Whether the session user is a community co-owner.

40

"canCreatePoll": True or False, # Whether the user can create a poll in this community.

41

"canShout": True or False, # Whether the user can perform a shout operation in this community.

42

"isOwner": True or False, # Whether the session user is the community owner.

43

"canCreateTopic": True or False, # Whether the user can create a topic in this community.

44

"isTakebackAvailable": True or False, # Whether the take-back operation is available for the community.

45

},

46

"person": { # Description of the community member.

47

"name": { # An object that encapsulates the individual components of a person's name.

48

"givenName": "A String", # The given name (first name) of this person.

49

"familyName": "A String", # The family name (last name) of this person.

50

},

51

"url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.

52

"gender": "A String", # The person's gender. Values include "male", "female", and "other".

53

"image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.

54

"url": "A String", # The URL of the person's profile photo.

55

},

56

"birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.

57

"id": "A String", # The person's opensocial ID.

58

},

59

"kind": "orkut#communityMembers", # Kind of this item. Always orkut#communityMembers.

}</tt></dd></dl>

<hr>

Data descriptors defined here:

64

65

<dd><tt>dictionary for instance variables (if defined)</tt></dd>

66

</dl>

67

<dl><dt>__weakref__</dt>

68

<dd><tt>list of weak references to the object (if defined)</tt></dd>

69

</dl>

70

</td></tr></table>

71

</body></html>