Class ListMembershipsRequest

Request message for listing memberships.

Inheritance

object

ListMembershipsRequest

Implements

IPageRequest

IMessage<ListMembershipsRequest>

IEquatable<ListMembershipsRequest>

IDeepCloneable<ListMembershipsRequest>

IBufferMessage

IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace: Google.Apps.Chat.V1

Assembly: Google.Apps.Chat.V1.dll

Syntax

public sealed class ListMembershipsRequest : IPageRequest, IMessage<ListMembershipsRequest>, IEquatable<ListMembershipsRequest>, IDeepCloneable<ListMembershipsRequest>, IBufferMessage, IMessage

Constructors

ListMembershipsRequest()

Declaration

public ListMembershipsRequest()

ListMembershipsRequest(ListMembershipsRequest)

Declaration

public ListMembershipsRequest(ListMembershipsRequest other)

Parameters

Type	Name	Description
ListMembershipsRequest	other

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

public string Filter { get; set; }

Property Value

Type	Description
string

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

public int PageSize { get; set; }

Property Value

Type	Description
int

Implements

IPageRequest.PageSize

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

public string PageToken { get; set; }

Property Value

Type	Description
string

Implements

IPageRequest.PageToken

Parent

Required. The resource name of the space for which to fetch a membership list.

Format: spaces/{space}

Declaration

public string Parent { get; set; }

Property Value

Type	Description
string

ParentAsSpaceName

SpaceName-typed view over the Parent resource name property.

Declaration

public SpaceName ParentAsSpaceName { get; set; }

Property Value

Type	Description
SpaceName

ShowGroups

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

Declaration

public bool ShowGroups { get; set; }

Property Value

Type	Description
bool

ShowInvited

Optional. When true, also returns memberships associated with [invited][google.chat.v1.Membership.MembershipState.INVITED] members, in addition to other types of memberships. If a filter is set, [invited][google.chat.v1.Membership.MembershipState.INVITED] memberships that don't match the filter criteria aren't returned.

Currently requires user authentication.

Declaration

public bool ShowInvited { get; set; }

Property Value

Type	Description
bool

UseAdminAccess

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

public bool UseAdminAccess { get; set; }

Property Value

Type	Description
bool