# Orkut API . communityMembers

## Instance Methods

Makes the user leave a community.

Retrieves the relationship between a user and a community.

Makes the user join a community.

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.

Retrieves the next page of results.

### Method Details

`delete(communityId, userId)`

    Makes the user leave a community.

    Args:
      communityId: integer, ID of the community. (required)
      userId: string, ID of the user. (required)

`get(communityId, userId, hl=None)`

    Retrieves the relationship between a user and a community.

    Args:
      communityId: integer, ID of the community. (required)
      userId: string, ID of the user. (required)
      hl: string, Specifies the interface language (host language) of your user interface.

    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(communityId, userId)`

    Makes the user join a community.

    Args:
      communityId: integer, ID of the community. (required)
      userId: string, ID of the user. (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(communityId, friendsOnly=None, pageToken=None, hl=None, maxResults=None)`

    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.

    Args:
      communityId: integer, The ID of the community whose members will be listed. (required)
      friendsOnly: boolean, Whether to list only community members who are friends of the user.
      pageToken: string, A continuation token that allows pagination.
      hl: string, Specifies the interface language (host language) of your user interface.
      maxResults: integer, The maximum number of members to include in the response.

    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(previous_request, previous_response)`

    Retrieves the next page of results.

    Args:
      previous_request: The request for the previous page. (required)
      previous_response: The response from the request for the previous page. (required)

    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.