Class EventsResource.ListRequest

Returns events on the specified calendar.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<Events>
CalendarBaseServiceRequest<Events>
EventsResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.Calendar.v3
Assembly: Google.Apis.Calendar.v3.dll
Syntax
public class EventsResource.ListRequest : CalendarBaseServiceRequest<Events>, IClientServiceRequest<Events>, IClientServiceRequest

Constructors

ListRequest(IClientService, string)

Constructs a new List request.

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

Properties

AlwaysIncludeEmail

Deprecated and ignored.

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

CalendarId

Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

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

EventTypes

Event types to return. Optional. This parameter can be repeated multiple times to return events of different types. If unset, returns all event types.

Declaration
[RequestParameter("eventTypes", RequestParameterType.Query)]
public virtual EventsResource.ListRequest.EventTypesEnum? EventTypes { get; set; }
Property Value
Type Description
EventsResource.ListRequest.EventTypesEnum?
Remarks

Use this property to set a single value for the parameter, or EventTypesList to set multiple values. Do not set both properties.

EventTypesList

Event types to return. Optional. This parameter can be repeated multiple times to return events of different types. If unset, returns all event types.

Declaration
[RequestParameter("eventTypes", RequestParameterType.Query)]
public virtual Repeatable<EventsResource.ListRequest.EventTypesEnum> EventTypesList { get; set; }
Property Value
Type Description
Repeatable<EventsResource.ListRequest.EventTypesEnum>
Remarks

Use this property to set one or more values for the parameter. Do not set both this property and EventTypes.

HttpMethod

Gets the HTTP method.

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

ICalUID

Specifies an event ID in the iCalendar format to be provided in the response. Optional. Use this if you want to search for an event by its iCalendar ID.

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

MaxAttendees

The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

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

MaxResults

Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.

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

MethodName

Gets the method name.

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

OrderBy

The order of the events returned in the result. Optional. The default is an unspecified, stable order.

Declaration
[RequestParameter("orderBy", RequestParameterType.Query)]
public virtual EventsResource.ListRequest.OrderByEnum? OrderBy { get; set; }
Property Value
Type Description
EventsResource.ListRequest.OrderByEnum?

PageToken

Token specifying which result page to return. Optional.

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

PrivateExtendedProperty

Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.

Declaration
[RequestParameter("privateExtendedProperty", RequestParameterType.Query)]
public virtual Repeatable<string> PrivateExtendedProperty { get; set; }
Property Value
Type Description
Repeatable<string>

Q

Free text search terms to find events that match these terms in the following fields: - summary - description - location - attendee's displayName - attendee's email - organizer's displayName - organizer's email - workingLocationProperties.officeLocation.buildingId - workingLocationProperties.officeLocation.deskId - workingLocationProperties.officeLocation.label - workingLocationProperties.customLocation.label These search terms also match predefined keywords against all display title translations of working location, out-of-office, and focus-time events. For example, searching for "Office" or "Bureau" returns working location events of type officeLocation, whereas searching for "Out of office" or "Abwesend" returns out-of-office events. Optional.

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

RestPath

Gets the REST path.

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

SharedExtendedProperty

Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.

Declaration
[RequestParameter("sharedExtendedProperty", RequestParameterType.Query)]
public virtual Repeatable<string> SharedExtendedProperty { get; set; }
Property Value
Type Description
Repeatable<string>

ShowDeleted

Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.

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

ShowHiddenInvitations

Whether to include hidden invitations in the result. Optional. The default is False.

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

SingleEvents

Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.

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

SyncToken

Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. These are: - iCalUID - orderBy - privateExtendedProperty - q - sharedExtendedProperty - timeMin - timeMax - updatedMin All other query parameters should be the same as for the initial synchronization to avoid undefined behavior. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.

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

TimeMax

DateTime representation of TimeMaxDateTimeOffset.

Declaration
[Obsolete("This property is obsolete and may behave unexpectedly; please use TimeMaxDateTimeOffset instead.")]
public virtual DateTime? TimeMax { get; set; }
Property Value
Type Description
DateTime?

TimeMaxDateTimeOffset

Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.

Declaration
public virtual DateTimeOffset? TimeMaxDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

TimeMaxRaw

String representation of TimeMaxDateTimeOffset, formatted for inclusion in the HTTP request.

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

TimeMin

DateTime representation of TimeMinDateTimeOffset.

Declaration
[Obsolete("This property is obsolete and may behave unexpectedly; please use TimeMinDateTimeOffset instead.")]
public virtual DateTime? TimeMin { get; set; }
Property Value
Type Description
DateTime?

TimeMinDateTimeOffset

Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.

Declaration
public virtual DateTimeOffset? TimeMinDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

TimeMinRaw

String representation of TimeMinDateTimeOffset, formatted for inclusion in the HTTP request.

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

TimeZone

Time zone used in the response. Optional. The default is the time zone of the calendar.

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

UpdatedMin

DateTime representation of UpdatedMinDateTimeOffset.

Declaration
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdatedMinDateTimeOffset instead.")]
public virtual DateTime? UpdatedMin { get; set; }
Property Value
Type Description
DateTime?

UpdatedMinDateTimeOffset

Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.

Declaration
public virtual DateTimeOffset? UpdatedMinDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

UpdatedMinRaw

String representation of UpdatedMinDateTimeOffset, formatted for inclusion in the HTTP request.

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

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements