Struct KnockRequest

pub struct KnockRequest {
    pub event_id: OwnedEventId,
    pub timestamp: Option<UInt>,
    pub member_info: KnockRequestMemberInfo,
    pub is_seen: bool,
    /* private fields */
}

A request to join a room with knock join rule.

Fields

event_id: OwnedEventId

The event id of the event containing knock membership change.

timestamp: Option<UInt>

The timestamp when this request was created.

member_info: KnockRequestMemberInfo

Some general room member info to display.

is_seen: bool

Whether it’s been marked as ‘seen’ by the client.

Implementations

impl KnockRequest

pub fn room_id(&self) -> &RoomId

The room id for the Room from whose access is requested.

pub async fn mark_as_seen(&self) -> Result<(), Error>

Marks the knock request as ‘seen’ so the client can ignore it in the future.

pub async fn accept(&self) -> Result<(), Error>

Accepts the knock request by inviting the user to the room.

pub async fn decline(&self, reason: Option<&str>) -> Result<(), Error>

Declines the knock request by kicking the user from the room, with an optional reason.

pub async fn decline_and_ban(&self, reason: Option<&str>) -> Result<(), Error>

Declines the knock request by banning the user from the room, with an optional reason.

Trait Implementations

impl Clone for KnockRequest

fn clone(&self) -> KnockRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KnockRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.