134 lines
4.2 KiB
Rust
134 lines
4.2 KiB
Rust
//! [PUT /_matrix/federation/v1/invite/{roomId}/{eventId}](https://matrix.org/docs/spec/server_server/r0.1.4#put-matrix-federation-v1-invite-roomid-eventid)
|
|
|
|
use ruma_api::ruma_api;
|
|
use ruma_common::MilliSecondsSinceUnixEpoch;
|
|
use ruma_events::{pdu::Pdu, room::member::MemberEventContent, AnyStrippedStateEvent, EventType};
|
|
use ruma_identifiers::{EventId, RoomId, ServerName, UserId};
|
|
use ruma_serde::Raw;
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
ruma_api! {
|
|
metadata: {
|
|
description: "Invites a remote user to a room.",
|
|
method: PUT,
|
|
name: "create_invite",
|
|
path: "/_matrix/federation/v1/invite/:room_id/:event_id",
|
|
rate_limited: false,
|
|
authentication: ServerSignatures,
|
|
}
|
|
|
|
request: {
|
|
/// The room ID that the user is being invited to.
|
|
#[ruma_api(path)]
|
|
pub room_id: &'a RoomId,
|
|
|
|
/// The event ID for the invite event, generated by the inviting server.
|
|
#[ruma_api(path)]
|
|
pub event_id: &'a EventId,
|
|
|
|
/// The matrix ID of the user who sent the original `m.room.third_party_invite`.
|
|
pub sender: &'a UserId,
|
|
|
|
/// The name of the inviting homeserver.
|
|
pub origin: &'a ServerName,
|
|
|
|
/// A timestamp added by the inviting homeserver.
|
|
pub origin_server_ts: MilliSecondsSinceUnixEpoch,
|
|
|
|
/// The value `m.room.member`.
|
|
#[serde(rename = "type")]
|
|
pub kind: EventType,
|
|
|
|
/// The user ID of the invited member.
|
|
pub state_key: &'a UserId,
|
|
|
|
/// The content of the event.
|
|
pub content: MemberEventContent,
|
|
|
|
/// Information included alongside the event that is not signed.
|
|
#[serde(default, skip_serializing_if = "UnsignedEventContent::is_empty")]
|
|
pub unsigned: UnsignedEventContent,
|
|
}
|
|
|
|
response: {
|
|
/// The signed invite event.
|
|
#[ruma_api(body)]
|
|
#[serde(with = "crate::serde::v1_pdu")]
|
|
pub event: Raw<Pdu>,
|
|
}
|
|
}
|
|
|
|
/// Information included alongside an event that is not signed.
|
|
#[derive(Clone, Debug, Default, Serialize, Deserialize)]
|
|
#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
|
|
pub struct UnsignedEventContent {
|
|
/// An optional list of simplified events to help the receiver of the invite identify the room.
|
|
/// The recommended events to include are the join rules, canonical alias, avatar, and name of
|
|
/// the room.
|
|
#[serde(skip_serializing_if = "<[_]>::is_empty")]
|
|
pub invite_room_state: Vec<Raw<AnyStrippedStateEvent>>,
|
|
}
|
|
|
|
impl UnsignedEventContent {
|
|
/// Creates an empty `UnsignedEventContent`.
|
|
pub fn new() -> Self {
|
|
Default::default()
|
|
}
|
|
|
|
/// Checks whether all of the fields are empty.
|
|
pub fn is_empty(&self) -> bool {
|
|
self.invite_room_state.is_empty()
|
|
}
|
|
}
|
|
|
|
/// Initial set of fields of `Request`.
|
|
pub struct RequestInit<'a> {
|
|
/// The room ID that the user is being invited to.
|
|
pub room_id: &'a RoomId,
|
|
|
|
/// The event ID for the invite event, generated by the inviting server.
|
|
pub event_id: &'a EventId,
|
|
|
|
/// The matrix ID of the user who sent the original `m.room.third_party_invite`.
|
|
pub sender: &'a UserId,
|
|
|
|
/// The name of the inviting homeserver.
|
|
pub origin: &'a ServerName,
|
|
|
|
/// A timestamp added by the inviting homeserver.
|
|
pub origin_server_ts: MilliSecondsSinceUnixEpoch,
|
|
|
|
/// The user ID of the invited member.
|
|
pub state_key: &'a UserId,
|
|
|
|
/// The content of the event.
|
|
pub content: MemberEventContent,
|
|
|
|
/// Information included alongside the event that is not signed.
|
|
pub unsigned: UnsignedEventContent,
|
|
}
|
|
|
|
impl<'a> From<RequestInit<'a>> for Request<'a> {
|
|
/// Creates a new `Request` with the given parameters.
|
|
fn from(init: RequestInit<'a>) -> Self {
|
|
Self {
|
|
room_id: init.room_id,
|
|
event_id: init.event_id,
|
|
sender: init.sender,
|
|
origin: init.origin,
|
|
origin_server_ts: init.origin_server_ts,
|
|
kind: EventType::RoomMember,
|
|
state_key: init.state_key,
|
|
content: init.content,
|
|
unsigned: init.unsigned,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl Response {
|
|
/// Creates a new `Response` with the given invite event.
|
|
pub fn new(event: Raw<Pdu>) -> Self {
|
|
Self { event }
|
|
}
|
|
}
|