Interface RichStreamingDraft

interface RichStreamingDraft {
    randomId: Long;
    signal?: AbortSignal;
    uploadCache?: RichMediaUploadCache;
    dispose(): void;
    send(content: InputRichMessage): Promise<void>;
}

Index

Properties

randomId signal? uploadCache?

Methods

Properties

`Readonly`randomId

randomId: Long

Random ID of the draft

`Optional` `Readonly`signal

signal?: AbortSignal

Signal that is aborted once the user stops the draft generation. Only present if canStop was passed, requires updates to be enabled

`Optional` `Readonly`uploadCache

uploadCache?: RichMediaUploadCache

Cache of media uploaded while streaming the draft (unless disabled).

Pass it to the final sendRichMessage call to avoid re-uploading the media.

Methods

dispose

dispose(): void
Stop listening for the user stopping the draft. Call once the draft is no longer needed

Returns void
- Defined in packages/core/src/highlevel/methods/messages/create-rich-streaming-draft.ts:29

send

send(content: InputRichMessage): Promise<void>
Replace the draft with the given rich message. Does nothing once the draft was stopped by the user
Parameters
- content: InputRichMessage
Returns Promise<void>
- Defined in packages/core/src/highlevel/methods/messages/create-rich-streaming-draft.ts:16