calendar  v3
 All Classes Namespaces Functions Variables Enumerations Properties Events
Public Types | Public Member Functions | Protected Member Functions | Properties | List of all members
Google.Apis.Calendar.v3.EventsResource.ListRequest Class Reference

Returns events on the specified calendar. More...

Inheritance diagram for Google.Apis.Calendar.v3.EventsResource.ListRequest:
Google.Apis.Calendar.v3.CalendarBaseServiceRequest< TResponse > Google::Apis::Requests::ClientServiceRequest-g< class > Google::Apis::Requests::IClientServiceRequest

Public Types

enum  OrderByEnum
 The order of the events returned in the result. Optional. The default is an unspecified, stable order. More...
- Public Types inherited from Google.Apis.Calendar.v3.CalendarBaseServiceRequest< TResponse >
enum  AltEnum
 Data format for the response. More...

Public Member Functions

 ListRequest (Google.Apis.Services.IClientService service, string calendarId)
 Constructs a new List request.

Protected Member Functions

override void InitParameters ()
 Initializes List parameter list.
- Protected Member Functions inherited from Google.Apis.Calendar.v3.CalendarBaseServiceRequest< TResponse >
 CalendarBaseServiceRequest (Google.Apis.Services.IClientService service)
 Constructs a new CalendarBaseServiceRequest instance.
- Protected Member Functions inherited from Google::Apis::Requests::ClientServiceRequest-g< class >
 ClientServiceRequest (IClientService service)
string GenerateRequestUri ()
virtual object GetBody ()

Properties

virtual string CalendarId [get, set]
 Calendar identifier.
virtual System.Nullable
< OrderByEnum
OrderBy [get, set]
 The order of the events returned in the result. Optional. The default is an unspecified, stable order.
virtual System.Nullable< bool > ShowHiddenInvitations [get, set]
 Whether to include hidden invitations in the result. Optional. The default is False.
virtual string SyncToken [get, set]
 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.
virtual System.Nullable< bool > ShowDeleted [get, set]
 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.
virtual string ICalUID [get, set]
 Specifies event ID in the iCalendar format to be included in the response. Optional.
virtual System.Nullable
< System.DateTime > 
UpdatedMin [get, set]
 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.
virtual System.Nullable< bool > SingleEvents [get, set]
 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.
virtual System.Nullable
< System.DateTime > 
TimeMax [get, set]
 Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time.
virtual System.Nullable< bool > AlwaysIncludeEmail [get, set]
 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.
virtual System.Nullable< int > MaxResults [get, set]
 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.
virtual string Q [get, set]
 Free text search terms to find events that match these terms in any field, except for extended properties. Optional.
virtual string PageToken [get, set]
 Token specifying which result page to return. Optional.
virtual System.Nullable
< System.DateTime > 
TimeMin [get, set]
 Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time.
virtual string TimeZone [get, set]
 Time zone used in the response. Optional. The default is the time zone of the calendar.
virtual
Google.Apis.Util.Repeatable
< string > 
PrivateExtendedProperty [get, set]
 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.
virtual
Google.Apis.Util.Repeatable
< string > 
SharedExtendedProperty [get, set]
 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.
virtual System.Nullable< int > MaxAttendees [get, set]
 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.
override string MethodName [get]
 summary>Gets the HTTP method.
override string HttpMethod [get]
 summary>Gets the REST path.
override string RestPath [get]
- Properties inherited from Google.Apis.Calendar.v3.CalendarBaseServiceRequest< TResponse >
virtual System.Nullable< AltEnumAlt [get, set]
 Data format for the response.
virtual string Fields [get, set]
 Selector specifying which fields to include in a partial response.
virtual string Key [get, set]
 API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
virtual string OauthToken [get, set]
 OAuth 2.0 token for the current user.
virtual System.Nullable< bool > PrettyPrint [get, set]
 Returns response with indentations and line breaks.
virtual string QuotaUser [get, set]
 Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
virtual string UserIp [get, set]
 IP address of the site where the request originates. Use this if you want to enforce per-user limits.
- Properties inherited from Google::Apis::Requests::ClientServiceRequest-g< class >
ETagAction ETagAction
abstract string MethodName
abstract string RestPath
abstract string HttpMethod
IDictionary< string, IParameter > RequestParameters
IClientService Service
- Properties inherited from Google::Apis::Requests::IClientServiceRequest
string MethodName
string RestPath
string HttpMethod
IDictionary< string, IParameter > RequestParameters
IClientService Service

Detailed Description

Returns events on the specified calendar.

Member Enumeration Documentation

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

Constructor & Destructor Documentation

Google.Apis.Calendar.v3.EventsResource.ListRequest.ListRequest ( Google.Apis.Services.IClientService  service,
string  calendarId 
)
inline

Constructs a new List request.

Member Function Documentation

override void Google.Apis.Calendar.v3.EventsResource.ListRequest.InitParameters ( )
inlineprotectedvirtual

Initializes List parameter list.

Reimplemented from Google.Apis.Calendar.v3.CalendarBaseServiceRequest< TResponse >.

Property Documentation

virtual System.Nullable<bool> Google.Apis.Calendar.v3.EventsResource.ListRequest.AlwaysIncludeEmail
getset

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.

virtual string Google.Apis.Calendar.v3.EventsResource.ListRequest.CalendarId
getset

Calendar identifier.

override string Google.Apis.Calendar.v3.EventsResource.ListRequest.HttpMethod
get

summary>Gets the REST path.

virtual string Google.Apis.Calendar.v3.EventsResource.ListRequest.ICalUID
getset

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

virtual System.Nullable<int> Google.Apis.Calendar.v3.EventsResource.ListRequest.MaxAttendees
getset

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.

[minimum: 1] summary>Gets the method name.

virtual System.Nullable<int> Google.Apis.Calendar.v3.EventsResource.ListRequest.MaxResults
getset

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.

[minimum: 1]

override string Google.Apis.Calendar.v3.EventsResource.ListRequest.MethodName
get

summary>Gets the HTTP method.

virtual System.Nullable<OrderByEnum> Google.Apis.Calendar.v3.EventsResource.ListRequest.OrderBy
getset

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

virtual string Google.Apis.Calendar.v3.EventsResource.ListRequest.PageToken
getset

Token specifying which result page to return. Optional.

virtual Google.Apis.Util.Repeatable<string> Google.Apis.Calendar.v3.EventsResource.ListRequest.PrivateExtendedProperty
getset

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.

virtual string Google.Apis.Calendar.v3.EventsResource.ListRequest.Q
getset

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

virtual Google.Apis.Util.Repeatable<string> Google.Apis.Calendar.v3.EventsResource.ListRequest.SharedExtendedProperty
getset

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.

virtual System.Nullable<bool> Google.Apis.Calendar.v3.EventsResource.ListRequest.ShowDeleted
getset

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.

virtual System.Nullable<bool> Google.Apis.Calendar.v3.EventsResource.ListRequest.ShowHiddenInvitations
getset

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

virtual System.Nullable<bool> Google.Apis.Calendar.v3.EventsResource.ListRequest.SingleEvents
getset

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.

virtual string Google.Apis.Calendar.v3.EventsResource.ListRequest.SyncToken
getset

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.

virtual System.Nullable<System.DateTime> Google.Apis.Calendar.v3.EventsResource.ListRequest.TimeMax
getset

Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time.

virtual System.Nullable<System.DateTime> Google.Apis.Calendar.v3.EventsResource.ListRequest.TimeMin
getset

Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time.

virtual string Google.Apis.Calendar.v3.EventsResource.ListRequest.TimeZone
getset

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

virtual System.Nullable<System.DateTime> Google.Apis.Calendar.v3.EventsResource.ListRequest.UpdatedMin
getset

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.


The documentation for this class was generated from the following file: