Struct google_calendar3::api::EventWatchCall
source · [−]pub struct EventWatchCall<'a> { /* private fields */ }
Expand description
Watch for changes to Events resources.
A builder for the watch method supported by a event resource.
It is not used directly, but through a EventMethods
instance.
Example
Instantiate a resource method builder
use calendar3::api::Channel;
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = Channel::default();
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.events().watch(req, "calendarId")
.updated_min("no")
.time_zone("nonumy")
.time_min("sed")
.time_max("kasd")
.sync_token("Lorem")
.single_events(true)
.show_hidden_invitations(false)
.show_deleted(true)
.add_shared_extended_property("tempor")
.q("dolore")
.add_private_extended_property("eos")
.page_token("amet.")
.order_by("dolore")
.max_results(-97)
.max_attendees(-37)
.i_cal_uid("At")
.always_include_email(true)
.doit().await;
Implementations
sourceimpl<'a> EventWatchCall<'a>
impl<'a> EventWatchCall<'a>
sourcepub async fn doit(self) -> Result<(Response<Body>, Channel)>
pub async fn doit(self) -> Result<(Response<Body>, Channel)>
Perform the operation you have build so far.
sourcepub fn request(self, new_value: Channel) -> EventWatchCall<'a>
pub fn request(self, new_value: Channel) -> EventWatchCall<'a>
Sets the request property to the given value.
Even though the property as already been set when instantiating this call, we provide this method for API completeness.
sourcepub fn calendar_id(self, new_value: &str) -> EventWatchCall<'a>
pub fn calendar_id(self, new_value: &str) -> EventWatchCall<'a>
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.
Sets the calendar id path property to the given value.
Even though the property as already been set when instantiating this call, we provide this method for API completeness.
sourcepub fn updated_min(self, new_value: &str) -> EventWatchCall<'a>
pub fn updated_min(self, new_value: &str) -> EventWatchCall<'a>
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.
Sets the updated min query property to the given value.
sourcepub fn time_zone(self, new_value: &str) -> EventWatchCall<'a>
pub fn time_zone(self, new_value: &str) -> EventWatchCall<'a>
Time zone used in the response. Optional. The default is the time zone of the calendar.
Sets the time zone query property to the given value.
sourcepub fn time_min(self, new_value: &str) -> EventWatchCall<'a>
pub fn time_min(self, new_value: &str) -> EventWatchCall<'a>
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.
Sets the time min query property to the given value.
sourcepub fn time_max(self, new_value: &str) -> EventWatchCall<'a>
pub fn time_max(self, new_value: &str) -> EventWatchCall<'a>
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.
Sets the time max query property to the given value.
sourcepub fn sync_token(self, new_value: &str) -> EventWatchCall<'a>
pub fn sync_token(self, new_value: &str) -> EventWatchCall<'a>
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.
Sets the sync token query property to the given value.
sourcepub fn single_events(self, new_value: bool) -> EventWatchCall<'a>
pub fn single_events(self, new_value: bool) -> EventWatchCall<'a>
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.
Sets the single events query property to the given value.
Whether to include hidden invitations in the result. Optional. The default is False.
Sets the show hidden invitations query property to the given value.
sourcepub fn show_deleted(self, new_value: bool) -> EventWatchCall<'a>
pub fn show_deleted(self, new_value: bool) -> EventWatchCall<'a>
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.
Sets the show deleted query property to the given value.
Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.
Append the given value to the shared extended property query property. Each appended value will retain its original ordering and be ‘/’-separated in the URL’s parameters.
sourcepub fn q(self, new_value: &str) -> EventWatchCall<'a>
pub fn q(self, new_value: &str) -> EventWatchCall<'a>
Free text search terms to find events that match these terms in any field, except for extended properties. Optional.
Sets the q query property to the given value.
sourcepub fn add_private_extended_property(
self,
new_value: &str
) -> EventWatchCall<'a>
pub fn add_private_extended_property(
self,
new_value: &str
) -> EventWatchCall<'a>
Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.
Append the given value to the private extended property query property. Each appended value will retain its original ordering and be ‘/’-separated in the URL’s parameters.
sourcepub fn page_token(self, new_value: &str) -> EventWatchCall<'a>
pub fn page_token(self, new_value: &str) -> EventWatchCall<'a>
Token specifying which result page to return. Optional.
Sets the page token query property to the given value.
sourcepub fn order_by(self, new_value: &str) -> EventWatchCall<'a>
pub fn order_by(self, new_value: &str) -> EventWatchCall<'a>
The order of the events returned in the result. Optional. The default is an unspecified, stable order.
Sets the order by query property to the given value.
sourcepub fn max_results(self, new_value: i32) -> EventWatchCall<'a>
pub fn max_results(self, new_value: i32) -> EventWatchCall<'a>
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.
Sets the max results query property to the given value.
sourcepub fn max_attendees(self, new_value: i32) -> EventWatchCall<'a>
pub fn max_attendees(self, new_value: i32) -> EventWatchCall<'a>
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.
Sets the max attendees query property to the given value.
sourcepub fn i_cal_uid(self, new_value: &str) -> EventWatchCall<'a>
pub fn i_cal_uid(self, new_value: &str) -> EventWatchCall<'a>
Specifies event ID in the iCalendar format to be included in the response. Optional.
Sets the i cal uid query property to the given value.
sourcepub fn always_include_email(self, new_value: bool) -> EventWatchCall<'a>
pub fn always_include_email(self, new_value: bool) -> EventWatchCall<'a>
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).
Sets the always include email query property to the given value.
sourcepub fn delegate(self, new_value: &'a mut dyn Delegate) -> EventWatchCall<'a>
pub fn delegate(self, new_value: &'a mut dyn Delegate) -> EventWatchCall<'a>
The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.
It should be used to handle progress information, and to implement a certain level of resilience.
Sets the delegate property to the given value.
sourcepub fn param<T>(self, name: T, value: T) -> EventWatchCall<'a> where
T: AsRef<str>,
pub fn param<T>(self, name: T, value: T) -> EventWatchCall<'a> where
T: AsRef<str>,
Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.
Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.
Additional Parameters
- alt (query-string) - Data format for the response.
- fields (query-string) - Selector specifying which fields to include in a partial response.
- key (query-string) - 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.
- oauth_token (query-string) - OAuth 2.0 token for the current user.
- prettyPrint (query-boolean) - Returns response with indentations and line breaks.
- quotaUser (query-string) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- userIp (query-string) - Deprecated. Please use quotaUser instead.
sourcepub fn add_scope<T, S>(self, scope: T) -> EventWatchCall<'a> where
T: Into<Option<S>>,
S: AsRef<str>,
pub fn add_scope<T, S>(self, scope: T) -> EventWatchCall<'a> where
T: Into<Option<S>>,
S: AsRef<str>,
Identifies the authorization scope for the method you are building.
Use this method to actively specify which scope should be used, instead the default Scope
variant
Scope::Full
.
The scope
will be added to a set of scopes. This is important as one can maintain access
tokens for more than one scope.
If None
is specified, then all scopes will be removed and no default scope will be used either.
In that case, you have to specify your API-key using the key
parameter (see the param()
function for details).
Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.
Trait Implementations
impl<'a> CallBuilder for EventWatchCall<'a>
Auto Trait Implementations
impl<'a> !RefUnwindSafe for EventWatchCall<'a>
impl<'a> Send for EventWatchCall<'a>
impl<'a> !Sync for EventWatchCall<'a>
impl<'a> Unpin for EventWatchCall<'a>
impl<'a> !UnwindSafe for EventWatchCall<'a>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more