Type Alias ruma_events::room::member::OriginalRoomMemberEvent

pub type OriginalRoomMemberEvent = OriginalStateEvent<RoomMemberEventContent>;

An m.room.member event.

Aliased Type

struct OriginalRoomMemberEvent {
    pub content: RoomMemberEventContent,
    pub event_id: OwnedEventId,
    pub sender: OwnedUserId,
    pub origin_server_ts: MilliSecondsSinceUnixEpoch,
    pub room_id: OwnedRoomId,
    pub state_key: OwnedUserId,
    pub unsigned: RoomMemberUnsigned,
}

Fields

content: RoomMemberEventContent

Data specific to the event type.

event_id: OwnedEventId

The globally unique event identifier for the user who sent the event.

sender: OwnedUserId

The fully-qualified ID of the user who sent this event.

origin_server_ts: MilliSecondsSinceUnixEpoch

Timestamp in milliseconds on originating homeserver when this event was sent.

room_id: OwnedRoomId

The ID of the room associated with this event.

state_key: OwnedUserId

A unique key which defines the overwriting semantics for this piece of room state.

This is often an empty string, but some events send a UserId to show which user the event affects.

unsigned: RoomMemberUnsigned

Additional key-value pairs not signed by the homeserver.

Implementations

impl OriginalRoomMemberEvent

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.

pub fn prev_content(&self) -> Option<&RoomMemberEventContent>

Get a reference to the prev_content in unsigned, if it exists.

Shorthand for event.unsigned.prev_content.as_ref()

pub fn membership_change(&self) -> MembershipChange<'_>

Helper function for membership change.

Check the specification for details.