fvtt-types/src/foundry/client/documents/collections/chat-messages.d.mts

TypeScript type definitions for Foundry VTT

import type { Identity } from "#utils";
import type Document from "#common/abstract/document.d.mts";

/**
 * The singleton collection of ChatMessage documents which exist within the active World.
 * This Collection is accessible within the Game object as game.messages.
 *
 * @see {@linkcode ChatMessage} The ChatMessage document
 * @see {@linkcode ChatLog} The ChatLog sidebar directory
 */
declare class ChatMessages extends foundry.documents.abstract.WorldCollection<"ChatMessage", "Messages"> {
  static documentName: "ChatMessage";

  override get directory(): typeof ui.chat;

  render(force?: boolean): void;

  /**
   * If requested, dispatch a Chat Bubble UI for the newly created message
   * @param message - The ChatMessage document to say
   */
  sayBubble(message: ChatMessage.Implementation): void;

  /**
   * Handle export of the chat log to a text file
   */
  export(): void;

  /**
   * Allow for bulk deletion of all chat messages, confirm first with a yes/no dialog.
   * @see {@linkcode Dialog.confirm}
   */
  flush(): Promise<Promise<ChatMessage.Stored[]> | false | null>;
}

declare namespace ChatMessages {
  /** @deprecated There should only be a single implementation of this class in use at one time, use {@linkcode Implementation} instead */
  type Any = Internal.Any;

  /** @deprecated There should only be a single implementation of this class in use at one time, use {@linkcode ImplementationClass} instead */
  type AnyConstructor = Internal.AnyConstructor;

  namespace Internal {
    interface Any extends AnyChatMessages {}
    interface AnyConstructor extends Identity<typeof AnyChatMessages> {}
  }

  interface ImplementationClass extends Document.Internal.ConfiguredCollectionClass<"ChatMessage"> {}
  interface Implementation extends Document.Internal.ConfiguredCollection<"ChatMessage"> {}

  /**
   * @deprecated Replaced by {@linkcode ChatMessages.ImplementationClass}.
   */
  type ConfiguredClass = ImplementationClass;

  /**
   * @deprecated Replaced by {@linkcode ChatMessages.Implementation}.
   */
  type Configured = Implementation;
}

declare abstract class AnyChatMessages extends ChatMessages {
  constructor(...args: never);
}

export default ChatMessages;