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
//! Types for the *m.room.third_party_invite* event. use ruma_events_macros::EventContent; use serde::{Deserialize, Serialize}; use crate::StateEvent; /// An invitation to a room issued to a third party identifier, rather than a matrix user ID. /// /// Acts as an *m.room.member* invite event, where there isn't a target user_id to invite. This /// event contains a token and a public key whose private key must be used to sign the token. /// Any user who can present that signature may use this invitation to join the target room. pub type ThirdPartyInviteEvent = StateEvent<ThirdPartyInviteEventContent>; /// The payload for `ThirdPartyInviteEvent`. #[derive(Clone, Debug, Deserialize, Serialize, EventContent)] #[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)] #[ruma_event(type = "m.room.third_party_invite", kind = State)] pub struct ThirdPartyInviteEventContent { /// A user-readable string which represents the user who has been invited. /// /// If you activate the `compat` feature, this field being absent in JSON will give you an /// empty string here. #[cfg_attr(feature = "compat", serde(default))] pub display_name: String, /// A URL which can be fetched to validate whether the key has been revoked. /// /// If you activate the `compat` feature, this field being absent in JSON will give you an /// empty string here. #[cfg_attr(feature = "compat", serde(default))] pub key_validity_url: String, /// A Base64-encoded Ed25519 key with which the token must be signed. /// /// If you activate the `compat` feature, this field being absent in JSON will give you an /// empty string here. #[cfg_attr(feature = "compat", serde(default))] pub public_key: String, /// Keys with which the token may be signed. #[serde(skip_serializing_if = "Option::is_none")] pub public_keys: Option<Vec<PublicKey>>, } impl ThirdPartyInviteEventContent { /// Creates a new `ThirdPartyInviteEventContent` with the given display name, key validity url /// and public key. pub fn new(display_name: String, key_validity_url: String, public_key: String) -> Self { Self { display_name, key_validity_url, public_key, public_keys: None } } } /// A public key for signing a third party invite token. #[derive(Clone, Debug, Deserialize, Serialize)] #[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)] pub struct PublicKey { /// An optional URL which can be fetched to validate whether the key has been revoked. /// /// The URL must return a JSON object containing a boolean property named 'valid'. /// If this URL is absent, the key must be considered valid indefinitely. #[serde(skip_serializing_if = "Option::is_none")] pub key_validity_url: Option<String>, /// A Base64-encoded Ed25519 key with which the token must be signed. pub public_key: String, } impl PublicKey { /// Creates a new `PublicKey` with the given base64-encoded ed25519 key. pub fn new(public_key: String) -> Self { Self { key_validity_url: None, public_key } } }