Struct ruma::events::room::third_party_invite::RoomThirdPartyInviteEventContent

pub struct RoomThirdPartyInviteEventContent {
    pub display_name: String,
    pub key_validity_url: String,
    pub public_key: Base64<Standard, Vec<u8, Global>>,
    pub public_keys: Option<Vec<PublicKey, Global>>,
}

Available on crate feature events only.

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

display_name: String

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 result in an empty string here during deserialization.

key_validity_url: 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 result in an empty string here during deserialization.

public_key: Base64<Standard, Vec<u8, Global>>

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 result in an empty string here during deserialization.

public_keys: Option<Vec<PublicKey, Global>>

Keys with which the token may be signed.

Implementations

impl RoomThirdPartyInviteEventContent

pub fn new(
    display_name: String,
    key_validity_url: String,
    public_key: Base64<Standard, Vec<u8, Global>>
) -> RoomThirdPartyInviteEventContent

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<(), Error>

Formats the value using the given formatter.

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

fn deserialize<__D>(
    __deserializer: __D
) -> Result<RoomThirdPartyInviteEventContent, <__D as Deserializer<'de>>::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
) -> <RoomThirdPartyInviteEventContent as EventContent>::EventType

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

impl From<RoomThirdPartyInviteEventContent> for AnyStateEventContent

fn from(c: RoomThirdPartyInviteEventContent) -> AnyStateEventContent

Converts to this type from the input type.

impl PossiblyRedactedStateEventContent for RoomThirdPartyInviteEventContent

type StateKey = String

The type of the event’s state_key field.

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 as Serializer>::Ok, <__S as Serializer>::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 = RoomThirdPartyInviteEventContent

The possibly redacted form of the event’s content.

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

The type of the event’s unsigned field.