@vector-im/matrix-bot-sdk/lib/models/events/SpaceChildEvent.d.ts

TypeScript/JavaScript SDK for Matrix bots and appservices

import { StateEvent } from "./RoomEvent";
/**
 * The content definition for m.space.child events
 * @category Matrix event contents
 * @see SpaceChildEvent
 */
export interface SpaceChildEventContent {
    /**
     * The servers the client should provide to the server when trying to join the room.
     * When not provided or empty, the child is considered not part of the space.
     */
    via: string[];
    /**
     * A short string to differentiate the rendering order of entities.
     * @see validateSpaceOrderString
     */
    order?: string;
    /**
     * Whether or not the entity is intended to be a suggested entity.
     */
    suggested?: boolean;
}
/**
 * Represents an m.space.child state event
 * @category Matrix events
 */
export declare class SpaceChildEvent extends StateEvent<SpaceChildEventContent> {
    constructor(event: any);
    /**
     * The room ID of the space or room this child represents.
     */
    get entityRoomId(): string;
    /**
     * Whether or not this child is "active" or valid. Inactive children are
     * not considered part of a space.
     */
    get isActiveChild(): boolean;
    /**
     * The servers the client should provide to the homeserver when trying to
     * join the entity (room). May be empty or falsey to denote the child is
     * inactive.
     */
    get viaServers(): string[];
    /**
     * An optional short string to differentiate the rendering order of entities.
     * @see validateSpaceOrderString
     */
    get order(): string;
    /**
     * Whether or not the child is a suggested entity for users to join.
     */
    get suggested(): boolean;
}