Home Manual Reference Source Test Repository 
import ComplexBuilder from 'opengate-js/src/provision/entities/ComplexBuilder.js'
public class | source

ComplexBuilder

Extends:

BaseProvision → SimpleBuilder → ComplexBuilder

Direct Subclass:

DeviceBuilder

This class extends SimpleBuilder to allow set complex values. What is a complex value? It is simple, It is a value that need a communications module identifier to allow set into the box.

Constructor Summary

Public Constructor
public

constructor(ogapi: InternalOpenGateAPI, resource: string, allowedDatastreams: array, definedSchemas: array, jsonSchemaValidator: Validator)

Constructor

Method Summary

Public Methods
public

initFromFlattened(_flattenedEntityData: *)

public

initFromJson(_jsonEntityData: *)

public

withComplex(_id: string, idCommunicationModules: string, val: object): *

Set a complex value to entity

Inherited Summary

From class BaseProvision
public

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

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

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

initFromFlattened(_flattenedEntityData: *)

public

initFromJson(_jsonEntityData: *)

public

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

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

with(_id: string, val: objecr): *

Set new datastream value

Public Constructors

public constructor(ogapi: InternalOpenGateAPI, resource: string, allowedDatastreams: array, definedSchemas: array, jsonSchemaValidator: Validator) source

Constructor

Override:

SimpleBuilder#constructor

Params:

NameTypeAttributeDescription
ogapi InternalOpenGateAPI
  • nullable: false

this is ogapi instance
resource string
  • nullable: false

this is the resource url where can be create/delete/update/read the entity
allowedDatastreams array
  • optional
  • nullable: false

Allowed datastreams to add into the new entity
definedSchemas array
  • optional
  • nullable: false

Jsonschema about all OpenGate specific types
jsonSchemaValidator Validator
  • optional
  • nullable: false

Json schema validator tool

Public Methods

public initFromFlattened(_flattenedEntityData: *) source

Override:

SimpleBuilder#initFromFlattened

Params:

NameTypeAttributeDescription
_flattenedEntityData *

public initFromJson(_jsonEntityData: *) source

Override:

SimpleBuilder#initFromJson

Params:

NameTypeAttributeDescription
_jsonEntityData *

public withComplex(_id: string, idCommunicationModules: string, val: object): * source

Set a complex value to entity

Params:

NameTypeAttributeDescription
_id string
  • nullable: false

Datastream identifier
idCommunicationModules string
  • nullable: false

Communications module identifier
val object

Value to set.

Return:

*