Image API component

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

  • Create a Image object for the API

    Parameters

    • image: string

      The image file's link or id

    • isItAnID: boolean = false

      Whether image is an id (true) or a link (false)

    • Optional caption: string

      Describes the specified image media

    Returns Image

Properties

caption?: string

The file's caption

id?: string

The id of the media

link?: string

The link of the media

Accessors

Methods

  • Internal

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

    Returns string

Generated using TypeDoc