import ModelMedia from 'opengate-js/src/manufacturers/ModelMedia.js'

public class | source

ModelMedia

Extends:

BaseProvision → ModelMedia

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

Constructor Summary

Public Constructor
public	constructor(Reference: InternalOpenGateAPI) Constructor

Method Summary

Public Methods
public	create(rawFile: File): Promise This invoke a request to OpenGate North API and the callback is managed by promises This method create an element deploymentElement
public	update()
public	withFile(file: string): ModelMedia Set the file attribute
public	withFileName(fileName: string): ModelMedia Set the file name attribute
public	withIdentifier(id: string): ModelMedia Set the identifier attribute
public	withName(name: string): ModelMedia Set the name attribute

Inherited Summary

From class BaseProvision
public	create(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function create a entity of provision
public	delete(body: *): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function deletes a entity of provision
public	update(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function updates a entity of provision

Public Constructors

public constructor(Reference: InternalOpenGateAPI) source

Constructor

Override:

BaseProvision#constructor

Params:

Name	Type	Attribute	Description
Reference	InternalOpenGateAPI		to the API object.

Public Methods

public create(rawFile: File): Promise source

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

Override:

BaseProvision#create

Params:

Name	Type	Attribute	Description
rawFile	File		this File is the deployment element

Return:

Promise

Return Properties:

Name	Type	Attribute	Description
then	function(result: object, statusCode: number)		When request it is OK
catch	function(error: string)		When request it is NOK

public update() source

This invoke a request to OpenGate North API and the callback is managed by promises This function updates a entity of provision

Override:

BaseProvision#update

public withFile(file: string): ModelMedia source

Set the file attribute

Params:

Name	Type	Attribute	Description
file	string		required field

Return:

ModelMedia

public withFileName(fileName: string): ModelMedia source

Set the file name attribute

Params:

Name	Type	Attribute	Description
fileName	string		required field

Return:

ModelMedia

public withIdentifier(id: string): ModelMedia source

Set the identifier attribute

Params:

Name	Type	Attribute	Description
id	string		required field

Return:

ModelMedia

public withName(name: string): ModelMedia source

Set the name attribute

Params:

Name	Type	Attribute	Description
name	string		required field

Return:

ModelMedia