Class EventsResource.ListRequest
Returns events on the specified calendar.
public class EventsResource.ListRequest : CalendarBaseServiceRequest<Events>- Inheritance
-
EventsResource.ListRequest
- Inherited Members
Constructors
ListRequest(IClientService, string)
Constructs a new List request.
public ListRequest(IClientService service, string calendarId)Parameters
serviceIClientServicecalendarIdstring
Properties
AlwaysIncludeEmail
Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.
public virtual Nullable<bool> AlwaysIncludeEmail { get; set; }Property Value
- Nullable<bool>
CalendarId
Calendar identifier.
public virtual string CalendarId { get; }Property Value
HttpMethod
Gets the HTTP method.
public override string HttpMethod { get; }Property Value
ICalUID
Specifies event ID in the iCalendar format to be included in the response. Optional.
public virtual string ICalUID { get; set; }Property Value
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.
public virtual Nullable<int> MaxAttendees { get; set; }Property Value
- Nullable<int>
MaxResults
Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.
public virtual Nullable<int> MaxResults { get; set; }Property Value
- Nullable<int>
MethodName
Gets the method name.
public override string MethodName { get; }Property Value
OrderBy
The order of the events returned in the result. Optional. The default is an unspecified, stable order.
public virtual Nullable<EventsResource.ListRequest.OrderByEnum> OrderBy { get; set; }Property Value
- Nullable<OrderByEnum>
PageToken
Token specifying which result page to return. Optional.
public virtual string PageToken { get; set; }Property Value
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.
public virtual Repeatable<string> PrivateExtendedProperty { get; set; }Property Value
- Repeatable<string>
Q
Free text search terms to find events that match these terms in any field, except for extended properties. Optional.
public virtual string Q { get; set; }Property Value
RestPath
Gets the REST path.
public override string RestPath { get; }Property Value
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.
public virtual Repeatable<string> SharedExtendedProperty { get; set; }Property Value
- 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.
public virtual Nullable<bool> ShowDeleted { get; set; }Property Value
- Nullable<bool>
ShowHiddenInvitations
Whether to include hidden invitations in the result. Optional. The default is False.
public virtual Nullable<bool> ShowHiddenInvitations { get; set; }Property Value
- Nullable<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.
public virtual Nullable<bool> SingleEvents { get; set; }Property Value
- Nullable<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 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.
public virtual string SyncToken { get; set; }Property Value
TimeMax
Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time.
public virtual Nullable<DateTime> TimeMax { get; set; }Property Value
- Nullable<DateTime>
TimeMin
Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time.
public virtual Nullable<DateTime> TimeMin { get; set; }Property Value
- Nullable<DateTime>
TimeZone
Time zone used in the response. Optional. The default is the time zone of the calendar.
public virtual string TimeZone { get; set; }Property Value
UpdatedMin
Lower bound for an event's last modification time (as a RFC 3339 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.
public virtual Nullable<DateTime> UpdatedMin { get; set; }Property Value
- Nullable<DateTime>
Methods
InitParameters()
Initializes List parameter list.
protected override void InitParameters()