@vector-im/matrix-bot-sdk/src/models/events/CanonicalAliasEvent.ts

TypeScript/JavaScript SDK for Matrix bots and appservices

import { StateEvent } from "./RoomEvent";

/**
 * The content definition for m.room.canonical_alias events
 * @category Matrix event contents
 * @see CanonicalAliasEvent
 */
export interface CanonicalAliasEventContent {
    /**
     * The canonical alias for the room.
     */
    alias: string;
}

/**
 * Represents an m.room.canonical_alias state event
 * @category Matrix events
 */
export class CanonicalAliasEvent extends StateEvent<CanonicalAliasEventContent> {
    constructor(event: any) {
        super(event);
    }

    /**
     * The alias the room is considering canonical
     */
    public get aliases(): string {
        return this.content.alias;
    }
}