Struct ThirdPartyInvite

#[non_exhaustive]
pub struct ThirdPartyInvite {
    pub medium: Medium,
    pub address: String,
    pub mxid: OwnedUserId,
    pub room_id: OwnedRoomId,
    pub sender: OwnedUserId,
    pub signed: BTreeMap<OwnedServerName, BTreeMap<OwnedKeyId<SigningKeyAlgorithm, ServerSigningKeyVersion>, String>>,
}

Available on crate feature api and (crate features federation-api-c or federation-api-s) only.

A pending invite the third party identifier has received.

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.

medium: Medium

The type of third party invite issues.

Currently only Medium::Email is used.

address: String

The third party identifier that received the invite.

mxid: OwnedUserId

The now-bound user ID that received the invite.

room_id: OwnedRoomId

The room ID the invite is valid for.

sender: OwnedUserId

The user ID that sent the invite.

signed: BTreeMap<OwnedServerName, BTreeMap<OwnedKeyId<SigningKeyAlgorithm, ServerSigningKeyVersion>, String>>

Signature from the identity server using a long-term private key.

Implementations

impl ThirdPartyInvite

pub fn new( address: String, mxid: OwnedUserId, room_id: OwnedRoomId, sender: OwnedUserId, signed: BTreeMap<OwnedServerName, BTreeMap<OwnedKeyId<SigningKeyAlgorithm, ServerSigningKeyVersion>, String>>, ) -> ThirdPartyInvite

Creates a new third party invite with the given parameters.

Trait Implementations

impl Clone for ThirdPartyInvite

fn clone(&self) -> ThirdPartyInvite

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ThirdPartyInvite

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ThirdPartyInvite

fn deserialize<__D>( __deserializer: __D, ) -> Result<ThirdPartyInvite, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ThirdPartyInvite

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.