Merge pull request #810 from gnunicorn/expose-invite-details

feat(sdk): Expose details of invite for invited room

Author: gnunicorn

Diff for: crates/matrix-sdk-base/src/rooms/members.rs

@@ -46,6 +46,11 @@ impl RoomMember {
         self.event.user_id()
     }
 
+    /// Get the original member event
+    pub fn event(&self) -> &Arc<MemberEvent> {
+        &self.event
+    }
+
     /// Get the display name of the member if there is one.
     pub fn display_name(&self) -> Option<&str> {
         if let Some(p) = self.profile.as_ref() {

Diff for: crates/matrix-sdk-common/src/deserialized_responses.rs

@@ -1,4 +1,4 @@
-use std::collections::BTreeMap;
+use std::{borrow::Borrow, collections::BTreeMap};
 
 use ruma::{
     api::client::{
@@ -16,7 +16,8 @@ use ruma::{
         AnyRoomEvent, AnySyncRoomEvent,
     },
     serde::Raw,
-    DeviceKeyAlgorithm, OwnedDeviceId, OwnedEventId, OwnedRoomId, OwnedUserId, UserId,
+    DeviceKeyAlgorithm, EventId, MilliSecondsSinceUnixEpoch, OwnedDeviceId, OwnedEventId,
+    OwnedRoomId, OwnedUserId, UserId,
 };
 use serde::{Deserialize, Serialize};
 
@@ -312,6 +313,27 @@ impl MemberEvent {
             MemberEvent::Stripped(e) => Some(&e.content),
         }
     }
+    /// The sender of this event.
+    pub fn sender(&self) -> &UserId {
+        match self {
+            MemberEvent::Sync(e) => e.sender(),
+            MemberEvent::Stripped(e) => e.sender.borrow(),
+        }
+    }
+    /// The ID of this event.
+    pub fn event_id(&self) -> Option<&EventId> {
+        match self {
+            MemberEvent::Sync(e) => Some(e.event_id()),
+            MemberEvent::Stripped(_) => None,
+        }
+    }
+    /// The Server Timestamp of this event.
+    pub fn origin_server_ts(&self) -> Option<MilliSecondsSinceUnixEpoch> {
+        match self {
+            MemberEvent::Sync(e) => Some(e.origin_server_ts()),
+            MemberEvent::Stripped(_) => None,
+        }
+    }
 
     /// The membership state of the user
     pub fn membership(&self) -> &MembershipState {

Diff for: crates/matrix-sdk/src/room/invited.rs

@@ -1,7 +1,8 @@
 use std::ops::Deref;
 
-use crate::{room::Common, BaseRoom, Client, Result, RoomType};
+use thiserror::Error;
 
+use crate::{room::Common, BaseRoom, Client, Error, Result, RoomMember, RoomType};
 /// A room in the invited state.
 ///
 /// This struct contains all methods specific to a `Room` with type
@@ -12,6 +13,24 @@ pub struct Invited {
     pub(crate) inner: Common,
 }
 
+/// Details of the (latest) invite.
+#[derive(Debug, Clone)]
+pub struct Invite {
+    /// Who has been invited.
+    pub invitee: RoomMember,
+    /// Who sent the invite.
+    pub inviter: Option<RoomMember>,
+}
+
+#[derive(Error, Debug)]
+pub enum InvitationError {
+    /// The client isn't logged in.
+    #[error("The client isn't authenticated")]
+    NotAuthenticated,
+    #[error("No membership event found")]
+    EventMissing,
+}
+
 impl Invited {
     /// Create a new `room::Invited` if the underlying `Room` has type
     /// `RoomType::Invited`.
@@ -38,6 +57,24 @@ impl Invited {
     pub async fn accept_invitation(&self) -> Result<()> {
         self.inner.join().await
     }
+
+    /// The membership details of the (latest) invite for this room.
+    pub async fn invite_details(&self) -> Result<Invite> {
+        let user_id = self
+            .inner
+            .client
+            .user_id()
+            .ok_or_else(|| Error::UnknownError(Box::new(InvitationError::NotAuthenticated)))?;
+        let invitee = self
+            .inner
+            .get_member(user_id)
+            .await?
+            .ok_or_else(|| Error::UnknownError(Box::new(InvitationError::EventMissing)))?;
+        let event = invitee.event();
+        let inviter_id = event.sender();
+        let inviter = self.inner.get_member(inviter_id).await?;
+        Ok(Invite { invitee, inviter })
+    }
 }
 
 impl Deref for Invited {