Blame - docs/dyn/orkut.v2.communityMembers.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

17

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

18

19

Args:

20

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

21

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

22

23

<dl><dt><a name="Resource-get">get</a> = method(self, **kwargs)</dt><dd><tt>Retrieves the relationship between a user and a community.

24

25

Args:

26

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

27

hl: string, Specifies the interface language (host language) of your user interface.

28

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

29

30

Returns:

31

An object of the form

32

33

{

34

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

35

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

36

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

37

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

38

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

39

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

40

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

41

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

42

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

43

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

44

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

45

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

46

},

47

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

48

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

49

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

50

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

51

},

52

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

53

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

54

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

55

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

56

},

57

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

58

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

59

},

60

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

61

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

62

63

<dl><dt><a name="Resource-insert">insert</a> = method(self, **kwargs)</dt><dd><tt>Makes the user join a community.

64

65

Args:

66

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

67

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

68

69

Returns:

70

An object of the form

71

72

{

73

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

74

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

75

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

76

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

77

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

78

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

79

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

80

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

81

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

82

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

83

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

84

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

85

},

86

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

87

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

88

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

89

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

90

},

91

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

92

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

93

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

94

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

95

},

96

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

97

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

98

},

99

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

100

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

101

Joe Gregorio

df70dfc

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

[diff] [blame]

102

<dl><dt><a name="Resource-list">list</a> = method(self, **kwargs)</dt><dd><tt>Lists members of a community. Use the pagination tokens to retrieve the full list; do not rely on the member count available in the community profile information to know when to stop iterating, as that count may be approximate.

Joe Gregorio

945cca1

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

[diff] [blame]

103

104

Args:

105

friendsOnly: boolean, Whether to list only community members who are friends of the user.

106

pageToken: string, A continuation token that allows pagination.

107

maxResults: integer, The maximum number of members to include in the response.

108

hl: string, Specifies the interface language (host language) of your user interface.

109

communityId: integer, The ID of the community whose members will be listed. (required)

110

111

Returns:

112

An object of the form

113

114

{

115

"nextPageToken": "A String", # The value of pageToken query parameter in community_members.list request to get the next page, if there are more to retrieve.

116

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

117

"items": [ # List of community members retrieved.

118

{

119

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

120

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

121

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

122

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

123

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

124

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

125

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

126

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

127

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

128

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

129

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

130

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

131

},

132

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

133

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

134

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

135

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

136

},

137

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

138

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

139

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

140

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

141

},

142

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

143

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

144

},

145

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

146

},

147

],

148

"prevPageToken": "A String", # The value of pageToken query parameter in community_members.list request to get the previous page, if there are more to retrieve.

149

"lastPageToken": "A String", # The value of pageToken query parameter in community_members.list request to get the last page.

150

"firstPageToken": "A String", # The value of pageToken query parameter in community_members.list request to get the first page.

151

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

152

153

<dl><dt><a name="Resource-list_next">list_next</a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.

154

155

Args:

156

previous_request: The request for the previous page.

157

previous_response: The response from the request for the previous page.

158

159

Returns:

160

A request object that you can call 'execute()' on to request the next