#include <calendar_service.h>
Implements the update method.
This class uses the Command Pattern. Construct an instance with the required parameters, then set any additional optional parameters by using the attribute setters. To invoke the method, call Execute
.
One or more of these authorization scopes are required for this method: https://www.googleapis.com/auth/calendar https://www.googleapis.com/auth/calendar.events
◆ EventsResource_UpdateMethod()
google_calendar_api::EventsResource_UpdateMethod::EventsResource_UpdateMethod |
( |
const CalendarService * |
_service_, |
|
|
client::AuthorizationCredential * |
_credential_, |
|
|
const absl::string_view & |
calendar_id, |
|
|
const absl::string_view & |
event_id, |
|
|
const Event & |
_content_ |
|
) |
| |
The standard constructor takes all the required method parameters.
- Parameters
-
[in] | <em>service</em> | The service instance to send to when executed. |
[in] | <em>credential</em> | If not NULL, the credential to authorize with. In practice this is supplied by the user code that is creating the method instance. |
[in] | calendar_id | 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. |
[in] | event_id | Event identifier. |
[in] | <em>content</em> | The data object to update. |
◆ ~EventsResource_UpdateMethod()
google_calendar_api::EventsResource_UpdateMethod::~EventsResource_UpdateMethod |
( |
| ) |
|
|
virtual |
◆ AppendOptionalQueryParameters()
util::Status google_calendar_api::EventsResource_UpdateMethod::AppendOptionalQueryParameters |
( |
string * |
target | ) |
|
|
virtual |
◆ AppendVariable()
util::Status google_calendar_api::EventsResource_UpdateMethod::AppendVariable |
( |
const StringPiece & |
variable_name, |
|
|
const client::UriTemplateConfig & |
config, |
|
|
string * |
target |
|
) |
| |
|
virtual |
Appends variable value to the target string.
This is a helper function used to resolve templated variables in the URI.
- Parameters
-
[in] | variable_name | The name of the templated variable. |
[in] | config | A pass-through parameter used for lists and maps. |
[in,out] | target | The string to append the value to. |
Reimplemented from google_calendar_api::CalendarServiceBaseRequest.
◆ clear_always_include_email()
void google_calendar_api::EventsResource_UpdateMethod::clear_always_include_email |
( |
| ) |
|
|
inline |
Clears the 'alwaysIncludeEmail
' attribute so it is no longer set.
◆ clear_conference_data_version()
void google_calendar_api::EventsResource_UpdateMethod::clear_conference_data_version |
( |
| ) |
|
|
inline |
Clears the 'conferenceDataVersion
' attribute so it is no longer set.
◆ clear_max_attendees()
void google_calendar_api::EventsResource_UpdateMethod::clear_max_attendees |
( |
| ) |
|
|
inline |
Clears the 'maxAttendees
' attribute so it is no longer set.
◆ clear_send_notifications()
void google_calendar_api::EventsResource_UpdateMethod::clear_send_notifications |
( |
| ) |
|
|
inline |
Clears the 'sendNotifications
' attribute so it is no longer set.
◆ clear_send_updates()
void google_calendar_api::EventsResource_UpdateMethod::clear_send_updates |
( |
| ) |
|
|
inline |
Clears the 'sendUpdates
' attribute so it is no longer set.
◆ clear_supports_attachments()
void google_calendar_api::EventsResource_UpdateMethod::clear_supports_attachments |
( |
| ) |
|
|
inline |
Clears the 'supportsAttachments
' attribute so it is no longer set.
◆ ExecuteAndParseResponse()
util::Status google_calendar_api::EventsResource_UpdateMethod::ExecuteAndParseResponse |
( |
Event * |
data | ) |
|
|
inline |
Executes the method and parses the response into a data object on success.
- Parameters
-
[out] | data | Loads from the response payload JSON data on success. |
- Returns
- Success if an HTTP 2xx response was received. Otherwise the status indicates the reason for failure. Finer detail may be available from the underlying http_request to distinguish the transport_status from the overal HTTP request status.
◆ get_always_include_email()
bool google_calendar_api::EventsResource_UpdateMethod::get_always_include_email |
( |
| ) |
const |
|
inline |
Gets the optional 'alwaysIncludeEmail
' attribute.
If the value is not set then the default value will be returned.
◆ get_conference_data_version()
int32 google_calendar_api::EventsResource_UpdateMethod::get_conference_data_version |
( |
| ) |
const |
|
inline |
Gets the optional 'conferenceDataVersion
' attribute.
If the value is not set then the default value will be returned.
◆ get_max_attendees()
int32 google_calendar_api::EventsResource_UpdateMethod::get_max_attendees |
( |
| ) |
const |
|
inline |
Gets the optional 'maxAttendees
' attribute.
If the value is not set then the default value will be returned.
◆ get_send_notifications()
bool google_calendar_api::EventsResource_UpdateMethod::get_send_notifications |
( |
| ) |
const |
|
inline |
Gets the optional 'sendNotifications
' attribute.
If the value is not set then the default value will be returned.
◆ get_send_updates()
const string& google_calendar_api::EventsResource_UpdateMethod::get_send_updates |
( |
| ) |
const |
|
inline |
Gets the optional 'sendUpdates
' attribute.
If the value is not set then the default value will be returned.
◆ get_supports_attachments()
bool google_calendar_api::EventsResource_UpdateMethod::get_supports_attachments |
( |
| ) |
const |
|
inline |
Gets the optional 'supportsAttachments
' attribute.
If the value is not set then the default value will be returned.
◆ mutable_sendUpdates()
string* google_calendar_api::EventsResource_UpdateMethod::mutable_sendUpdates |
( |
| ) |
|
|
inline |
Gets a modifiable pointer to the optional sendUpdates
' attribute.
- Returns
- The value can be set by dereferencing the pointer.
◆ set_always_include_email()
void google_calendar_api::EventsResource_UpdateMethod::set_always_include_email |
( |
bool |
value | ) |
|
|
inline |
Sets the 'alwaysIncludeEmail
' attribute.
- Deprecated:
- Parameters
-
[in] | value | 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). |
◆ set_conference_data_version()
void google_calendar_api::EventsResource_UpdateMethod::set_conference_data_version |
( |
int32 |
value | ) |
|
|
inline |
Sets the 'conferenceDataVersion
' attribute.
- Parameters
-
[in] | value | 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. |
◆ set_max_attendees()
void google_calendar_api::EventsResource_UpdateMethod::set_max_attendees |
( |
int32 |
value | ) |
|
|
inline |
Sets the 'maxAttendees
' attribute.
- Parameters
-
[in] | value | 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. |
◆ set_send_notifications()
void google_calendar_api::EventsResource_UpdateMethod::set_send_notifications |
( |
bool |
value | ) |
|
|
inline |
Sets the 'sendNotifications
' attribute.
- Deprecated:
- Parameters
-
[in] | value | 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.
◆ set_send_updates()
void google_calendar_api::EventsResource_UpdateMethod::set_send_updates |
( |
const string & |
value | ) |
|
|
inline |
Sets the 'sendUpdates
' attribute.
- Parameters
-
[in] | value | Guests who should receive notifications about the event update (for example, title changes, etc.). |
◆ set_supports_attachments()
void google_calendar_api::EventsResource_UpdateMethod::set_supports_attachments |
( |
bool |
value | ) |
|
|
inline |
Sets the 'supportsAttachments
' attribute.
- Parameters
-
[in] | value | Whether API client performing operation supports event attachments. Optional. The default is False. |
The documentation for this class was generated from the following files: