Struct google_calendar3::api::CalendarListWatchCall [−][src]
Watch for changes to CalendarList resources.
A builder for the watch method supported by a calendarList resource.
It is not used directly, but through a CalendarListMethods
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.calendar_list().watch(req) .sync_token("aliquyam") .show_hidden(true) .show_deleted(true) .page_token("et") .min_access_role("sed") .max_results(-11) .doit().await;
Implementations
impl<'a, C> CalendarListWatchCall<'a, C> where
C: BorrowMut<Client<HttpsConnector<HttpConnector>, Body>>,
[src]
C: BorrowMut<Client<HttpsConnector<HttpConnector>, Body>>,
pub async fn doit(self) -> Result<(Response<Body>, Channel)>
[src]
Perform the operation you have build so far.
pub fn request(self, new_value: Channel) -> CalendarListWatchCall<'a, C>
[src]
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.
pub fn sync_token(self, new_value: &str) -> CalendarListWatchCall<'a, C>
[src]
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. If only read-only fields such as calendar properties or ACLs have changed, the entry won’t be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. 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.
pub fn show_hidden(self, new_value: bool) -> CalendarListWatchCall<'a, C>
[src]
Whether to show hidden entries. Optional. The default is False.
Sets the show hidden query property to the given value.
pub fn show_deleted(self, new_value: bool) -> CalendarListWatchCall<'a, C>
[src]
Whether to include deleted calendar list entries in the result. Optional. The default is False.
Sets the show deleted query property to the given value.
pub fn page_token(self, new_value: &str) -> CalendarListWatchCall<'a, C>
[src]
Token specifying which result page to return. Optional.
Sets the page token query property to the given value.
pub fn min_access_role(self, new_value: &str) -> CalendarListWatchCall<'a, C>
[src]
The minimum access role for the user in the returned entries. Optional. The default is no restriction.
Sets the min access role query property to the given value.
pub fn max_results(self, new_value: i32) -> CalendarListWatchCall<'a, C>
[src]
Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.
Sets the max results query property to the given value.
pub fn delegate(
self,
new_value: &'a mut dyn Delegate
) -> CalendarListWatchCall<'a, C>
[src]
self,
new_value: &'a mut dyn Delegate
) -> CalendarListWatchCall<'a, C>
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.
pub fn param<T>(self, name: T, value: T) -> CalendarListWatchCall<'a, C> where
T: AsRef<str>,
[src]
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.
pub fn add_scope<T, S>(self, scope: T) -> CalendarListWatchCall<'a, C> where
T: Into<Option<S>>,
S: AsRef<str>,
[src]
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, C> CallBuilder for CalendarListWatchCall<'a, C>
[src]
Auto Trait Implementations
impl<'a, C> !RefUnwindSafe for CalendarListWatchCall<'a, C>
impl<'a, C> !Send for CalendarListWatchCall<'a, C>
impl<'a, C> !Sync for CalendarListWatchCall<'a, C>
impl<'a, C> Unpin for CalendarListWatchCall<'a, C>
impl<'a, C> !UnwindSafe for CalendarListWatchCall<'a, C>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,