moodle_api 0.1.0

Moodle Webservice Client in Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

use serde::{self, Deserialize, Serialize};

#[derive(Serialize, Deserialize, Debug)]
pub struct Params {
    /// bigbluebuttonbn instance id
    #[serde(rename = "bigbluebuttonbnid")]
    pub r#bigbluebuttonbnid: Option<i64>,
    /// bigbluebuttonbn group id
    #[serde(rename = "groupid")]
    pub r#groupid: Option<i64>,
    /// update cache ?
    #[serde(rename = "updatecache")]
    pub r#updatecache: Option<bool>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct ReturnsPresentationsItem {
    /// presentation URL
    #[serde(rename = "url")]
    pub r#url: Option<String>,
    /// icon name
    #[serde(rename = "iconname")]
    pub r#iconname: Option<String>,
    /// icon text
    #[serde(rename = "icondesc")]
    pub r#icondesc: Option<String>,
    /// presentation name
    #[serde(rename = "name")]
    pub r#name: Option<String>,
}

pub type r#ReturnsPresentations = Vec<ReturnsPresentationsItem>;

#[derive(Serialize, Deserialize, Debug)]
pub struct ReturnsFeaturesItem {
    /// Feature name.
    #[serde(rename = "name")]
    pub r#name: Option<String>,
    /// Whether the feature is enabled.
    #[serde(rename = "isenabled")]
    pub r#isenabled: Option<bool>,
}

/// List of features for the instance
pub type r#ReturnsFeatures = Vec<ReturnsFeaturesItem>;

#[derive(Serialize, Deserialize, Debug)]
pub struct Returns {
    /// CM id
    #[serde(rename = "cmid")]
    pub r#cmid: Option<i64>,
    /// User limit
    #[serde(rename = "userlimit")]
    pub r#userlimit: Option<i64>,
    /// bigbluebuttonbn instance id
    #[serde(rename = "bigbluebuttonbnid")]
    pub r#bigbluebuttonbnid: Option<String>,
    /// bigbluebuttonbn group id
    #[serde(rename = "groupid")]
    pub r#groupid: Option<i64>,
    /// Meeting id
    #[serde(rename = "meetingid")]
    pub r#meetingid: Option<String>,
    /// Opening time
    #[serde(rename = "openingtime")]
    pub r#openingtime: Option<i64>,
    /// Closing time
    #[serde(rename = "closingtime")]
    pub r#closingtime: Option<i64>,
    /// Status running
    #[serde(rename = "statusrunning")]
    pub r#statusrunning: Option<bool>,
    /// Status closed
    #[serde(rename = "statusclosed")]
    pub r#statusclosed: Option<bool>,
    /// Status open
    #[serde(rename = "statusopen")]
    pub r#statusopen: Option<bool>,
    /// Status message
    #[serde(rename = "statusmessage")]
    pub r#statusmessage: Option<String>,
    /// Started at
    #[serde(rename = "startedat")]
    pub r#startedat: Option<i64>,
    /// Moderator count
    #[serde(rename = "moderatorcount")]
    pub r#moderatorcount: Option<i64>,
    /// Participant count
    #[serde(rename = "participantcount")]
    pub r#participantcount: Option<i64>,
    /// Several moderators ?
    #[serde(rename = "moderatorplural")]
    pub r#moderatorplural: Option<bool>,
    /// Several participants ?
    #[serde(rename = "participantplural")]
    pub r#participantplural: Option<bool>,
    /// Can join
    #[serde(rename = "canjoin")]
    pub r#canjoin: Option<bool>,
    /// Is moderator
    #[serde(rename = "ismoderator")]
    pub r#ismoderator: Option<bool>,
    #[serde(rename = "presentations")]
    pub r#presentations: Option<r#ReturnsPresentations>,
    /// Join URL
    #[serde(rename = "joinurl")]
    pub r#joinurl: Option<String>,
    /// Guest access enabled
    #[serde(rename = "guestaccessenabled")]
    pub r#guestaccessenabled: Option<bool>,
    /// Guest URL
    #[serde(rename = "guestjoinurl")]
    pub r#guestjoinurl: Option<String>,
    /// Guest join password
    #[serde(rename = "guestpassword")]
    pub r#guestpassword: Option<String>,
    /// List of features for the instance
    #[serde(rename = "features")]
    pub r#features: Option<r#ReturnsFeatures>,
}

pub async fn call<'a>(
    client: &'a mut moodle_client::MoodleClient,
    params: &'a mut Params,
) -> anyhow::Result<Returns> {
    let json = client
        .post("mod_bigbluebuttonbn_meeting_info", params)
        .await?;

    serde_json::from_value(json).map_err(|e| e.into())
}

pub async fn call_raw<'a>(
    client: &'a mut moodle_client::MoodleClient,
    params: &'a mut Params,
) -> anyhow::Result<serde_json::Value> {
    client
        .post("mod_bigbluebuttonbn_meeting_info", params)
        .await
}