#include <calendar_service.h>
Implements the watch 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 https://www.googleapis.com/auth/calendar.events.readonly https://www.googleapis.com/auth/calendar.readonly
◆ EventsResource_WatchMethod()
google_calendar_api::EventsResource_WatchMethod::EventsResource_WatchMethod |
( |
const CalendarService * |
_service_, |
|
|
client::AuthorizationCredential * |
_credential_, |
|
|
const absl::string_view & |
calendar_id, |
|
|
const Channel & |
_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] | <em>content</em> | The data object to watch. |
◆ ~EventsResource_WatchMethod()
google_calendar_api::EventsResource_WatchMethod::~EventsResource_WatchMethod |
( |
| ) |
|
|
virtual |
◆ AppendOptionalQueryParameters()
util::Status google_calendar_api::EventsResource_WatchMethod::AppendOptionalQueryParameters |
( |
string * |
target | ) |
|
|
virtual |
◆ AppendVariable()
util::Status google_calendar_api::EventsResource_WatchMethod::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_WatchMethod::clear_always_include_email |
( |
| ) |
|
|
inline |
Clears the 'alwaysIncludeEmail
' attribute so it is no longer set.
◆ clear_i_cal_uid()
void google_calendar_api::EventsResource_WatchMethod::clear_i_cal_uid |
( |
| ) |
|
|
inline |
Clears the 'iCalUID
' attribute so it is no longer set.
◆ clear_max_attendees()
void google_calendar_api::EventsResource_WatchMethod::clear_max_attendees |
( |
| ) |
|
|
inline |
Clears the 'maxAttendees
' attribute so it is no longer set.
◆ clear_max_results()
void google_calendar_api::EventsResource_WatchMethod::clear_max_results |
( |
| ) |
|
|
inline |
Clears the 'maxResults
' attribute so it is no longer set.
◆ clear_order_by()
void google_calendar_api::EventsResource_WatchMethod::clear_order_by |
( |
| ) |
|
|
inline |
Clears the 'orderBy
' attribute so it is no longer set.
◆ clear_page_token()
void google_calendar_api::EventsResource_WatchMethod::clear_page_token |
( |
| ) |
|
|
inline |
Clears the 'pageToken
' attribute so it is no longer set.
◆ clear_private_extended_property()
void google_calendar_api::EventsResource_WatchMethod::clear_private_extended_property |
( |
| ) |
|
|
inline |
Clears the 'privateExtendedProperty
' attribute so it is no longer set.
◆ clear_q()
void google_calendar_api::EventsResource_WatchMethod::clear_q |
( |
| ) |
|
|
inline |
Clears the 'q
' attribute so it is no longer set.
◆ clear_shared_extended_property()
void google_calendar_api::EventsResource_WatchMethod::clear_shared_extended_property |
( |
| ) |
|
|
inline |
Clears the 'sharedExtendedProperty
' attribute so it is no longer set.
◆ clear_show_deleted()
void google_calendar_api::EventsResource_WatchMethod::clear_show_deleted |
( |
| ) |
|
|
inline |
Clears the 'showDeleted
' attribute so it is no longer set.
◆ clear_show_hidden_invitations()
void google_calendar_api::EventsResource_WatchMethod::clear_show_hidden_invitations |
( |
| ) |
|
|
inline |
Clears the 'showHiddenInvitations
' attribute so it is no longer set.
◆ clear_single_events()
void google_calendar_api::EventsResource_WatchMethod::clear_single_events |
( |
| ) |
|
|
inline |
Clears the 'singleEvents
' attribute so it is no longer set.
◆ clear_sync_token()
void google_calendar_api::EventsResource_WatchMethod::clear_sync_token |
( |
| ) |
|
|
inline |
Clears the 'syncToken
' attribute so it is no longer set.
◆ clear_time_max()
void google_calendar_api::EventsResource_WatchMethod::clear_time_max |
( |
| ) |
|
|
inline |
Clears the 'timeMax
' attribute so it is no longer set.
◆ clear_time_min()
void google_calendar_api::EventsResource_WatchMethod::clear_time_min |
( |
| ) |
|
|
inline |
Clears the 'timeMin
' attribute so it is no longer set.
◆ clear_time_zone()
void google_calendar_api::EventsResource_WatchMethod::clear_time_zone |
( |
| ) |
|
|
inline |
Clears the 'timeZone
' attribute so it is no longer set.
◆ clear_updated_min()
void google_calendar_api::EventsResource_WatchMethod::clear_updated_min |
( |
| ) |
|
|
inline |
Clears the 'updatedMin
' attribute so it is no longer set.
◆ ExecuteAndParseResponse()
util::Status google_calendar_api::EventsResource_WatchMethod::ExecuteAndParseResponse |
( |
Channel * |
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_WatchMethod::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_i_cal_uid()
const string& google_calendar_api::EventsResource_WatchMethod::get_i_cal_uid |
( |
| ) |
const |
|
inline |
Gets the optional 'iCalUID
' attribute.
If the value is not set then the default value will be returned.
◆ get_max_attendees()
int32 google_calendar_api::EventsResource_WatchMethod::get_max_attendees |
( |
| ) |
const |
|
inline |
Gets the optional 'maxAttendees
' attribute.
If the value is not set then the default value will be returned.
◆ get_max_results()
int32 google_calendar_api::EventsResource_WatchMethod::get_max_results |
( |
| ) |
const |
|
inline |
Gets the optional 'maxResults
' attribute.
If the value is not set then the default value will be returned.
◆ get_order_by()
const string& google_calendar_api::EventsResource_WatchMethod::get_order_by |
( |
| ) |
const |
|
inline |
Gets the optional 'orderBy
' attribute.
If the value is not set then the default value will be returned.
◆ get_page_token()
const string& google_calendar_api::EventsResource_WatchMethod::get_page_token |
( |
| ) |
const |
|
inline |
Gets the optional 'pageToken
' attribute.
If the value is not set then the default value will be returned.
◆ get_private_extended_property()
const client::JsonCppArray<string >& google_calendar_api::EventsResource_WatchMethod::get_private_extended_property |
( |
| ) |
const |
|
inline |
Gets the optional 'privateExtendedProperty
' attribute.
If the value is not set then the default value will be returned.
◆ get_q()
const string& google_calendar_api::EventsResource_WatchMethod::get_q |
( |
| ) |
const |
|
inline |
Gets the optional 'q
' attribute.
If the value is not set then the default value will be returned.
◆ get_shared_extended_property()
const client::JsonCppArray<string >& google_calendar_api::EventsResource_WatchMethod::get_shared_extended_property |
( |
| ) |
const |
|
inline |
Gets the optional 'sharedExtendedProperty
' attribute.
If the value is not set then the default value will be returned.
◆ get_show_deleted()
bool google_calendar_api::EventsResource_WatchMethod::get_show_deleted |
( |
| ) |
const |
|
inline |
Gets the optional 'showDeleted
' attribute.
If the value is not set then the default value will be returned.
◆ get_show_hidden_invitations()
bool google_calendar_api::EventsResource_WatchMethod::get_show_hidden_invitations |
( |
| ) |
const |
|
inline |
Gets the optional 'showHiddenInvitations
' attribute.
If the value is not set then the default value will be returned.
◆ get_single_events()
bool google_calendar_api::EventsResource_WatchMethod::get_single_events |
( |
| ) |
const |
|
inline |
Gets the optional 'singleEvents
' attribute.
If the value is not set then the default value will be returned.
◆ get_sync_token()
const string& google_calendar_api::EventsResource_WatchMethod::get_sync_token |
( |
| ) |
const |
|
inline |
Gets the optional 'syncToken
' attribute.
If the value is not set then the default value will be returned.
◆ get_time_max()
client::DateTime google_calendar_api::EventsResource_WatchMethod::get_time_max |
( |
| ) |
const |
|
inline |
Gets the optional 'timeMax
' attribute.
If the value is not set then the default value will be returned.
◆ get_time_min()
client::DateTime google_calendar_api::EventsResource_WatchMethod::get_time_min |
( |
| ) |
const |
|
inline |
Gets the optional 'timeMin
' attribute.
If the value is not set then the default value will be returned.
◆ get_time_zone()
const string& google_calendar_api::EventsResource_WatchMethod::get_time_zone |
( |
| ) |
const |
|
inline |
Gets the optional 'timeZone
' attribute.
If the value is not set then the default value will be returned.
◆ get_updated_min()
client::DateTime google_calendar_api::EventsResource_WatchMethod::get_updated_min |
( |
| ) |
const |
|
inline |
Gets the optional 'updatedMin
' attribute.
If the value is not set then the default value will be returned.
◆ mutable_iCalUID()
string* google_calendar_api::EventsResource_WatchMethod::mutable_iCalUID |
( |
| ) |
|
|
inline |
Gets a modifiable pointer to the optional iCalUID
' attribute.
- Returns
- The value can be set by dereferencing the pointer.
◆ mutable_orderBy()
string* google_calendar_api::EventsResource_WatchMethod::mutable_orderBy |
( |
| ) |
|
|
inline |
Gets a modifiable pointer to the optional orderBy
' attribute.
- Returns
- The value can be set by dereferencing the pointer.
◆ mutable_pageToken()
string* google_calendar_api::EventsResource_WatchMethod::mutable_pageToken |
( |
| ) |
|
|
inline |
Gets a modifiable pointer to the optional pageToken
' attribute.
- Returns
- The value can be set by dereferencing the pointer.
◆ mutable_privateExtendedProperty()
client::JsonCppArray<string >* google_calendar_api::EventsResource_WatchMethod::mutable_privateExtendedProperty |
( |
| ) |
|
|
inline |
Gets a modifiable pointer to the optional privateExtendedProperty
' attribute.
- Returns
- The value can be set by dereferencing the pointer.
◆ mutable_q()
string* google_calendar_api::EventsResource_WatchMethod::mutable_q |
( |
| ) |
|
|
inline |
Gets a modifiable pointer to the optional q
' attribute.
- Returns
- The value can be set by dereferencing the pointer.
◆ mutable_sharedExtendedProperty()
client::JsonCppArray<string >* google_calendar_api::EventsResource_WatchMethod::mutable_sharedExtendedProperty |
( |
| ) |
|
|
inline |
Gets a modifiable pointer to the optional sharedExtendedProperty
' attribute.
- Returns
- The value can be set by dereferencing the pointer.
◆ mutable_syncToken()
string* google_calendar_api::EventsResource_WatchMethod::mutable_syncToken |
( |
| ) |
|
|
inline |
Gets a modifiable pointer to the optional syncToken
' attribute.
- Returns
- The value can be set by dereferencing the pointer.
◆ mutable_timeZone()
string* google_calendar_api::EventsResource_WatchMethod::mutable_timeZone |
( |
| ) |
|
|
inline |
Gets a modifiable pointer to the optional timeZone
' attribute.
- Returns
- The value can be set by dereferencing the pointer.
◆ set_always_include_email()
void google_calendar_api::EventsResource_WatchMethod::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_i_cal_uid()
void google_calendar_api::EventsResource_WatchMethod::set_i_cal_uid |
( |
const string & |
value | ) |
|
|
inline |
Sets the 'iCalUID
' attribute.
- Parameters
-
[in] | value | Specifies event ID in the iCalendar format to be included in the response. Optional. |
◆ set_max_attendees()
void google_calendar_api::EventsResource_WatchMethod::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_max_results()
void google_calendar_api::EventsResource_WatchMethod::set_max_results |
( |
int32 |
value | ) |
|
|
inline |
Sets the 'maxResults
' attribute.
- Parameters
-
[in] | value | Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional. |
◆ set_order_by()
void google_calendar_api::EventsResource_WatchMethod::set_order_by |
( |
const string & |
value | ) |
|
|
inline |
Sets the 'orderBy
' attribute.
- Parameters
-
[in] | value | The order of the events returned in the result. Optional. The default is an unspecified, stable order. |
◆ set_page_token()
void google_calendar_api::EventsResource_WatchMethod::set_page_token |
( |
const string & |
value | ) |
|
|
inline |
Sets the 'pageToken
' attribute.
- Parameters
-
[in] | value | Token specifying which result page to return. Optional. |
◆ set_q()
void google_calendar_api::EventsResource_WatchMethod::set_q |
( |
const string & |
value | ) |
|
|
inline |
Sets the 'q
' attribute.
- Parameters
-
[in] | value | Free text search terms to find events that match these terms in any field, except for extended properties. Optional. |
◆ set_show_deleted()
void google_calendar_api::EventsResource_WatchMethod::set_show_deleted |
( |
bool |
value | ) |
|
|
inline |
Sets the 'showDeleted
' attribute.
- Parameters
-
[in] | value | Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False. |
◆ set_show_hidden_invitations()
void google_calendar_api::EventsResource_WatchMethod::set_show_hidden_invitations |
( |
bool |
value | ) |
|
|
inline |
Sets the 'showHiddenInvitations
' attribute.
- Parameters
-
[in] | value | Whether to include hidden invitations in the result. Optional. The default is False. |
◆ set_single_events()
void google_calendar_api::EventsResource_WatchMethod::set_single_events |
( |
bool |
value | ) |
|
|
inline |
Sets the 'singleEvents
' attribute.
- Parameters
-
[in] | value | Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False. |
◆ set_sync_token()
void google_calendar_api::EventsResource_WatchMethod::set_sync_token |
( |
const string & |
value | ) |
|
|
inline |
Sets the 'syncToken
' attribute.
- Parameters
-
[in] | value | Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. |
These are:
- iCalUID
- orderBy
- privateExtendedProperty
- q
- sharedExtendedProperty
- timeMin
- timeMax
- updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.
◆ set_time_max()
void google_calendar_api::EventsResource_WatchMethod::set_time_max |
( |
client::DateTime |
value | ) |
|
|
inline |
Sets the 'timeMax
' attribute.
- Parameters
-
[in] | value | 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, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin. |
◆ set_time_min()
void google_calendar_api::EventsResource_WatchMethod::set_time_min |
( |
client::DateTime |
value | ) |
|
|
inline |
Sets the 'timeMin
' attribute.
- Parameters
-
[in] | value | Lower bound (exclusive) 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, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax. |
◆ set_time_zone()
void google_calendar_api::EventsResource_WatchMethod::set_time_zone |
( |
const string & |
value | ) |
|
|
inline |
Sets the 'timeZone
' attribute.
- Parameters
-
[in] | value | Time zone used in the response. Optional. The default is the time zone of the calendar. |
◆ set_updated_min()
void google_calendar_api::EventsResource_WatchMethod::set_updated_min |
( |
client::DateTime |
value | ) |
|
|
inline |
Sets the 'updatedMin
' attribute.
- Parameters
-
[in] | value | Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time. |
The documentation for this class was generated from the following files: