Struct ruma_events::room::member::MemberEvent
[−]
[src]
pub struct MemberEvent { pub content: MemberEventContent, pub event_id: EventId, pub event_type: EventType, pub prev_content: Option<MemberEventContent>, pub room_id: RoomId, pub state_key: String, pub unsigned: Option<Value>, pub user_id: UserId, pub invite_room_state: Option<Vec<StrippedState>>, }
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.
The third_party_invite property will be set if this invite is an invite event and is the successor of an m.room.third_party_invite event, and absent otherwise.
This event may also include an invite_room_state key outside the content key. If
present, this contains an array of StrippedState
events. These events provide information
on a few select state events such as the room name.
Fields
content: MemberEventContent
The event's content.
event_id: EventId
The unique identifier for the event.
event_type: EventType
The type of the event.
prev_content: Option<MemberEventContent>
The previous content for this state key, if any.
room_id: RoomId
The unique identifier for the room associated with this event.
state_key: String
A key that determines which piece of room state the event represents.
unsigned: Option<Value>
Additional key-value pairs not signed by the homeserver.
user_id: UserId
The unique identifier for the user associated with this event.
invite_room_state: Option<Vec<StrippedState>>
A subset of the state of the room at the time of the invite.
Trait Implementations
impl Clone for MemberEvent
[src]
fn clone(&self) -> MemberEvent
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0
Performs copy-assignment from source
. Read more
impl Debug for MemberEvent
[src]
impl Event for MemberEvent
[src]
type Content = MemberEventContent
The event-type-specific payload this event carries.
fn content(&self) -> &<MemberEvent as Event>::Content
The event's content.
fn event_type(&self) -> &EventType
The type of the event.
fn extra_content(&self) -> Option<Value>
Extra top-level key-value pairs specific to this event type, but that are not under the content
field. Read more
impl RoomEvent for MemberEvent
[src]
fn event_id(&self) -> &EventId
The unique identifier for the event.
fn room_id(&self) -> &RoomId
The unique identifier for the room associated with this event.
fn unsigned(&self) -> Option<&Value>
Additional key-value pairs not signed by the homeserver.
fn user_id(&self) -> &UserId
The unique identifier for the user associated with this event.
impl StateEvent for MemberEvent
[src]
fn prev_content(&self) -> Option<&Self::Content>
The previous content for this state key, if any.
fn state_key(&self) -> &str
A key that determines which piece of room state the event represents.