Class FilterComponent

FilterComponent is a section of a Filter definition which defines the types, rooms, senders filters etc to be applied to a particular type of resource. This is all ported over from synapse's Filter object.

N.B. that synapse refers to these as 'Filters', and what js-sdk refers to as 'Filters' are referred to as 'FilterCollections'.

Index

Constructors

Properties

Methods

check filter limit toJSON

Constructors

constructor

new FilterComponent(filterJson, userId?): FilterComponent
Parameters
- filterJson: IFilterComponent
- OptionaluserId: null | string
Returns FilterComponent
- Defined in src/filter-component.ts:65

Properties

`Optional` `Readonly`userId

userId?: null | string

Methods

check

check(event): boolean
Checks with the filter component matches the given event
Parameters
- event: MatrixEvent
  event to be checked against the filter
Returns boolean
true if the event matches the filter
- Defined in src/filter-component.ts:75

filter

filter(events): MatrixEvent[]
Filters a list of events down to those which match this filter component
Parameters
- events: MatrixEvent[]
  Events to be checked against the filter component
Returns MatrixEvent[]
events which matched the filter component
- Defined in src/filter-component.ts:195

limit

limit(): number
Returns the limit field for a given filter component, providing a default of 10 if none is otherwise specified. Cargo-culted from Synapse.

Returns number
the limit for this filter component.
- Defined in src/filter-component.ts:204

toJSON

toJSON(): object
Converts the filter component into the form expected over the wire

Returns object
- Defined in src/filter-component.ts:101