Mark MatrixEvent as @alpha and document.
This commit is contained in:
@@ -6,18 +6,43 @@ Please see LICENSE files in the repository root for full details.
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Representation of a Matrix event.
|
* Representation of a Matrix event, as specified by the client server specification.
|
||||||
* @beta
|
* @alpha Subject to change.
|
||||||
|
* @see https://spec.matrix.org/v1.14/client-server-api/#room-event-format
|
||||||
*/
|
*/
|
||||||
export interface MatrixEvent {
|
export interface MatrixEvent {
|
||||||
|
/**
|
||||||
|
* The event ID of this event.
|
||||||
|
*/
|
||||||
eventId: string;
|
eventId: string;
|
||||||
roomId?: string;
|
/**
|
||||||
|
* The room ID which contains this event.
|
||||||
|
*/
|
||||||
|
roomId: string;
|
||||||
|
/**
|
||||||
|
* The Matrix ID of the user who sent this event.
|
||||||
|
*/
|
||||||
sender: string;
|
sender: string;
|
||||||
|
/**
|
||||||
|
* The content of the event.
|
||||||
|
* If the event was encrypted, this is the decrypted content.
|
||||||
|
*/
|
||||||
content: Record<string, unknown>;
|
content: Record<string, unknown>;
|
||||||
|
/**
|
||||||
|
* Contains optional extra information about the event.
|
||||||
|
*/
|
||||||
unsigned: Record<string, unknown>;
|
unsigned: Record<string, unknown>;
|
||||||
|
/**
|
||||||
|
* The type of the event.
|
||||||
|
*/
|
||||||
type: string;
|
type: string;
|
||||||
|
/**
|
||||||
|
* The state key of the event.
|
||||||
|
* If this key is set, including `""` then the event is a state event.
|
||||||
|
*/
|
||||||
stateKey?: string;
|
stateKey?: string;
|
||||||
|
/**
|
||||||
|
* Timestamp (in milliseconds since the unix epoch) on originating homeserver when this event was sent.
|
||||||
|
*/
|
||||||
originServerTs: number;
|
originServerTs: number;
|
||||||
redacts?: string;
|
|
||||||
age?: number;
|
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user