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

Index

Constructors

Properties

definition filterId? roomFilter? roomTimelineFilter? userId LAZY_LOADING_MESSAGES_FILTER

Methods

filterRoomTimeline getDefinition getFilterId getRoomTimelineFilterComponent setDefinition setIncludeLeaveRooms setLazyLoadMembers setTimelineLimit setUnreadThreadNotifications fromJson

Constructors

constructor

new Filter(userId: undefined | null | string, filterId?: string): Filter
Parameters
- userId: undefined | null | string
- Optional filterId: string
Returns Filter
- Defined in src/filter.ts:113

Properties

`Private` definition

definition: IFilterDefinition = {}

`Optional` filterId

filterId?: string

`Private` `Optional` roomFilter

roomFilter?: FilterComponent

`Private` `Optional` roomTimelineFilter

roomTimelineFilter?: FilterComponent

`Readonly` userId

userId: undefined | null | string

`Static` LAZY_LOADING_MESSAGES_FILTER

LAZY_LOADING_MESSAGES_FILTER: {
lazy_load_members: boolean;
} = ...

Type declaration

lazy_load_members: boolean

Methods

filterRoomTimeline

filterRoomTimeline(events: MatrixEvent[]): MatrixEvent[]
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[]
- Defined in src/filter.ts:214

getDefinition

getDefinition(): IFilterDefinition
Get the JSON body of the filter.

Returns
The filter definition

Returns IFilterDefinition
- Defined in src/filter.ts:127

getFilterId

getFilterId(): undefined | string
Get the ID of this filter on your homeserver (if known)

Returns
The filter ID

Returns undefined | string
- Defined in src/filter.ts:119

getRoomTimelineFilterComponent

getRoomTimelineFilterComponent(): undefined | FilterComponent
Get the room.timeline filter component of the filter

Returns
room timeline filter component

Returns undefined | FilterComponent
- Defined in src/filter.ts:204

setDefinition

setDefinition(definition: IFilterDefinition): void
Set the JSON body of the filter
Parameters
- definition: IFilterDefinition
  
  The filter definition
Returns void
- Defined in src/filter.ts:135

setIncludeLeaveRooms

setIncludeLeaveRooms(includeLeave: boolean): void
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
- Defined in src/filter.ts:258

setLazyLoadMembers

setLazyLoadMembers(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
- Defined in src/filter.ts:249

setTimelineLimit

setTimelineLimit(limit: number): 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
- Defined in src/filter.ts:228

setUnreadThreadNotifications

setUnreadThreadNotifications(enabled: boolean): void
Enable threads unread notification
Parameters
- enabled: boolean
Returns void
- Defined in src/filter.ts:236

`Static` fromJson

fromJson(userId: undefined | null | string, filterId: string, jsonObj: IFilterDefinition): Filter
Create a filter from existing data.

Static

Returns
Parameters
- userId: undefined | null | string
- filterId: string
- jsonObj: IFilterDefinition
Returns Filter
- Defined in src/filter.ts:103

Generated using TypeDoc