@signageos/sdk
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • FirmwareVersionManagement

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private options

options: IOptions

Static Readonly RESOURCE

RESOURCE: string = "firmware/version"

Methods

create

  • Initiate uploading of firmware files to S3 storage. If successfully uploaded, create FW version in DB.

    Parameters

    • settings: IFirmwareVersionCreatable
    • Default value force: boolean = false

      is applicable when FW cannot be uploaded because of non-existent firmware type.

    Returns Promise<void>

list

  • Returns Promise<IFirmwareVersion[]>

set

  • set(applicationType: string, version: string, type: string | undefined, settings: IFirmwareVersionUpdatable, force?: boolean): Promise<void>

  • Finalize the uploaded firmware with settings uploaded: true. This method has to be called when successfully FW uploaded files to S3.

    deprecated

    Use create method instead. It does the confirmation automatically under the hood. TODO make this method private in the next major release.

    Parameters

    • applicationType: string
    • version: string
    • type: string | undefined
    • settings: IFirmwareVersionUpdatable
    • Default value force: boolean = false

      is applicable when FW cannot be uploaded because of non-existent firmware type.

    Returns Promise<void>

Static Private getUrl

  • getUrl(applicationType: string, version: string, type: string | undefined): string

  • Parameters

    • applicationType: string
    • version: string
    • type: string | undefined

    Returns string

Legend

  • Constructor
  • Property
  • Method
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Property
  • Method
  • Private property
  • Private method
  • Protected property
  • Static property

Generated using TypeDoc