Struct ruma_events::room::third_party_invite::RoomThirdPartyInviteEventContent

#[non_exhaustive]
pub struct RoomThirdPartyInviteEventContent {
    pub display_name: String,
    pub key_validity_url: String,
    pub public_key: Base64,
    pub public_keys: Option<Vec<PublicKey>>,
}

The content of an m.room.third_party_invite event.

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

display_name: String

A user-readable string which represents the user who has been invited.

If the compat-optional feature is enabled, this field being absent in JSON will result in an empty string instead of an error when deserializing.

key_validity_url: String

A URL which can be fetched to validate whether the key has been revoked.

If the compat-optional feature is enabled, this field being absent in JSON will result in an empty string instead of an error when deserializing.

public_key: Base64

A base64-encoded Ed25519 key with which the token must be signed.

If the compat-optional feature is enabled, this field being absent in JSON will result in an empty string instead of an error when deserializing.

public_keys: Option<Vec<PublicKey>>

Keys with which the token may be signed.

Implementations

impl RoomThirdPartyInviteEventContent

pub fn new( display_name: String, key_validity_url: String, public_key: Base64, ) -> Self

Creates a new RoomThirdPartyInviteEventContent with the given display name, key validity url and public key.

Trait Implementations

impl Clone for RoomThirdPartyInviteEventContent

fn clone(&self) -> RoomThirdPartyInviteEventContent

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RoomThirdPartyInviteEventContent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RoomThirdPartyInviteEventContent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EventContent for RoomThirdPartyInviteEventContent

type EventType = StateEventType

The Rust enum for the event kind’s known types.

fn event_type(&self) -> Self::EventType

Get the event’s type, like m.room.message.

impl From<RoomThirdPartyInviteEventContent> for AnyStateEventContent

fn from(c: RoomThirdPartyInviteEventContent) -> Self

Converts to this type from the input type.

impl RedactContent for RoomThirdPartyInviteEventContent

type Redacted = RedactedRoomThirdPartyInviteEventContent

The redacted form of the event’s content.

fn redact( self, version: &RoomVersionId, ) -> RedactedRoomThirdPartyInviteEventContent

Transform self into a redacted form (removing most or all fields) according to the spec.

impl Serialize for RoomThirdPartyInviteEventContent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StateEventContent for RoomThirdPartyInviteEventContent

type StateKey = String

The type of the event’s state_key field.

impl StaticEventContent for RoomThirdPartyInviteEventContent

const TYPE: &'static str = "m.room.third_party_invite"

The event type.

impl StaticStateEventContent for RoomThirdPartyInviteEventContent

type PossiblyRedacted = PossiblyRedactedRoomThirdPartyInviteEventContent

The possibly redacted form of the event’s content.

type Unsigned = StateUnsigned<<RoomThirdPartyInviteEventContent as StaticStateEventContent>::PossiblyRedacted>

The type of the event’s unsigned field.