Subsections of manufacturers

Manufacturer Finder

This class allow make get request to hardware manufacturers resource into Opengate North API.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
Reference InternalOpenGateAPI ❌ to the API object.

findAll()

Download a specific manufacturer by its id. This execute a GET http method

Retorna

Tip

Tipo: Promise

findById(identifier)

Download a specific manufacturer by its id. This execute a GET http method

Parámetros

Nombre Tipo Opcional Descripción
identifier string ❌ manufacturer identifier .

Retorna

Tip

Tipo: Promise

findMediaById(manufacturerId, mediaIdentifier)

Download a specific manufacturer media by its ids. This execute a GET http method

Parámetros

Nombre Tipo Opcional Descripción
manufacturerId string ❌ manufacturer identifier .
mediaIdentifier string ❌ media identifier.

Retorna

Tip

Tipo: Promise

findMedias(manufacturerId)

Download manufacturer medias. This execute a GET http method

Parámetros

Nombre Tipo Opcional Descripción
manufacturerId string ❌ manufacturer identifier .

Retorna

Tip

Tipo: Promise

Manufacturer Media

This is a base object that contains all you can do about ManufacturerMedia.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
Reference InternalOpenGateAPI ❌ to the API object.

create(rawFile)

This invoke a request to OpenGate North API and the callback is managed by promises This method create an element deploymentElement

Parámetros

Nombre Tipo Opcional Descripción
rawFile File ❌ this File is the deployment element

Retorna

Tip

Tipo: Promise

withFile(file)

Set the file attribute

Parámetros

Nombre Tipo Opcional Descripción
file string ❌ required field

Retorna

Tip

Tipo: ManufacturerMedia

withIdentifier(id)

Set the identifier attribute

Parámetros

Nombre Tipo Opcional Descripción
id string ❌ required field

Retorna

Tip

Tipo: ManufacturerMedia

withName(name)

Set the name attribute

Parámetros

Nombre Tipo Opcional Descripción
name string ❌ required field

Retorna

Tip

Tipo: ManufacturerMedia

Manufacturers

This is a base object that contains all you can do about Manufacturers.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
Reference InternalOpenGateAPI ❌ to the API object.

withAddress(address)

Set the address attribute

Parámetros

Nombre Tipo Opcional Descripción
address string ❌

Retorna

Tip

Tipo: Manufacturers

withDescription(description)

Set the description attribute

Parámetros

Nombre Tipo Opcional Descripción
description string ❌ required field

Retorna

Tip

Tipo: Manufacturers

withEmail(email)

Set the email attribute

Parámetros

Nombre Tipo Opcional Descripción
email string ❌

Retorna

Tip

Tipo: Manufacturers

withFax(fax)

Set the fax attribute

Parámetros

Nombre Tipo Opcional Descripción
fax string ❌

Retorna

Tip

Tipo: Manufacturers

withIdentifier(id)

Set the identifier attribute

Parámetros

Nombre Tipo Opcional Descripción
id string ❌ required field

Retorna

Tip

Tipo: Manufacturers

withName(name)

Set the name attribute

Parámetros

Nombre Tipo Opcional Descripción
name string ❌ required field

Retorna

Tip

Tipo: Manufacturers

withNotes(notes)

Set the notes attribute

Parámetros

Nombre Tipo Opcional Descripción
notes string ❌

Retorna

Tip

Tipo: Manufacturers

withTelephone(telephone)

Set the telephone attribute

Parámetros

Nombre Tipo Opcional Descripción
telephone string ❌

Retorna

Tip

Tipo: Manufacturers

withUrl(url)

Set the url attribute

Parámetros

Nombre Tipo Opcional Descripción
url string ❌

Retorna

Tip

Tipo: Manufacturers

Model Finder

This class allow make get request to hardware models resource into Opengate North API.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
Reference InternalOpenGateAPI ❌ to the API object.

findByManufacturer(manufacturer)

Download all models from a manufacturer. This execute a GET http method

Parámetros

Nombre Tipo Opcional Descripción
manufacturer string ❌ manufacturer id .

Retorna

Tip

Tipo: Promise

findByManufacturerAndId(manufacturer, identifier)

Download a specific model by its id. This execute a GET http method

Parámetros

Nombre Tipo Opcional Descripción
manufacturer string ❌ manufacturer id .
identifier string ❌ model name .

Retorna

Tip

Tipo: Promise

findMediaByManufacturerAndModelAndId(manufacturer, modelId, mediaIdentifier)

Download a specific model media by its ids. This execute a GET http method

Parámetros

Nombre Tipo Opcional Descripción
manufacturer string ❌ manufacturer id .
modelId string ❌ model identifier .
mediaIdentifier string ❌ media identifier.

Retorna

Tip

Tipo: Promise

findMediasByManufacturerAndModel(manufacturer, identifier)

Download a specific model media by its ids. This execute a GET http method

Parámetros

Nombre Tipo Opcional Descripción
manufacturer string ❌ manufacturer id .
identifier string ❌ model identifier .

Retorna

Tip

Tipo: Promise

Model Media

This is a base object that contains all you can do about ModelMedia.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
Reference InternalOpenGateAPI ❌ to the API object.

create(rawFile)

This invoke a request to OpenGate North API and the callback is managed by promises This method create an element deploymentElement

Parámetros

Nombre Tipo Opcional Descripción
rawFile File ❌ this File is the deployment element

Retorna

Tip

Tipo: Promise

withFile(file)

Set the file attribute

Parámetros

Nombre Tipo Opcional Descripción
file string ❌ required field

Retorna

Tip

Tipo: ModelMedia

withFileName(fileName)

Set the file name attribute

Parámetros

Nombre Tipo Opcional Descripción
fileName string ❌ required field

Retorna

Tip

Tipo: ModelMedia

withIdentifier(id)

Set the identifier attribute

Parámetros

Nombre Tipo Opcional Descripción
id string ❌ required field

Retorna

Tip

Tipo: ModelMedia

withName(name)

Set the name attribute

Parámetros

Nombre Tipo Opcional Descripción
name string ❌ required field

Retorna

Tip

Tipo: ModelMedia

Models

This is a base object that contains all you can do about Models.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
Reference InternalOpenGateAPI ❌ to the API object.

withDescription(description)

Set the description attribute

Parámetros

Nombre Tipo Opcional Descripción
description string ❌ required field

Retorna

Tip

Tipo: Models

withIdentifier(id)

Set the identifier attribute

Parámetros

Nombre Tipo Opcional Descripción
id string ❌ required field

Retorna

Tip

Tipo: Models

withName(name)

Set the name attribute

Parámetros

Nombre Tipo Opcional Descripción
name string ❌ required field

Retorna

Tip

Tipo: Models

withNotes(notes)

Set the notes attribute

Parámetros

Nombre Tipo Opcional Descripción
notes string ❌

Retorna

Tip

Tipo: Models

withUrl(url)

Set the url attribute

Parámetros

Nombre Tipo Opcional Descripción
url string ❌

Retorna

Tip

Tipo: Models

withVersion(version)

Set the version attribute

Parámetros

Nombre Tipo Opcional Descripción
version string ❌

Retorna

Tip

Tipo: Models