Struct ruma_common::events::room::member::RoomMemberEventContent
source · [−]pub struct RoomMemberEventContent {
pub avatar_url: Option<OwnedMxcUri>,
pub displayname: Option<String>,
pub is_direct: Option<bool>,
pub membership: MembershipState,
pub third_party_invite: Option<ThirdPartyInvite>,
pub blurhash: Option<String>,
pub reason: Option<String>,
pub join_authorized_via_users_server: Option<OwnedUserId>,
}
events
only.Expand description
The content of an m.room.member
event.
The current membership state of a user in the room.
Adjusts the membership state for a user in a room. It is preferable to use the membership
APIs (/rooms/<room id>/invite
etc) when performing membership actions rather than
adjusting the state directly as there are a restricted set of valid transformations. For
example, user A cannot force user B to join a room, and trying to force this state change
directly will fail.
This event may also include an invite_room_state
key inside the event’s unsigned data, but
Ruma doesn’t currently expose this; see #998.
The user for which a membership applies is represented by the state_key
. Under some
conditions, the sender
and state_key
may not match - this may be interpreted as the
sender
affecting the membership state of the state_key
user.
The membership for a given user can change over time. Previous membership can be retrieved
from the prev_content
object on an event. If not present, the user’s previous membership
must be assumed as leave.
Fields
avatar_url: Option<OwnedMxcUri>
The avatar URL for this user, if any.
This is added by the homeserver. If you activate the compat
feature, this field being an
empty string in JSON will result in None
here during deserialization.
displayname: Option<String>
The display name for this user, if any.
This is added by the homeserver.
is_direct: Option<bool>
Flag indicating whether the room containing this event was created with the intention of being a direct chat.
membership: MembershipState
The membership state of this user.
third_party_invite: Option<ThirdPartyInvite>
If this member event is the successor to a third party invitation, this field will contain information about that invitation.
blurhash: Option<String>
unstable-msc2448
only.reason: Option<String>
User-supplied text for why their membership has changed.
For kicks and bans, this is typically the reason for the kick or ban. For other membership changes, this is a way for the user to communicate their intent without having to send a message to the room, such as in a case where Bob rejects an invite from Alice about an upcoming concert, but can’t make it that day.
Clients are not recommended to show this reason to users when receiving an invite due to the potential for spam and abuse. Hiding the reason behind a button or other component is recommended.
Arbitrarily chosen UserId
(MxID) of a local user who can send an invite.
Implementations
sourceimpl RoomMemberEventContent
impl RoomMemberEventContent
sourcepub fn new(membership: MembershipState) -> Self
pub fn new(membership: MembershipState) -> Self
Creates a new RoomMemberEventContent
with the given membership state.
sourcepub fn details(&self) -> MembershipDetails<'_>
pub fn details(&self) -> MembershipDetails<'_>
Obtain the details about this event that are required to calculate a membership change.
This is required when you want to calculate the change a redacted m.room.member
event
made.
Trait Implementations
sourceimpl Clone for RoomMemberEventContent
impl Clone for RoomMemberEventContent
sourcefn clone(&self) -> RoomMemberEventContent
fn clone(&self) -> RoomMemberEventContent
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl Debug for RoomMemberEventContent
impl Debug for RoomMemberEventContent
sourceimpl<'de> Deserialize<'de> for RoomMemberEventContent
impl<'de> Deserialize<'de> for RoomMemberEventContent
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
sourceimpl EventContent for RoomMemberEventContent
impl EventContent for RoomMemberEventContent
type EventType = StateEventType
type EventType = StateEventType
sourcefn event_type(&self) -> Self::EventType
fn event_type(&self) -> Self::EventType
m.room.message
.sourceimpl From<RoomMemberEventContent> for AnyStateEventContent
impl From<RoomMemberEventContent> for AnyStateEventContent
sourcefn from(c: RoomMemberEventContent) -> Self
fn from(c: RoomMemberEventContent) -> Self
sourceimpl RedactContent for RoomMemberEventContent
impl RedactContent for RoomMemberEventContent
type Redacted = RedactedRoomMemberEventContent
type Redacted = RedactedRoomMemberEventContent
sourcefn redact(self, _version: &RoomVersionId) -> RedactedRoomMemberEventContent
fn redact(self, _version: &RoomVersionId) -> RedactedRoomMemberEventContent
self
into a redacted form (removing most or all fields) according to the spec. Read moresourceimpl Serialize for RoomMemberEventContent
impl Serialize for RoomMemberEventContent
sourceimpl StateEventContent for RoomMemberEventContent
impl StateEventContent for RoomMemberEventContent
type StateKey = OwnedUserId
type StateKey = OwnedUserId
state_key
field.type Unsigned = RoomMemberUnsigned
type Unsigned = RoomMemberUnsigned
unsigned
field.