Class EventsResource.ListRequest

Returns events on the specified calendar.

Inheritance
System.Object
ClientServiceRequest
ClientServiceRequest<Events>
CalendarBaseServiceRequest<Events>
EventsResource.ListRequest
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.Finalize()
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.Calendar.v3
Assembly: Google.Apis.Calendar.v3.dll
Syntax
public class 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
System.String calendarId

Properties

AlwaysIncludeEmail

Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).

Declaration
public virtual Nullable<bool> AlwaysIncludeEmail { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

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
public virtual string CalendarId { get; }
Property Value
Type Description
System.String

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Calendar.v3.Data.Events>.HttpMethod

ICalUID

Specifies event ID in the iCalendar format to be included in the response. Optional.

Declaration
public virtual string ICalUID { get; set; }
Property Value
Type Description
System.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
public virtual Nullable<int> MaxAttendees { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

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
public virtual Nullable<int> MaxResults { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Calendar.v3.Data.Events>.MethodName

OrderBy

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

Declaration
public virtual Nullable<EventsResource.ListRequest.OrderByEnum> OrderBy { get; set; }
Property Value
Type Description
System.Nullable<EventsResource.ListRequest.OrderByEnum>

PageToken

Token specifying which result page to return. Optional.

Declaration
public virtual string PageToken { get; set; }
Property Value
Type Description
System.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
public virtual Repeatable<string> PrivateExtendedProperty { get; set; }
Property Value
Type Description
Repeatable<System.String>

Q

Free text search terms to find events that match these terms in any field, except for extended properties. Optional.

Declaration
public virtual string Q { get; set; }
Property Value
Type Description
System.String

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Calendar.v3.Data.Events>.RestPath

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
public virtual Repeatable<string> SharedExtendedProperty { get; set; }
Property Value
Type Description
Repeatable<System.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
public virtual Nullable<bool> ShowDeleted { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

ShowHiddenInvitations

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

Declaration
public virtual Nullable<bool> ShowHiddenInvitations { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

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
public virtual Nullable<bool> SingleEvents { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

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 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
public virtual string SyncToken { get; set; }
Property Value
Type Description
System.String

TimeMax

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 Nullable<DateTime> TimeMax { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

TimeMin

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 Nullable<DateTime> TimeMin { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

TimeZone

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

Declaration
public virtual string TimeZone { get; set; }
Property Value
Type Description
System.String

UpdatedMin

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 Nullable<DateTime> UpdatedMin { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.Calendar.v3.CalendarBaseServiceRequest<Google.Apis.Calendar.v3.Data.Events>.InitParameters()

Implements