Skip to content
← Docs Hub Digital World Messaging SDK

IRoomDirectoryOptions

Defined in: src/@types/requests.ts:243

Properties

Section titled “Properties”

filter?

Section titled “filter?”

optional filter?: object

Defined in: src/@types/requests.ts:259

Filter parameters

generic_search_term?

Section titled “generic_search_term?”

optional generic_search_term?: string

room_types?

Section titled “room_types?”

optional room_types?: (RoomType | null)[]

include_all_networks?

Section titled “include_all_networks?”

optional include_all_networks?: boolean

Defined in: src/@types/requests.ts:264

limit?

Section titled “limit?”

optional limit?: number

Defined in: src/@types/requests.ts:252

Maximum number of entries to return

server?

Section titled “server?”

optional server?: string

Defined in: src/@types/requests.ts:248

The remote server to query for the room list. Optional. If unspecified, get the local hub’s public room list.

since?

Section titled “since?”

optional since?: string

Defined in: src/@types/requests.ts:256

Token to paginate from

third_party_instance_id?

Section titled “third_party_instance_id?”

optional third_party_instance_id?: string

Defined in: src/@types/requests.ts:265