Interface IRoomDirectoryOptions

interface IRoomDirectoryOptions {
    filter?: {
        generic_search_term?: string;
        room_types?: (null | RoomType)[];
    };
    include_all_networks?: boolean;
    limit?: number;
    server?: string;
    since?: string;
    third_party_instance_id?: string;
}

Properties

filter? include_all_networks? limit? server? since? third_party_instance_id?

Properties

Optionalfilter

filter?: {
    generic_search_term?: string;
    room_types?: (null | RoomType)[];
}

Filter parameters

Optionalinclude_all_networks

include_all_networks?: boolean

Optionallimit

limit?: number

Maximum number of entries to return

Optionalserver

server?: string

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

Optionalsince

since?: string

Token to paginate from

Optionalthird_party_instance_id

third_party_instance_id?: string

Settings

Member Visibility

On This Page

Properties