Subsections of geocluster

Geocluster

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

constructor

Constructor

Parámetros

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

withIdentifier(identifier)

Set the identifier attribute

Parámetros

Nombre Tipo Opcional Descripción
identifier string ❌ required field

Retorna

Tip

Tipo: Geocluster

Geocluster Finder

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

constructor

Constructor

Parámetros

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

findAll()

Find all available geocluster. This execute a GET http method

Retorna

Tip

Tipo: Promise

findById(id)

Find a specify geocluster by an identifier. This execute a GET http method

Parámetros

Nombre Tipo Opcional Descripción
id string ❌ Identifier of the geocluster.

Retorna

Tip

Tipo: Promise

findFeatures(id, coordinates)

Find features inside the coordinates. This execute a GET http method

Parámetros

Nombre Tipo Opcional Descripción
id string ❌ Identifier of the geocluster.
coordinates Object ❌ square defined by the coordinates and the zoom used to find the inside features .

Retorna

Tip

Tipo: Promise