|
Methods defined here:
- __init__(self)
- delete = method(self, **kwargs)
- Makes the user leave a community.
Args:
userId: string, ID of the user. (required)
communityId: integer, ID of the community. (required)
- get = method(self, **kwargs)
- Retrieves the relationship between a user and a community.
Args:
userId: string, ID of the user. (required)
hl: string, Specifies the interface language (host language) of your user interface.
communityId: integer, ID of the community. (required)
Returns:
An object of the form
{
"communityMembershipStatus": { # Status and permissions of the user related to the community.
"status": "A String", # The status of the current link between the community and the user.
"isFollowing": True or False, # Whether the user is following this community.
"isRestoreAvailable": True or False, # Whether the restore operation is available for the community.
"isModerator": True or False, # Whether the session user is a community moderator.
"kind": "orkut#communityMembershipStatus", # Kind of this item. Always orkut#communityMembershipStatus.
"isCoOwner": True or False, # Whether the session user is a community co-owner.
"canCreatePoll": True or False, # Whether the user can create a poll in this community.
"canShout": True or False, # Whether the user can perform a shout operation in this community.
"isOwner": True or False, # Whether the session user is the community owner.
"canCreateTopic": True or False, # Whether the user can create a topic in this community.
"isTakebackAvailable": True or False, # Whether the take-back operation is available for the community.
},
"person": { # Description of the community member.
"name": { # An object that encapsulates the individual components of a person's name.
"givenName": "A String", # The given name (first name) of this person.
"familyName": "A String", # The family name (last name) of this person.
},
"url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
"gender": "A String", # The person's gender. Values include "male", "female", and "other".
"image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
"url": "A String", # The URL of the person's profile photo.
},
"birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
"id": "A String", # The person's opensocial ID.
},
"kind": "orkut#communityMembers", # Kind of this item. Always orkut#communityMembers.
}
- insert = method(self, **kwargs)
- Makes the user join a community.
Args:
userId: string, ID of the user. (required)
communityId: integer, ID of the community. (required)
Returns:
An object of the form
{
"communityMembershipStatus": { # Status and permissions of the user related to the community.
"status": "A String", # The status of the current link between the community and the user.
"isFollowing": True or False, # Whether the user is following this community.
"isRestoreAvailable": True or False, # Whether the restore operation is available for the community.
"isModerator": True or False, # Whether the session user is a community moderator.
"kind": "orkut#communityMembershipStatus", # Kind of this item. Always orkut#communityMembershipStatus.
"isCoOwner": True or False, # Whether the session user is a community co-owner.
"canCreatePoll": True or False, # Whether the user can create a poll in this community.
"canShout": True or False, # Whether the user can perform a shout operation in this community.
"isOwner": True or False, # Whether the session user is the community owner.
"canCreateTopic": True or False, # Whether the user can create a topic in this community.
"isTakebackAvailable": True or False, # Whether the take-back operation is available for the community.
},
"person": { # Description of the community member.
"name": { # An object that encapsulates the individual components of a person's name.
"givenName": "A String", # The given name (first name) of this person.
"familyName": "A String", # The family name (last name) of this person.
},
"url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
"gender": "A String", # The person's gender. Values include "male", "female", and "other".
"image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
"url": "A String", # The URL of the person's profile photo.
},
"birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
"id": "A String", # The person's opensocial ID.
},
"kind": "orkut#communityMembers", # Kind of this item. Always orkut#communityMembers.
}
- list = method(self, **kwargs)
- Lists members of a community.
Args:
friendsOnly: boolean, Whether to list only community members who are friends of the user.
pageToken: string, A continuation token that allows pagination.
maxResults: integer, The maximum number of members to include in the response.
hl: string, Specifies the interface language (host language) of your user interface.
communityId: integer, The ID of the community whose members will be listed. (required)
Returns:
An object of the form
{
"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.
"kind": "orkut#communityMembersList", # Kind of this item. Always orkut#communityMembersList.
"items": [ # List of community members retrieved.
{
"communityMembershipStatus": { # Status and permissions of the user related to the community.
"status": "A String", # The status of the current link between the community and the user.
"isFollowing": True or False, # Whether the user is following this community.
"isRestoreAvailable": True or False, # Whether the restore operation is available for the community.
"isModerator": True or False, # Whether the session user is a community moderator.
"kind": "orkut#communityMembershipStatus", # Kind of this item. Always orkut#communityMembershipStatus.
"isCoOwner": True or False, # Whether the session user is a community co-owner.
"canCreatePoll": True or False, # Whether the user can create a poll in this community.
"canShout": True or False, # Whether the user can perform a shout operation in this community.
"isOwner": True or False, # Whether the session user is the community owner.
"canCreateTopic": True or False, # Whether the user can create a topic in this community.
"isTakebackAvailable": True or False, # Whether the take-back operation is available for the community.
},
"person": { # Description of the community member.
"name": { # An object that encapsulates the individual components of a person's name.
"givenName": "A String", # The given name (first name) of this person.
"familyName": "A String", # The family name (last name) of this person.
},
"url": "A String", # The person's profile url. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
"gender": "A String", # The person's gender. Values include "male", "female", and "other".
"image": { # The person's profile photo. This is adapted from Google+ and was originaly introduced as extra OpenSocial convenience fields.
"url": "A String", # The URL of the person's profile photo.
},
"birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.
"id": "A String", # The person's opensocial ID.
},
"kind": "orkut#communityMembers", # Kind of this item. Always orkut#communityMembers.
},
],
"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.
"lastPageToken": "A String", # The value of pageToken query parameter in community_members.list request to get the last page.
"firstPageToken": "A String", # The value of pageToken query parameter in community_members.list request to get the first page.
}
- list_next = methodNext(self, previous_request, previous_response)
- Retrieves the next page of results.
Args:
previous_request: The request for the previous page.
previous_response: The response from the request for the previous page.
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
|