Show / Hide Table of Contents

Class SpacesResource.MembersResource.ListRequest

Lists memberships in a space. For an example, see List memberships. 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. Requires authentication. Fully supports service account authentication and user authentication. User authentication requires the chat.memberships or chat.memberships.readonly authorization scope.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ListMembershipsResponse>
HangoutsChatBaseServiceRequest<ListMembershipsResponse>
SpacesResource.MembersResource.ListRequest
Implements
IClientServiceRequest<ListMembershipsResponse>
IClientServiceRequest
Inherited Members
HangoutsChatBaseServiceRequest<ListMembershipsResponse>.Xgafv
HangoutsChatBaseServiceRequest<ListMembershipsResponse>.AccessToken
HangoutsChatBaseServiceRequest<ListMembershipsResponse>.Alt
HangoutsChatBaseServiceRequest<ListMembershipsResponse>.Callback
HangoutsChatBaseServiceRequest<ListMembershipsResponse>.Fields
HangoutsChatBaseServiceRequest<ListMembershipsResponse>.Key
HangoutsChatBaseServiceRequest<ListMembershipsResponse>.OauthToken
HangoutsChatBaseServiceRequest<ListMembershipsResponse>.PrettyPrint
HangoutsChatBaseServiceRequest<ListMembershipsResponse>.QuotaUser
HangoutsChatBaseServiceRequest<ListMembershipsResponse>.UploadType
HangoutsChatBaseServiceRequest<ListMembershipsResponse>.UploadProtocol
ClientServiceRequest<ListMembershipsResponse>.Execute()
ClientServiceRequest<ListMembershipsResponse>.ExecuteAsStream()
ClientServiceRequest<ListMembershipsResponse>.ExecuteAsync()
ClientServiceRequest<ListMembershipsResponse>.ExecuteAsync(CancellationToken)
ClientServiceRequest<ListMembershipsResponse>.ExecuteAsStreamAsync()
ClientServiceRequest<ListMembershipsResponse>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<ListMembershipsResponse>.CreateRequest(bool?)
ClientServiceRequest<ListMembershipsResponse>.GenerateRequestUri()
ClientServiceRequest<ListMembershipsResponse>.GetBody()
ClientServiceRequest<ListMembershipsResponse>.GetDefaultETagAction(string)
ClientServiceRequest<ListMembershipsResponse>.ETagAction
ClientServiceRequest<ListMembershipsResponse>.ModifyRequest
ClientServiceRequest<ListMembershipsResponse>.ValidateParameters
ClientServiceRequest<ListMembershipsResponse>.RequestParameters
ClientServiceRequest<ListMembershipsResponse>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
ClientServiceRequest.Credential
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
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. To filter by both role and type, use the AND operator. To filter by either role or type, use the OR operator. For example, the following queries are valid:

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

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
Google.Apis.Requests.ClientServiceRequest<Google.Apis.HangoutsChat.v1.Data.ListMembershipsResponse>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.HangoutsChat.v1.Data.ListMembershipsResponse>.MethodName

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 1,000. If you use a value more than 1,000, it's automatically changed to 1,000. 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
Google.Apis.Requests.ClientServiceRequest<Google.Apis.HangoutsChat.v1.Data.ListMembershipsResponse>.RestPath

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?

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides
HangoutsChatBaseServiceRequest<ListMembershipsResponse>.InitParameters()

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In This Article
Back to top Generated by DocFX