iland-sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Media.

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

catalogUuid

catalogUuid:

Get Media catalog uuid.

companyId

companyId:

Gets the ID of the company that the entity belongs to.

createdDate

createdDate:

Get Media creation date.

deleted

deleted:

Indicates whether the entity is deleted.

deletedDate

deletedDate:

Gets the date that the entity was deleted, or null if it is not deleted.

description

description:

Get Media description

entityType

entityType:

Get entity type for Media

isPublic

isPublic:

Indicate whether the Media is public or not.

json

json:

Gets the raw JSON object from the API.

locationId

locationId:

Get Media location ID

name

name:

Gets the name.

orgUuid

orgUuid:

Get Media org uuid.

size

size:

Get Media size.

status

status:

Get Media status.

storageProfileUuid

storageProfileUuid:

Get Media storageProfile uuid.

updatedDate

updatedDate:

Gets the last date that the entity was updated.

uuid

uuid:

Gets the UUID.

vcloudHref

vcloudHref:

Get Media vCloudHref.

vdcUuid

vdcUuid:

Get Media vDc uuid.

Methods

clone

delete

  • delete(): Promise<Task>

deleteMetadata

  • deleteMetadata(metadataKey: string): Promise<Task>

  • Deletes a metadata entry.

    Parameters

    • metadataKey: string

      the key of the metadata entry to delete

    Returns Promise<Task>

    task promise

getDownloadLink

  • getDownloadLink(filename?: undefined | string): Observable<string>

  • Get a link to download the Media.

    Parameters

    • Optional filename: undefined | string

    Returns Observable<string>

getMetadata

refresh

  • refresh(): Promise<Media>

  • Refreshes the Media data by retrieving it from the API again.

    Returns Promise<Media>

    promise that resolves with the Media

sync

  • sync(): Promise<Task>

toString

  • toString(): string

update

updateMetadata

Static getMedia

  • getMedia(uuid: string): Promise<Media>

  • Get the Media from API.

    Parameters

    • uuid: string

    Returns Promise<Media>

    promise that resolves with the Media

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc