Show / Hide Table of Contents

Class SpacesResource.SpaceEventsResource.ListRequest

Lists events from a Google Chat space. For each event, the payload contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns Membership resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty Membership resource. Requires user authentication with an authorization scope appropriate for reading the requested data: - https://www.googleapis.com/auth/chat.spaces.readonly - https://www.googleapis.com/auth/chat.spaces - https://www.googleapis.com/auth/chat.messages.readonly

  • https://www.googleapis.com/auth/chat.messages - https://www.googleapis.com/auth/chat.messages.reactions.readonly - https://www.googleapis.com/auth/chat.messages.reactions - https://www.googleapis.com/auth/chat.memberships.readonly - https://www.googleapis.com/auth/chat.memberships To list events, the authenticated user must be a member of the space. For an example, see List events from a Google Chat space.
Inheritance
object
ClientServiceRequest
ClientServiceRequest<ListSpaceEventsResponse>
HangoutsChatBaseServiceRequest<ListSpaceEventsResponse>
SpacesResource.SpaceEventsResource.ListRequest
Implements
IClientServiceRequest<ListSpaceEventsResponse>
IClientServiceRequest
Inherited Members
HangoutsChatBaseServiceRequest<ListSpaceEventsResponse>.Xgafv
HangoutsChatBaseServiceRequest<ListSpaceEventsResponse>.AccessToken
HangoutsChatBaseServiceRequest<ListSpaceEventsResponse>.Alt
HangoutsChatBaseServiceRequest<ListSpaceEventsResponse>.Callback
HangoutsChatBaseServiceRequest<ListSpaceEventsResponse>.Fields
HangoutsChatBaseServiceRequest<ListSpaceEventsResponse>.Key
HangoutsChatBaseServiceRequest<ListSpaceEventsResponse>.OauthToken
HangoutsChatBaseServiceRequest<ListSpaceEventsResponse>.PrettyPrint
HangoutsChatBaseServiceRequest<ListSpaceEventsResponse>.QuotaUser
HangoutsChatBaseServiceRequest<ListSpaceEventsResponse>.UploadType
HangoutsChatBaseServiceRequest<ListSpaceEventsResponse>.UploadProtocol
ClientServiceRequest<ListSpaceEventsResponse>.Execute()
ClientServiceRequest<ListSpaceEventsResponse>.ExecuteAsStream()
ClientServiceRequest<ListSpaceEventsResponse>.ExecuteAsync()
ClientServiceRequest<ListSpaceEventsResponse>.ExecuteAsync(CancellationToken)
ClientServiceRequest<ListSpaceEventsResponse>.ExecuteAsStreamAsync()
ClientServiceRequest<ListSpaceEventsResponse>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<ListSpaceEventsResponse>.CreateRequest(bool?)
ClientServiceRequest<ListSpaceEventsResponse>.GenerateRequestUri()
ClientServiceRequest<ListSpaceEventsResponse>.GetBody()
ClientServiceRequest<ListSpaceEventsResponse>.GetDefaultETagAction(string)
ClientServiceRequest<ListSpaceEventsResponse>.ETagAction
ClientServiceRequest<ListSpaceEventsResponse>.ModifyRequest
ClientServiceRequest<ListSpaceEventsResponse>.ValidateParameters
ClientServiceRequest<ListSpaceEventsResponse>.ApiVersion
ClientServiceRequest<ListSpaceEventsResponse>.RequestParameters
ClientServiceRequest<ListSpaceEventsResponse>.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.SpaceEventsResource.ListRequest : HangoutsChatBaseServiceRequest<ListSpaceEventsResponse>, IClientServiceRequest<ListSpaceEventsResponse>, 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

Required. A query filter. You must specify at least one event type (event_type) using the has : operator. To filter by multiple event types, use the OR operator. Omit batch event types in your filter. The request automatically returns any related batch events. For example, if you filter by new reactions (google.workspace.chat.reaction.v1.created), the server also returns batch new reactions events (google.workspace.chat.reaction.v1.batchCreated). For a list of supported event types, see the SpaceEvents reference documentation. Optionally, you can also filter by start time (start_time) and end time (end_time): * start_time: Exclusive timestamp from which to start listing space events. You can list events that occurred up to 28 days ago. If unspecified, lists space events from the past 28 days. * end_time: Inclusive timestamp until which space events are listed. If unspecified, lists events up to the time of the request. To specify a start or end time, use the equals = operator and format in RFC-3339. To filter by both start_time and end_time, use the AND operator. For example, the following queries are valid:

start_time="2023-08-23T19:20:33+00:00" AND end_time="2023-08-23T19:21:54+00:00"
start_time="2023-08-23T19:20:33+00:00" AND (event_types:"google.workspace.chat.space.v1.updated" OR
event_types:"google.workspace.chat.message.v1.created")

The following queries are invalid:

start_time="2023-08-23T19:20:33+00:00" OR end_time="2023-08-23T19:21:54+00:00"
event_types:"google.workspace.chat.space.v1.updated" AND
event_types:"google.workspace.chat.message.v1.created"

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
ClientServiceRequest<ListSpaceEventsResponse>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<ListSpaceEventsResponse>.MethodName

PageSize

Optional. The maximum number of space events returned. The service might return fewer than this value. 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 list space events call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to list space events must 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. Resource name of the Google Chat space where the events occurred. 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
ClientServiceRequest<ListSpaceEventsResponse>.RestPath

Methods

InitParameters()

Initializes List parameter list.

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

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In this article
Back to top Generated by DocFX