Class Filter

Construct a new Filter.

Param

The user ID for this filter.

Param

The filter ID if known.

Prop

The user ID of the filter

Prop

The filter ID

Hierarchy

  • Filter

Constructors

  • Parameters

    • userId: undefined | null | string
    • Optional filterId: string

    Returns Filter

Properties

definition: IFilterDefinition = {}
filterId?: string
roomFilter?: FilterComponent
roomTimelineFilter?: FilterComponent
userId: undefined | null | string
LAZY_LOADING_MESSAGES_FILTER: {
    lazy_load_members: boolean;
} = ...

Type declaration

  • lazy_load_members: boolean

Methods

  • Filter the list of events based on whether they are allowed in a timeline based on this filter

    Returns

    the list of events which match the filter

    Parameters

    • events: MatrixEvent[]

      the list of events being filtered

    Returns MatrixEvent[]

  • Get the ID of this filter on your homeserver (if known)

    Returns

    The filter ID

    Returns undefined | string

  • Control whether left rooms should be included in responses.

    Parameters

    • includeLeave: boolean

      True to make rooms the user has left appear in responses.

    Returns void

  • Parameters

    • enabled: boolean

    Returns void

  • Set the max number of events to return for each room's timeline.

    Parameters

    • limit: number

      The max number of events to return for each room.

    Returns void

  • Enable threads unread notification

    Parameters

    • enabled: boolean

    Returns void

Generated using TypeDoc