Class Document

constructor

• new Document(
      document: string,
      isItAnID?: boolean,
      caption?: string,
      filename?: string,
  ): Document

  Create a Document object for the API

  Parameters

  • document: string

    The document file's link or id
  • isItAnID: boolean = false

    Whether document is an id (true) or a link (false)
  • Optionalcaption: string

    Describes the specified document media
  • Optionalfilename: string

    Describes the filename for the specific document

  Returns Document

  Example

  import { Document } from "whatsapp-api-js/messages";
  
  const document_message = new Document("https://www.example.com/document.pdf");
  
  const document_id_message = new Document("12345678", true);
  
  const document_caption_message = new Document(
      "https://www.example.com/document.pdf",
      false,
      "Hello world!"
  );
  
  const document_filename_message = new Document(
      "https://www.example.com/document.pdf",
      false,
      undefined,
      "a weird filename.pdf"
  );
  Copy

Optional Readonlycaption

Optional Readonlyfilename