calendar  v3
Public Member Functions | List of all members
google_calendar_api::EventsResource_DeleteMethod Class Reference

#include <calendar_service.h>

Inheritance diagram for google_calendar_api::EventsResource_DeleteMethod:
google_calendar_api::CalendarServiceBaseRequest

Public Member Functions

 EventsResource_DeleteMethod (const CalendarService *_service_, client::AuthorizationCredential *_credential_, const absl::string_view &calendar_id, const absl::string_view &event_id)
 
virtual ~EventsResource_DeleteMethod ()
 
void clear_send_notifications ()
 
bool get_send_notifications () const
 
void set_send_notifications (bool value)
 
void clear_send_updates ()
 
const string & get_send_updates () const
 
string * mutable_sendUpdates ()
 
void set_send_updates (const string &value)
 
virtual util::Status AppendVariable (const StringPiece &variable_name, const client::UriTemplateConfig &config, string *target)
 
virtual util::Status AppendOptionalQueryParameters (string *target)
 
- Public Member Functions inherited from google_calendar_api::CalendarServiceBaseRequest
 CalendarServiceBaseRequest (const client::ClientService *service, client::AuthorizationCredential *credential, client::HttpRequest::HttpMethod method, const StringPiece &uri_template)
 
virtual ~CalendarServiceBaseRequest ()
 
void clear_alt ()
 
const string & get_alt () const
 
string * mutable_alt ()
 
void set_alt (const string &value)
 
void clear_fields ()
 
const string & get_fields () const
 
string * mutable_fields ()
 
void set_fields (const string &value)
 
void clear_key ()
 
const string & get_key () const
 
string * mutable_key ()
 
void set_key (const string &value)
 
void clear_oauth_token ()
 
const string & get_oauth_token () const
 
string * mutable_oauthToken ()
 
void set_oauth_token (const string &value)
 
void clear_pretty_print ()
 
bool get_pretty_print () const
 
void set_pretty_print (bool value)
 
void clear_quota_user ()
 
const string & get_quota_user () const
 
string * mutable_quotaUser ()
 
void set_quota_user (const string &value)
 
void clear_user_ip ()
 
const string & get_user_ip () const
 
string * mutable_userIp ()
 
void set_user_ip (const string &value)
 

Additional Inherited Members

- Protected Member Functions inherited from google_calendar_api::CalendarServiceBaseRequest
void AddJsonContentToRequest (const client::JsonCppData *content)
 

Detailed Description

Implements the delete 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

Constructor & Destructor Documentation

◆ EventsResource_DeleteMethod()

google_calendar_api::EventsResource_DeleteMethod::EventsResource_DeleteMethod ( const CalendarService _service_,
client::AuthorizationCredential *  _credential_,
const absl::string_view &  calendar_id,
const absl::string_view &  event_id 
)

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_idCalendar 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_idEvent identifier.

◆ ~EventsResource_DeleteMethod()

google_calendar_api::EventsResource_DeleteMethod::~EventsResource_DeleteMethod ( )
virtual

Standard destructor.

Member Function Documentation

◆ AppendOptionalQueryParameters()

util::Status google_calendar_api::EventsResource_DeleteMethod::AppendOptionalQueryParameters ( string *  target)
virtual

Appends the optional query parameters to the target URL.

Parameters
[in,out]targetThe URL string to append to.

Reimplemented from google_calendar_api::CalendarServiceBaseRequest.

◆ AppendVariable()

util::Status google_calendar_api::EventsResource_DeleteMethod::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_nameThe name of the templated variable.
[in]configA pass-through parameter used for lists and maps.
[in,out]targetThe string to append the value to.

Reimplemented from google_calendar_api::CalendarServiceBaseRequest.

◆ clear_send_notifications()

void google_calendar_api::EventsResource_DeleteMethod::clear_send_notifications ( )
inline

Clears the 'sendNotifications' attribute so it is no longer set.

◆ clear_send_updates()

void google_calendar_api::EventsResource_DeleteMethod::clear_send_updates ( )
inline

Clears the 'sendUpdates' attribute so it is no longer set.

◆ get_send_notifications()

bool google_calendar_api::EventsResource_DeleteMethod::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_DeleteMethod::get_send_updates ( ) const
inline

Gets the optional 'sendUpdates' attribute.

If the value is not set then the default value will be returned.

◆ mutable_sendUpdates()

string* google_calendar_api::EventsResource_DeleteMethod::mutable_sendUpdates ( )
inline

Gets a modifiable pointer to the optional sendUpdates' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ set_send_notifications()

void google_calendar_api::EventsResource_DeleteMethod::set_send_notifications ( bool  value)
inline

Sets the 'sendNotifications' attribute.

Deprecated:
Parameters
[in]valueDeprecated. Please use sendUpdates instead.

Whether to send notifications about the deletion of the event. 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_DeleteMethod::set_send_updates ( const string &  value)
inline

Sets the 'sendUpdates' attribute.

Parameters
[in]valueGuests who should receive notifications about the deletion of the event.

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