ruma_client_api/
account.rs

Help
1//! Endpoints for account registration and management.
2
3pub mod add_3pid;
4pub mod bind_3pid;
5pub mod change_password;
6pub mod check_registration_token_validity;
7pub mod deactivate;
8pub mod delete_3pid;
9pub mod get_3pids;
10pub mod get_username_availability;
11pub mod register;
12pub mod request_3pid_management_token_via_email;
13pub mod request_3pid_management_token_via_msisdn;
14pub mod request_openid_token;
15pub mod request_password_change_token_via_email;
16pub mod request_password_change_token_via_msisdn;
17pub mod request_registration_token_via_email;
18pub mod request_registration_token_via_msisdn;
19pub mod unbind_3pid;
20pub mod whoami;
21
22use ruma_common::serde::StringEnum;
23use serde::{Deserialize, Serialize};
24
25use crate::PrivOwnedStr;
26
27/// Additional authentication information for requestToken endpoints.
28#[derive(Clone, Debug, Deserialize, Serialize)]
29#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
30pub struct IdentityServerInfo {
31    /// The ID server to send the onward request to as a hostname with an
32    /// appended colon and port number if the port is not the default.
33    pub id_server: String,
34
35    /// Access token previously registered with identity server.
36    pub id_access_token: String,
37}
38
39impl IdentityServerInfo {
40    /// Creates a new `IdentityServerInfo` with the given server name and access token.
41    pub fn new(id_server: String, id_access_token: String) -> Self {
42        Self { id_server, id_access_token }
43    }
44}
45
46/// Possible values for deleting or unbinding 3PIDs.
47#[doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/src/doc/string_enum.md"))]
48#[derive(Clone, StringEnum)]
49#[ruma_enum(rename_all = "kebab-case")]
50#[non_exhaustive]
51pub enum ThirdPartyIdRemovalStatus {
52    /// Either the homeserver couldn't determine the right identity server to contact, or the
53    /// identity server refused the operation.
54    NoSupport,
55
56    /// Success.
57    Success,
58
59    #[doc(hidden)]
60    _Custom(PrivOwnedStr),
61}
ruma_client_api/account.rs

ruma_client_api/
account.rs
