Interface IOutlineHistory

Interface representing the history management API for outline operations. Provides methods to manage message history, such as adding, clearing, and listing messages. IOutlineHistory

interface IOutlineHistory {
    clear(): Promise<void>;
    list(): Promise<IOutlineMessage[]>;
    push(...messages: (IOutlineMessage | IOutlineMessage[])[]): Promise<void>;
}

Index

Methods

clear list push

Methods

clear

clear(): Promise<void>
Clears all messages from the outline history. Resets the history to an empty state.

Returns Promise<void>
A promise that resolves when the history is cleared.
- Defined in types.d.ts:4800

list

list(): Promise<IOutlineMessage[]>
Retrieves all messages in the outline history.

Returns Promise<IOutlineMessage[]>
A promise resolving to an array of messages in the history.
- Defined in types.d.ts:4805

push

push(...messages: (IOutlineMessage | IOutlineMessage[])[]): Promise<void>
Adds one or more messages to the outline history. Supports both single messages and arrays of messages for flexibility.
Parameters
- ...messages: (IOutlineMessage | IOutlineMessage[])[]
  The message(s) to add to the history.
Returns Promise<void>
A promise that resolves when the messages are successfully added.
- Defined in types.d.ts:4794

Interface IOutlineHistory

Index

Methods

Methods

clear

Returns Promise<void>

list

Returns Promise<IOutlineMessage[]>

push

Parameters

Returns Promise<void>

Settings

On This Page