Class Filter

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
Construct a new Filter.
Parameters
- userId: undefined | null | string
  
  The user ID for this filter.
- Optional filterId: string
  
  The filter ID if known.
Returns Filter
- Defined in src/filter.ts:95

Properties

`Private` definition

definition: IFilterDefinition = {}

`Optional` filterId

filterId?: string

The filter ID if known.

`Private` `Optional` roomFilter

roomFilter?: FilterComponent

`Private` `Optional` roomTimelineFilter

roomTimelineFilter?: FilterComponent

`Readonly` userId

userId: undefined | null | string

The user ID for this filter.

`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:196

getDefinition

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

Returns
The filter definition

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

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:101

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:186

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:117

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:239

setLazyLoadMembers

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

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:210

setUnreadThreadNotifications

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

`Static` fromJson

fromJson(userId: undefined | null | string, filterId: string, jsonObj: IFilterDefinition): Filter
Create a filter from existing data.
Parameters
- userId: undefined | null | string
- filterId: string
- jsonObj: IFilterDefinition
Returns Filter
- Defined in src/filter.ts:80

Generated using TypeDoc