Class EventsResource.InstancesRequest

Returns instances of the specified recurring event.

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

Constructors

InstancesRequest(IClientService, string, string)

Constructs a new Instances request.

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

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
[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

EventId

Recurring event identifier.

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

HttpMethod

Gets the HTTP method.

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

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. 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

OriginalStart

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

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

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

RestPath

Gets the REST path.

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

ShowDeleted

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.

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

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.

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 (inclusive) 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.

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

Methods

InitParameters()

Initializes Instances parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements