Subsections of areas

Area Finder

This class allows making GET requests to the area resource in the OpenGate North API.

constructor

Constructor

Parámetros

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

findByOrganizationAndIdentifier(organization, identifier)

Downloads a specific area by its organization and identifier. This executes a GET HTTP method.

Parámetros

Nombre Tipo Opcional Descripción
organization string ❌ area organization .
identifier string ❌ area name.

Retorna

Tip

Tipo: Promise

Areas

This is a base object that contains everything you can do with an area.

constructor

Constructor

Parámetros

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

withColor(color)

Set the color attribute

Parámetros

Nombre Tipo Opcional Descripción
color string ❌ required field

Retorna

Tip

Tipo: Areas

withDescription(description)

Set the description attribute

Parámetros

Nombre Tipo Opcional Descripción
description string ❌ required field

Retorna

Tip

Tipo: Areas

withEntities(entities)

Set the entities attribute

Parámetros

Nombre Tipo Opcional Descripción
entities array ❌ required field

Retorna

Tip

Tipo: Areas

withGeometry(type, coordinates)

Set the geometry attribute

Parámetros

Nombre Tipo Opcional Descripción
type string ❌ required field
coordinates array ❌ required field

Retorna

Tip

Tipo: Areas

withIdentifier(identifier)

Set the identifier attribute

Parámetros

Nombre Tipo Opcional Descripción
identifier string ❌ required field

Retorna

Tip

Tipo: Areas

withName(name)

Set the name attribute

Parámetros

Nombre Tipo Opcional Descripción
name string ❌ required field

Retorna

Tip

Tipo: Areas

withOrder(order)

Set the order attribute

Parámetros

Nombre Tipo Opcional Descripción
order number ❌ required field

Retorna

Tip

Tipo: Areas

withOrganization(organization)

Set the organization attribute

Parámetros

Nombre Tipo Opcional Descripción
organization string ❌ required field

Retorna

Tip

Tipo: Areas