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

Returns instances of the specified recurring event. More...

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

Public Member Functions

 InstancesRequest (Google.Apis.Services.IClientService service, string calendarId, string eventId)
 Constructs a new Instances request.

Protected Member Functions

override void InitParameters ()
 Initializes Instances 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 string EventId [get, set]
 Recurring event identifier.
virtual System.Nullable< bool > ShowDeleted [get, set]
 Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events will still be included if singleEvents is False. 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 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 string OriginalStart [get, set]
 The original start time of the instance in the result. Optional.
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

Additional Inherited Members

- Public Types inherited from Google.Apis.Calendar.v3.CalendarBaseServiceRequest< TResponse >
enum  AltEnum
 Data format for the response. More...

Detailed Description

Returns instances of the specified recurring event.

Constructor & Destructor Documentation

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

Constructs a new Instances request.

Member Function Documentation

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

Initializes Instances parameter list.

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

Property Documentation

virtual System.Nullable<bool> Google.Apis.Calendar.v3.EventsResource.InstancesRequest.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.InstancesRequest.CalendarId
getset

Calendar identifier.

virtual string Google.Apis.Calendar.v3.EventsResource.InstancesRequest.EventId
getset

Recurring event identifier.

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

summary>Gets the REST path.

virtual System.Nullable<int> Google.Apis.Calendar.v3.EventsResource.InstancesRequest.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.InstancesRequest.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.InstancesRequest.MethodName
get

summary>Gets the HTTP method.

virtual string Google.Apis.Calendar.v3.EventsResource.InstancesRequest.OriginalStart
getset

The original start time of the instance in the result. Optional.

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

Token specifying which result page to return. Optional.

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

Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events will still be included if singleEvents is False. Optional. The default is False.

virtual System.Nullable<System.DateTime> Google.Apis.Calendar.v3.EventsResource.InstancesRequest.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.InstancesRequest.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.InstancesRequest.TimeZone
getset

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


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