Filter
Defined in: src/filter.ts:85
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Filter(
userId,filterId?):Filter
Defined in: src/filter.ts:108
Construct a new Filter.
Parameters
Section titled “Parameters”userId
Section titled “userId”string | null | undefined
The user ID for this filter.
filterId?
Section titled “filterId?”string
The filter ID if known.
Returns
Section titled “Returns”Filter
Properties
Section titled “Properties”filterId?
Section titled “filterId?”
optionalfilterId?:string
Defined in: src/filter.ts:110
The filter ID if known.
userId
Section titled “userId”
readonlyuserId:string|null|undefined
Defined in: src/filter.ts:109
The user ID for this filter.
LAZY_LOADING_MESSAGES_FILTER
Section titled “LAZY_LOADING_MESSAGES_FILTER”
staticLAZY_LOADING_MESSAGES_FILTER:object
Defined in: src/filter.ts:86
lazy_load_members
Section titled “lazy_load_members”lazy_load_members:
boolean=true
Methods
Section titled “Methods”filterRoomTimeline()
Section titled “filterRoomTimeline()”filterRoomTimeline(
events):DigitalWorldEvent[]
Defined in: src/filter.ts:212
Filter the list of events based on whether they are allowed in a timeline based on this filter
Parameters
Section titled “Parameters”events
Section titled “events”the list of events being filtered
Returns
Section titled “Returns”the list of events which match the filter
getDefinition()
Section titled “getDefinition()”getDefinition():
IFilterDefinition
Defined in: src/filter.ts:125
Get the JSON body of the filter.
Returns
Section titled “Returns”The filter definition
getFilterId()
Section titled “getFilterId()”getFilterId():
string|undefined
Defined in: src/filter.ts:117
Get the ID of this filter on your hub (if known)
Returns
Section titled “Returns”string | undefined
The filter ID
getRoomTimelineFilterComponent()
Section titled “getRoomTimelineFilterComponent()”getRoomTimelineFilterComponent():
FilterComponent|undefined
Defined in: src/filter.ts:202
Get the room.timeline filter component of the filter
Returns
Section titled “Returns”FilterComponent | undefined
room timeline filter component
setDefinition()
Section titled “setDefinition()”setDefinition(
definition):void
Defined in: src/filter.ts:133
Set the JSON body of the filter
Parameters
Section titled “Parameters”definition
Section titled “definition”The filter definition
Returns
Section titled “Returns”void
setIncludeLeaveRooms()
Section titled “setIncludeLeaveRooms()”setIncludeLeaveRooms(
includeLeave):void
Defined in: src/filter.ts:255
Control whether left rooms should be included in responses.
Parameters
Section titled “Parameters”includeLeave
Section titled “includeLeave”boolean
True to make rooms the user has left appear in responses.
Returns
Section titled “Returns”void
setLazyLoadMembers()
Section titled “setLazyLoadMembers()”setLazyLoadMembers(
enabled):void
Defined in: src/filter.ts:246
Parameters
Section titled “Parameters”enabled
Section titled “enabled”boolean
Returns
Section titled “Returns”void
setTimelineLimit()
Section titled “setTimelineLimit()”setTimelineLimit(
limit):void
Defined in: src/filter.ts:226
Set the max number of events to return for each room’s timeline.
Parameters
Section titled “Parameters”number
The max number of events to return for each room.
Returns
Section titled “Returns”void
setUnreadThreadNotifications()
Section titled “setUnreadThreadNotifications()”setUnreadThreadNotifications(
enabled):void
Defined in: src/filter.ts:233
Enable threads unread notification
Parameters
Section titled “Parameters”enabled
Section titled “enabled”boolean
Returns
Section titled “Returns”void
setUnstableMSC4429SyncUserProfiles()
Section titled “setUnstableMSC4429SyncUserProfiles()”setUnstableMSC4429SyncUserProfiles(
ids,stable):void
Defined in: src/filter.ts:265
Set the list of fields to be included in the profile information sent down the sync stream.
Parameters
Section titled “Parameters”string[]
The field IDs to sync.
stable
Section titled “stable”boolean
Whether to use the stable or unstable versions of this filter.
Returns
Section titled “Returns”void
fromJson()
Section titled “fromJson()”
staticfromJson(userId,filterId,jsonObj):Filter
Defined in: src/filter.ts:93
Create a filter from existing data.
Parameters
Section titled “Parameters”userId
Section titled “userId”string | null | undefined
filterId
Section titled “filterId”string
jsonObj
Section titled “jsonObj”Returns
Section titled “Returns”Filter