Class SpacesResource.MembersResource.ListRequest

Lists memberships in a space. For an example, see List users and Google Chat apps in a space. Listing memberships with app authentication lists memberships in spaces that the Chat app has access to, but excludes Chat app memberships, including its own. Listing memberships with User authentication lists memberships in spaces that the authenticated user has access to. Supports the following types of authentication: - App authentication with the authorization scope: - https://www.googleapis.com/auth/chat.bot - User authentication with one of the following authorization scopes: - https://www.googleapis.com/auth/chat.memberships.readonly - https://www.googleapis.com/auth/chat.memberships - https://www.googleapis.com/auth/chat.import (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, use_admin_access is true, and one of the following authorization scopes is used: - https://www.googleapis.com/auth/chat.admin.memberships.readonly - https://www.googleapis.com/auth/chat.admin.memberships

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ListMembershipsResponse>
HangoutsChatBaseServiceRequest<ListMembershipsResponse>
SpacesResource.MembersResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.HangoutsChat.v1
Assembly: Google.Apis.HangoutsChat.v1.dll
Syntax
public class SpacesResource.MembersResource.ListRequest : HangoutsChatBaseServiceRequest<ListMembershipsResponse>, IClientServiceRequest<ListMembershipsResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, string)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, string parent)
Parameters
Type Name Description
IClientService service
string parent

Properties

Filter

Optional. A query filter. You can filter memberships by a member's role (role) and type (member.type). To filter by role, set role to ROLE_MEMBER or ROLE_MANAGER. To filter by type, set member.type to HUMAN or BOT. You can also filter for member.type using the != operator. To filter by both role and type, use the AND operator. To filter by either role or type, use the OR operator. Either member.type = "HUMAN" or member.type != "BOT" is required when use_admin_access is set to true. Other member type filters will be rejected. For example, the following queries are valid:

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER" member.type = "HUMAN" AND role = "ROLE_MANAGER"
member.type != "BOT"

The following queries are invalid:

member.type = "HUMAN" AND
member.type = "BOT" role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

Invalid queries are rejected by the server with an INVALID_ARGUMENT error.

Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
Type Description
string

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

PageSize

Optional. The maximum number of memberships to return. The service might return fewer than this value. If unspecified, at most 100 memberships are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an INVALID_ARGUMENT error.

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

Optional. A page token, received from a previous call to list memberships. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

Parent

Required. The resource name of the space for which to fetch a membership list. Format: spaces/{space}

Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

ShowGroups

Optional. When true, also returns memberships associated with a Google Group, in addition to other types of memberships. If a filter is set, Google Group memberships that don't match the filter criteria aren't returned.

Declaration
[RequestParameter("showGroups", RequestParameterType.Query)]
public virtual bool? ShowGroups { get; set; }
Property Value
Type Description
bool?

ShowInvited

Optional. When true, also returns memberships associated with invited members, in addition to other types of memberships. If a filter is set, invited memberships that don't match the filter criteria aren't returned. Currently requires user authentication.

Declaration
[RequestParameter("showInvited", RequestParameterType.Query)]
public virtual bool? ShowInvited { get; set; }
Property Value
Type Description
bool?

UseAdminAccess

Optional. When true, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege. Requires either the chat.admin.memberships.readonly or chat.admin.memberships OAuth 2.0 scope. Listing app memberships in a space isn't supported when using admin access.

Declaration
[RequestParameter("useAdminAccess", RequestParameterType.Query)]
public virtual bool? UseAdminAccess { get; set; }
Property Value
Type Description
bool?

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements