nodes/generated

Interface MatrixNodeParameters

Source
interface MatrixNodeParameters {
    additionalFields?: { fileName?: string };
    binaryPropertyName?: string;
    eventId?: string;
    fallbackText?: string;
    filters?: {
        membership?:
            | ""
            | "invite"
            | "join"
            | "leave"
            | "ban";
        notMembership?: | ""
        | "invite"
        | "join"
        | "leave"
        | "ban";
    };
    limit?: number;
    mediaType?: "file"
    | "video"
    | "image"
    | "audio";
    messageFormat?: "plain" | "org.matrix.custom.html";
    messageType?: "m.emote" | "m.notice" | "m.text";
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "upload"
        | "invite"
        | "me"
        | "join"
        | "kick"
        | "leave";
    otherOptions?: { filter?: string };
    preset?: "private_chat" | "public_chat";
    reason?: string;
    resource?:
        | "event"
        | "account"
        | "message"
        | "room"
        | "media"
        | "roomMember";
    returnAll?: boolean;
    roomAlias?: string;
    roomId?: string;
    roomIdOrAlias?: string;
    roomName?: string;
    text?: string;
    userId?: string;
}

Properties§

§readonly additionalFields?: { ... }

Default: {}

§readonly binaryPropertyName?: string

Default: "data"

§readonly eventId?: string

The room related to the event

§readonly fallbackText?: string

A plain text message to display in case the HTML cannot be rendered by the Matrix client

§readonly filters?: { ... }

Filtering options Default: {}

§readonly limit?: number

Max number of results to return Default: 100 Type options: {"minValue":1,"maxValue":500}

§readonly mediaType?: "file" | "video" | "image" | "audio"

Type of file being uploaded Default: "image"

§readonly messageFormat?: "plain" | "org.matrix.custom.html"

The format of the message's body Default: "plain"

§readonly messageType?: "m.emote" | "m.notice" | "m.text"

The type of message to send Default: "m.text"

§readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "upload"
    | "invite"
    | "me"
    | "join"
    | "kick"
    | "leave"

Default: "me"

§readonly otherOptions?: { ... }

Default: {}

§readonly preset?: "private_chat" | "public_chat"

Default: "public_chat"

§readonly reason?: string

Reason for kick

§readonly resource?:
    | "event"
    | "account"
    | "message"
    | "room"
    | "media"
    | "roomMember"

Default: "message"

§readonly returnAll?: boolean

Whether to return all results or only up to a given limit

§readonly roomAlias?: string
§readonly roomId?: string

The room related to the event

§readonly roomIdOrAlias?: string
§readonly roomName?: string
§readonly text?: string

The text to send

§readonly userId?: string

The fully qualified user ID of the invitee