Class Document

Document API component

Hierarchy

Constructors

constructor

Properties

caption? filename? id? link?

Methods

_build

Constructors

constructor

  • new Document(document, isItAnID?, caption?, filename?): 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)

    • Optional caption: string

      Describes the specified document media

    • Optional filename: string

      Describes the filename for the specific document

    Returns Document

Properties

Optional Readonly caption

caption?: string

The file's caption

Optional Readonly filename

filename?: string

The file's filename

Optional Readonly id

id?: string

The id of the media

Optional Readonly link

link?: string

The link of the media

Methods

_build

  • _build(): string

  • The message built as a string. In most cases it's just JSON.stringify(this)

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc