Struct RelationsOptions

pub struct RelationsOptions {
    pub from: Option<String>,
    pub dir: Direction,
    pub limit: Option<UInt>,
    pub include_relations: IncludeRelations,
    pub recurse: bool,
}

Options for messages.

Fields

from: Option<String>

The token to start returning events from.

This token can be obtained from a Relations::prev_batch_token returned by a previous call to super::Room::relations().

If from isn’t provided the homeserver shall return a list of thread roots from end of the timeline history.

dir: Direction

The direction to return events in.

Defaults to backwards.

limit: Option<UInt>

The maximum number of events to return.

Default: 10.

include_relations: IncludeRelations

Optional restrictions on the relations to include based on their type or event type.

Defaults to all relations.

recurse: bool

Whether to include events which relate indirectly to the given event.

These are events related to the given event via two or more direct relationships.

Trait Implementations

impl Clone for RelationsOptions

fn clone(&self) -> RelationsOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RelationsOptions

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

Formats the value using the given formatter.

impl Default for RelationsOptions

fn default() -> RelationsOptions

Returns the “default value” for a type.