Class Filter

constructor

• new Filter(userId, filterId?): 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

Optional filterId

Readonly userId

Static LAZY_LOADING_MESSAGES_FILTER

filterRoomTimeline

• filterRoomTimeline(events): MatrixEvent[]

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

  Parameters

  • events: MatrixEvent[]

    the list of events being filtered

  Returns MatrixEvent[]

  the list of events which match the filter

getDefinition

• getDefinition(): IFilterDefinition

• Get the JSON body of the filter.

  Returns IFilterDefinition

  The filter definition

getFilterId

• getFilterId(): undefined | string

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

  Returns undefined | string

  The filter ID

getRoomTimelineFilterComponent

• getRoomTimelineFilterComponent(): undefined | FilterComponent

• Get the room.timeline filter component of the filter

  Returns undefined | FilterComponent

  room timeline filter component

setDefinition

• setDefinition(definition): void

• Set the JSON body of the filter

  Parameters

  • definition: IFilterDefinition

    The filter definition

  Returns void

setIncludeLeaveRooms

• setIncludeLeaveRooms(includeLeave): 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

setLazyLoadMembers

• setLazyLoadMembers(enabled): void

• Parameters

  • enabled: boolean

  Returns void

setTimelineLimit

• setTimelineLimit(limit): 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

setUnreadThreadNotifications

• setUnreadThreadNotifications(enabled): void

• Enable threads unread notification

  Parameters

  • enabled: boolean

  Returns void

Static fromJson

• fromJson(userId, filterId, jsonObj): Filter

• Create a filter from existing data.

  Parameters

  • userId: undefined | null | string
  • filterId: string
  • jsonObj: IFilterDefinition

  Returns Filter