A media album holds media items uploaded by the user categorized by a name. Media items can be used for image fields.

Hierarchy

  • MediaAlbum

Properties

description: string

The description of the media album.

id: number

The unique id of the media album

isDefault: boolean

Flag to control if this is the default album. Only a single album is the default for each job. This is the location where new media items are being added by default.

itemLimit: number

The item limit defines a maximum number of elements within the album. A value of -1 indicates no active limit.

name: string

The name of the media album.

numItems: number

The total number of images within.

readOnly: number

Flag to control if the album is readonly or if media items can be removed/added.

Generated using TypeDoc