import Areas from 'opengate-js/src/areas/Areas.js'

public class | source

Areas

Extends:

BaseProvision → Areas

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

Constructor Summary

Public Constructor
public	constructor(Reference: InternalOpenGateAPI) Constructor

Method Summary

Public Methods
public	withColor(color: string): Areas Set the color attribute
public	withDescription(description: string): Areas Set the description attribute
public	withEntities(entities: array): Areas Set the entities attribute
public	withGeometry(type: string, coordinates: array): Areas Set the geometry attribute
public	withIdentifier(identifier: string): Areas Set the identifier attribute
public	withName(name: string): Areas Set the name attribute
public	withOrder(order: number): Areas Set the order attribute
public	withOrganization(organization: string): Areas Set the organization 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 withColor(color: string): Areas source

Set the color attribute

Params:

Name	Type	Attribute	Description
color	string		required field

Return:

Areas

public withDescription(description: string): Areas source

Set the description attribute

Params:

Name	Type	Attribute	Description
description	string		required field

Return:

Areas

public withEntities(entities: array): Areas source

Set the entities attribute

Params:

Name	Type	Attribute	Description
entities	array		required field

Return:

Areas

public withGeometry(type: string, coordinates: array): Areas source

Set the geometry attribute

Params:

Name	Type	Attribute	Description
type	string		required field
coordinates	array		required field

Return:

Areas

public withIdentifier(identifier: string): Areas source

Set the identifier attribute

Params:

Name	Type	Attribute	Description
identifier	string		required field

Return:

Areas

public withName(name: string): Areas source

Set the name attribute

Params:

Name	Type	Attribute	Description
name	string		required field

Return:

Areas

public withOrder(order: number): Areas source

Set the order attribute

Params:

Name	Type	Attribute	Description
order	number		required field

Return:

Areas

public withOrganization(organization: string): Areas source

Set the organization attribute

Params:

Name	Type	Attribute	Description
organization	string		required field

Return:

Areas