Home Manual Reference Source Test Repository 
import AreaFinder from 'opengate-js/src/areas/AreaFinder.js'
public class | source

AreaFinder

Extends:

GenericFinder → ProvisionGenericFinder → AreaFinder

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

Constructor Summary

Public Constructor
public

Constructor

Method Summary

Public Methods
public

findByOrganizationAndIdentifier(organization: string, identifier: string): Promise

Download a specific area by its organization and identifier.

Public Constructors

public constructor(ogapi: InternalOpenGateAPI) source

Constructor

Override:

ProvisionGenericFinder#constructor

Params:

NameTypeAttributeDescription
ogapi InternalOpenGateAPI

Reference to the API object.

Public Methods

public findByOrganizationAndIdentifier(organization: string, identifier: string): Promise source

Download a specific area by its organization and identifier. This execute a GET http method

Params:

NameTypeAttributeDescription
organization string

area organization .
identifier string

area name.

Return:

Promise