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

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

#[derive(Serialize, Deserialize, Debug)]
pub struct Params {
    /// Tour ID
    #[serde(rename = "tourid")]
    pub r#tourid: Option<i64>,
    /// Context ID
    #[serde(rename = "context")]
    pub r#context: Option<i64>,
    /// Page URL
    #[serde(rename = "pageurl")]
    pub r#pageurl: Option<String>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct ReturnsTourconfigStepsItem {
    /// Step Title
    #[serde(rename = "title")]
    pub r#title: Option<String>,
    /// Step Content
    #[serde(rename = "content")]
    pub r#content: Option<String>,
    /// Step Target
    #[serde(rename = "element")]
    pub r#element: Option<String>,
    /// Step Placement
    #[serde(rename = "placement")]
    pub r#placement: Option<String>,
    /// Delay before showing the step (ms)
    #[serde(rename = "delay")]
    pub r#delay: Option<i64>,
    /// Whether a backdrop should be used
    #[serde(rename = "backdrop")]
    pub r#backdrop: Option<bool>,
    /// Whether to move to the next step when the target element is clicked
    #[serde(rename = "reflex")]
    pub r#reflex: Option<bool>,
    /// Whether to display the step even if it could not be found
    #[serde(rename = "orphan")]
    pub r#orphan: Option<bool>,
    /// The actual ID of the step
    #[serde(rename = "stepid")]
    pub r#stepid: Option<i64>,
}

pub type r#ReturnsTourconfigSteps = Vec<ReturnsTourconfigStepsItem>;

/// Tour config
#[derive(Serialize, Deserialize, Debug)]
pub struct ReturnsTourconfig {
    /// Tour Name
    #[serde(rename = "name")]
    pub r#name: Option<String>,
    #[serde(rename = "steps")]
    pub r#steps: Option<r#ReturnsTourconfigSteps>,
    /// Label of the end tour button
    #[serde(rename = "endtourlabel")]
    pub r#endtourlabel: Option<String>,
    /// display step number
    #[serde(rename = "displaystepnumbers")]
    pub r#displaystepnumbers: Option<bool>,
}

#[derive(Serialize, Deserialize, Debug)]
pub struct Returns {
    /// Tour config
    #[serde(rename = "tourconfig")]
    pub r#tourconfig: Option<ReturnsTourconfig>,
}

pub async fn call<'a>(
    client: &'a mut moodle_client::MoodleClient,
    params: &'a mut Params,
) -> anyhow::Result<Returns> {
    let json = client
        .post("tool_usertours_fetch_and_start_tour", 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("tool_usertours_fetch_and_start_tour", params)
        .await
}