Google Chat API . spaces . members

Instance Methods

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Returns a membership.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists human memberships in a space.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
get(name, x__xgafv=None)
Returns a membership.

Args:
  name: string, Required. Resource name of the membership to be retrieved, in the form "spaces/*/members/*". Example: spaces/AAAAMpdlehY/members/105115627578887013105 (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a membership relation in Hangouts Chat.
  "createTime": "A String", # The creation time of the membership a.k.a the time at which the member joined the space, if applicable.
  "member": { # A user in Google Chat. # A User in Hangout Chat
    "displayName": "A String", # The user's display name.
    "domainId": "A String", # Obfuscated domain information.
    "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible.
    "name": "A String", # Resource name, in the format "users/*".
    "type": "A String", # User type.
  },
  "name": "A String",
  "state": "A String", # State of the membership.
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists human memberships in a space.

Args:
  parent: string, Required. The resource name of the space for which membership list is to be fetched, in the form "spaces/*". Example: spaces/AAAAMpdlehY (required)
  pageSize: integer, Requested page size. The value is capped at 1000. Server may return fewer results than requested. If unspecified, server will default to 100.
  pageToken: string, A token identifying a page of results the server should return.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "memberships": [ # List of memberships in the requested (or first) page.
    { # Represents a membership relation in Hangouts Chat.
      "createTime": "A String", # The creation time of the membership a.k.a the time at which the member joined the space, if applicable.
      "member": { # A user in Google Chat. # A User in Hangout Chat
        "displayName": "A String", # The user's display name.
        "domainId": "A String", # Obfuscated domain information.
        "isAnonymous": True or False, # True when the user is deleted or the user's profile is not visible.
        "name": "A String", # Resource name, in the format "users/*".
        "type": "A String", # User type.
      },
      "name": "A String",
      "state": "A String", # State of the membership.
    },
  ],
  "nextPageToken": "A String", # Continuation token to retrieve the next page of results. It will be empty for the last page of results.
}
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.