Class RoomMessageRequest

A customized owned request type for sending out room messages (specification).

Constructors

constructor

Properties

body event_type id room_id txn_id type

Methods

[dispose] free

Constructors

constructor

  • new RoomMessageRequest(
        id: string,
        room_id: string,
        txn_id: string,
        event_type: string,
        content: string,
    ): RoomMessageRequest

    Create a new RoomMessageRequest.

    Parameters

    • id: string
    • room_id: string
    • txn_id: string
    • event_type: string
    • content: string

    Returns RoomMessageRequest

Properties

Readonlybody

body: string

A JSON-encoded object containing the message's content.

Readonlyevent_type

event_type: string

A string representing the type of event to be sent.

Readonlyid

id: string

The request ID.

Readonlyroom_id

room_id: string

A string representing the room to send the event to.

Readonlytxn_id

txn_id: string

A string representing the transaction ID for this event.

Clients should generate an ID unique across requests with the same access token; it will be used by the server to ensure idempotency of requests.

Readonlytype

type: RequestType

Get its request type.

Methods

[dispose]

  • "[dispose]"(): void

    Returns void

free

  • free(): void

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods