diff options
author | RaindropsSys <contact@minteck.org> | 2023-04-24 14:03:36 +0200 |
---|---|---|
committer | RaindropsSys <contact@minteck.org> | 2023-04-24 14:03:36 +0200 |
commit | 633c92eae865e957121e08de634aeee11a8b3992 (patch) | |
tree | 09d881bee1dae0b6eee49db1dfaf0f500240606c /includes/external/matrix/node_modules/matrix-events-sdk/lib/events/MessageEvent.d.ts | |
parent | c4657e4509733699c0f26a3c900bab47e915d5a0 (diff) | |
download | pluralconnect-633c92eae865e957121e08de634aeee11a8b3992.tar.gz pluralconnect-633c92eae865e957121e08de634aeee11a8b3992.tar.bz2 pluralconnect-633c92eae865e957121e08de634aeee11a8b3992.zip |
Updated 18 files, added 1692 files and deleted includes/system/compare.inc (automated)
Diffstat (limited to 'includes/external/matrix/node_modules/matrix-events-sdk/lib/events/MessageEvent.d.ts')
-rw-r--r-- | includes/external/matrix/node_modules/matrix-events-sdk/lib/events/MessageEvent.d.ts | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/includes/external/matrix/node_modules/matrix-events-sdk/lib/events/MessageEvent.d.ts b/includes/external/matrix/node_modules/matrix-events-sdk/lib/events/MessageEvent.d.ts new file mode 100644 index 0000000..0f73258 --- /dev/null +++ b/includes/external/matrix/node_modules/matrix-events-sdk/lib/events/MessageEvent.d.ts @@ -0,0 +1,58 @@ +import { ExtensibleEvent } from "./ExtensibleEvent"; +import { IPartialEvent } from "../IPartialEvent"; +import { Optional } from "../types"; +import { IMessageRendering, M_MESSAGE_EVENT_CONTENT } from "./message_types"; +import { EventType } from "../utility/events"; +/** + * Represents a message event. Message events are the simplest form of event with + * just text (optionally of different mimetypes, like HTML). + * + * Message events can additionally be an Emote or Notice, though typically those + * are represented as EmoteEvent and NoticeEvent respectively. + */ +export declare class MessageEvent extends ExtensibleEvent<M_MESSAGE_EVENT_CONTENT> { + /** + * The default text for the event. + */ + readonly text: string; + /** + * The default HTML for the event, if provided. + */ + readonly html: Optional<string>; + /** + * All the different renderings of the message. Note that this is the same + * format as an m.message body but may contain elements not found directly + * in the event content: this is because this is interpreted based off the + * other information available in the event. + */ + readonly renderings: IMessageRendering[]; + /** + * Creates a new MessageEvent from a pure format. Note that the event is + * *not* parsed here: it will be treated as a literal m.message primary + * typed event. + * @param {IPartialEvent<M_MESSAGE_EVENT_CONTENT>} wireFormat The event. + */ + constructor(wireFormat: IPartialEvent<M_MESSAGE_EVENT_CONTENT>); + /** + * Gets whether this message is considered an "emote". Note that a message + * might be an emote and notice at the same time: while technically possible, + * the event should be interpreted as one or the other. + */ + get isEmote(): boolean; + /** + * Gets whether this message is considered a "notice". Note that a message + * might be an emote and notice at the same time: while technically possible, + * the event should be interpreted as one or the other. + */ + get isNotice(): boolean; + isEquivalentTo(primaryEventType: EventType): boolean; + protected serializeMMessageOnly(): M_MESSAGE_EVENT_CONTENT; + serialize(): IPartialEvent<object>; + /** + * Creates a new MessageEvent from text and HTML. + * @param {string} text The text. + * @param {string} html Optional HTML. + * @returns {MessageEvent} The representative message event. + */ + static from(text: string, html?: string): MessageEvent; +} |