Type Alias RoomMemberEvent 

pub type RoomMemberEvent = StateEvent<RoomMemberEventContent>;

An m.room.member event.

Aliased Type

pub enum RoomMemberEvent {
    Original(OriginalStateEvent<RoomMemberEventContent>),
    Redacted(RedactedStateEvent<RedactedRoomMemberEventContent>),
}

Variants

Original(OriginalStateEvent<RoomMemberEventContent>)

Original, unredacted form of the event.

Redacted(RedactedStateEvent<RedactedRoomMemberEventContent>)

Redacted form of the event with minimal fields.

Implementations

impl RoomMemberEvent

pub fn membership(&self) -> &MembershipState

Obtain the membership state, regardless of whether this event is redacted.

pub fn should_redact_events(&self) -> bool

Determines whether the user’s events should be redacted based on their membership.

Using MSC4293, if redact_events is true, the sender is different to the state key, and the membership is ban or leave (kick), true is returned. Otherwise, the flag should be ignored, and false is returned.

Trait Implementations

impl RedactionEvent for RoomMemberEvent

Available on crate feature unstable-msc4293 only.