Home Manual Reference Source Test Repository
public class | source

ModelFinder

Extends:

GenericFinderProvisionGenericFinder → ModelFinder

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

Constructor Summary

Public Constructor
public

Constructor

Method Summary

Public Methods
public

Download all models from a manufacturer.

public

findByManufacturerAndId(manufacturer: string, identifier: string): Promise

Download a specific model by its id.

public

findMediaByManufacturerAndModelAndId(manufacturer: string, modelId: string, mediaIdentifier: string): Promise

Download a specific model media by its ids.

public

findMediasByManufacturerAndModel(manufacturer: string, identifier: string): Promise

Download a specific model media by its ids.

Public Constructors

public constructor(Reference: InternalOpenGateAPI) source

Constructor

Override:

ProvisionGenericFinder#constructor

Params:

NameTypeAttributeDescription
Reference InternalOpenGateAPI

to the API object.

Public Methods

public findByManufacturer(manufacturer: string): Promise source

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

Params:

NameTypeAttributeDescription
manufacturer string

manufacturer id .

Return:

Promise

public findByManufacturerAndId(manufacturer: string, identifier: string): Promise source

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

Params:

NameTypeAttributeDescription
manufacturer string

manufacturer id .

identifier string

model name .

Return:

Promise

public findMediaByManufacturerAndModelAndId(manufacturer: string, modelId: string, mediaIdentifier: string): Promise source

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

Params:

NameTypeAttributeDescription
manufacturer string

manufacturer id .

modelId string

model identifier .

mediaIdentifier string

media identifier.

Return:

Promise

public findMediasByManufacturerAndModel(manufacturer: string, identifier: string): Promise source

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

Params:

NameTypeAttributeDescription
manufacturer string

manufacturer id .

identifier string

model identifier .

Return:

Promise