io_msgraph/v1/rest/users/calendars/
list.rs

1//! List Microsoft Graph calendars (`GET /me/calendars`).
2//!
3//! <https://learn.microsoft.com/en-us/graph/api/user-list-calendars>
4
5use alloc::{format, string::String, vec::Vec};
6
7use io_http::rfc6750::bearer::HttpAuthBearer;
8use log::{debug, trace};
9use serde::{Deserialize, Serialize};
10use url::Url;
11
12use crate::{
13    coroutine::*,
14    msgraph_try,
15    v1::{
16        query::to_query_pairs,
17        rest::users::calendars::MsgraphCalendar,
18        send::{MSGRAPH_API_BASE, MsgraphSend, MsgraphSendError, MsgraphSendOutput, user_path},
19    },
20};
21
22/// One page of calendars (`value` plus the OData paging link).
23#[derive(Debug, Clone, Default, Deserialize, Serialize, Eq, PartialEq)]
24pub struct MsgraphCalendarsListResponse {
25    /// The calendars of the page.
26    #[serde(default)]
27    pub value: Vec<MsgraphCalendar>,
28    /// The URL of the next page, when one exists.
29    #[serde(default, rename = "@odata.nextLink")]
30    pub next_link: Option<String>,
31}
32
33/// OData query parameters for listing calendars.
34#[derive(Debug, Clone, Default, Serialize, Eq, PartialEq)]
35pub struct MsgraphCalendarsListParams<'a> {
36    /// Maximum number of calendars per page (`$top`).
37    #[serde(rename = "$top")]
38    pub top: Option<u32>,
39    /// Number of calendars to skip (`$skip`).
40    #[serde(rename = "$skip")]
41    pub skip: Option<u32>,
42    /// Comma-separated properties to return (`$select`).
43    #[serde(rename = "$select")]
44    pub select: Option<&'a str>,
45    /// OData filter expression (`$filter`).
46    #[serde(rename = "$filter")]
47    pub filter: Option<&'a str>,
48}
49
50/// Lists the Microsoft Graph calendars of the user.
51pub struct MsgraphCalendarsList {
52    send: MsgraphSend<MsgraphCalendarsListResponse>,
53}
54
55impl MsgraphCalendarsList {
56    /// Lists the user's calendars.
57    pub fn new(
58        auth: &HttpAuthBearer,
59        user_id: &str,
60        params: &MsgraphCalendarsListParams,
61    ) -> Result<Self, MsgraphSendError> {
62        debug!("prepare microsoft graph calendars listing");
63        trace!("params: {params:?}");
64
65        let user = user_path(user_id);
66        let mut url = Url::parse(MSGRAPH_API_BASE)?.join(&format!("{user}/calendars"))?;
67        url.query_pairs_mut().extend_pairs(to_query_pairs(params));
68
69        let send = MsgraphSend::get(auth, url);
70
71        Ok(Self { send })
72    }
73}
74
75impl MsgraphCoroutine for MsgraphCalendarsList {
76    type Yield = MsgraphYield;
77    type Return = Result<MsgraphSendOutput<MsgraphCalendarsListResponse>, MsgraphSendError>;
78
79    fn resume(&mut self, arg: Option<&[u8]>) -> MsgraphCoroutineState<Self::Yield, Self::Return> {
80        let out = msgraph_try!(&mut self.send, arg);
81        debug!("calendars listed");
82        trace!("out: {out:?}");
83        MsgraphCoroutineState::Complete(Ok(out))
84    }
85}
io_msgraph/v1/rest/users/calendars/list.rs

io_msgraph/v1/rest/users/calendars/
list.rs
