calendar  v3
Public Types | Public Member Functions | Protected Member Functions | Properties | List of all members
Google.Apis.Calendar.v3.EventsResource.UpdateRequest Class Reference

Updates an event. More...

Inheritance diagram for Google.Apis.Calendar.v3.EventsResource.UpdateRequest:
Google.Apis.Calendar.v3.CalendarBaseServiceRequest< Google.Apis.Calendar.v3.Data.Event >

Public Types

enum  SendUpdatesEnum { SendUpdatesEnum.All, SendUpdatesEnum.ExternalOnly, SendUpdatesEnum.None }
 Guests who should receive notifications about the event update (for example, title changes, etc.). More...
 

Public Member Functions

 UpdateRequest (Google.Apis.Services.IClientService service, Google.Apis.Calendar.v3.Data.Event body, string calendarId, string eventId)
 Constructs a new Update request. More...
 

Protected Member Functions

override object GetBody ()
 summary>Gets the method name. More...
 
override void InitParameters ()
 Initializes Update parameter list. More...
 
- Protected Member Functions inherited from Google.Apis.Calendar.v3.CalendarBaseServiceRequest< Google.Apis.Calendar.v3.Data.Event >
 CalendarBaseServiceRequest (Google.Apis.Services.IClientService service)
 Constructs a new CalendarBaseServiceRequest instance. More...
 
override void InitParameters ()
 Initializes Calendar parameter list. More...
 

Properties

virtual string CalendarId [get]
 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. More...
 
virtual string EventId [get]
 Event identifier. More...
 
virtual System.Nullable< bool > AlwaysIncludeEmail [get, set]
 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). More...
 
virtual System.Nullable< int > ConferenceDataVersion [get, set]
 Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0. More...
 
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. More...
 
virtual System.Nullable< bool > SendNotifications [get, set]
 Deprecated. Please use sendUpdates instead. More...
 
virtual System.Nullable< SendUpdatesEnumSendUpdates [get, set]
 Guests who should receive notifications about the event update (for example, title changes, etc.). More...
 
virtual System.Nullable< bool > SupportsAttachments [get, set]
 Whether API client performing operation supports event attachments. Optional. The default is False. More...
 
override string MethodName [get]
 summary>Gets the HTTP method. More...
 
override string HttpMethod [get]
 summary>Gets the REST path. More...
 
override string RestPath [get]
 
- Properties inherited from Google.Apis.Calendar.v3.CalendarBaseServiceRequest< Google.Apis.Calendar.v3.Data.Event >
virtual System.Nullable< AltEnum > Alt [get, set]
 Data format for the response. More...
 
virtual string Fields [get, set]
 Selector specifying which fields to include in a partial response. More...
 
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. More...
 
virtual string OauthToken [get, set]
 OAuth 2.0 token for the current user. More...
 
virtual System.Nullable< bool > PrettyPrint [get, set]
 Returns response with indentations and line breaks. More...
 
virtual string QuotaUser [get, set]
 An opaque string that represents a user for quota purposes. Must not exceed 40 characters. More...
 
virtual string UserIp [get, set]
 Deprecated. Please use quotaUser instead. More...
 

Detailed Description

Updates an event.

Member Enumeration Documentation

◆ SendUpdatesEnum

Guests who should receive notifications about the event update (for example, title changes, etc.).

Enumerator
All 

Notifications are sent to all guests.

ExternalOnly 

Notifications are sent to non-Google Calendar guests only.

None 

No notifications are sent. This value should only be used for migration use cases (note that in most migration cases the import method should be used).

Constructor & Destructor Documentation

◆ UpdateRequest()

Google.Apis.Calendar.v3.EventsResource.UpdateRequest.UpdateRequest ( Google.Apis.Services.IClientService  service,
Google.Apis.Calendar.v3.Data.Event  body,
string  calendarId,
string  eventId 
)
inline

Constructs a new Update request.

Member Function Documentation

◆ GetBody()

override object Google.Apis.Calendar.v3.EventsResource.UpdateRequest.GetBody ( )
inlineprotected

summary>Gets the method name.

◆ InitParameters()

override void Google.Apis.Calendar.v3.EventsResource.UpdateRequest.InitParameters ( )
inlineprotected

Initializes Update parameter list.

Property Documentation

◆ AlwaysIncludeEmail

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

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

◆ CalendarId

virtual string Google.Apis.Calendar.v3.EventsResource.UpdateRequest.CalendarId
get

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.

◆ ConferenceDataVersion

virtual System.Nullable<int> Google.Apis.Calendar.v3.EventsResource.UpdateRequest.ConferenceDataVersion
getset

Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.

[minimum: 0] [maximum: 1]

◆ EventId

virtual string Google.Apis.Calendar.v3.EventsResource.UpdateRequest.EventId
get

Event identifier.

◆ HttpMethod

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

summary>Gets the REST path.

◆ MaxAttendees

virtual System.Nullable<int> Google.Apis.Calendar.v3.EventsResource.UpdateRequest.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]

◆ MethodName

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

summary>Gets the HTTP method.

◆ SendNotifications

virtual System.Nullable<bool> Google.Apis.Calendar.v3.EventsResource.UpdateRequest.SendNotifications
getset

Deprecated. Please use sendUpdates instead.

Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.

◆ SendUpdates

virtual System.Nullable<SendUpdatesEnum> Google.Apis.Calendar.v3.EventsResource.UpdateRequest.SendUpdates
getset

Guests who should receive notifications about the event update (for example, title changes, etc.).

◆ SupportsAttachments

virtual System.Nullable<bool> Google.Apis.Calendar.v3.EventsResource.UpdateRequest.SupportsAttachments
getset

Whether API client performing operation supports event attachments. Optional. The default is False.


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