import EntitySearch from 'opengate-js/src/searching/EntitySearch.js'

public class | source

EntitySearch

BaseSearch → Search → EntitySearch

This extends Search and it allow make request to any available resource into /entities resource at Opengate North API

Constructor Summary

Public Constructor
public	constructor(ogapi: InternalOpenGateAPI, url: string, filter: object, limit: object, sort: object, group: object, select: object) Constructor

Public Methods
public	execute(): Promise This invoke a request to OpenGate North API and the callback is managed by promises

From class BaseSearch
public	cancel: *
public	cancelAsyncPaging(message: *)
public	downloadCsv(): Promise This invoke a request to OpenGate North API and the callback is managed by promises
public	execute(): Promise This invoke a request to OpenGate North API and the callback is managed by promises
public	executeWithAsyncPaging(resource: string): Promise This invokes a request for asynchronous paging to the OpenGate North API and the return of the pages is managed by promises and its notify object To cancel the process in the notify method return false or string with custom message for response In case of canceling the process, the response will be 403: Forbidden -> {data: 'Cancel process'\|\| custom_message, statusCode: 403}

Constructor

Name	Type	Attribute	Description
ogapi	InternalOpenGateAPI	nullable: false	this is configuration about Opengate North API.
url	string	nullable: false	this define a specific resource to make the search
filter	object		this is the filter
limit	object		this is the pagination about the search
sort	object		this define parameters to order the result of search
group	object		this define parameters to group
select	object		this define fields to retrieve

This invoke a request to OpenGate North API and the callback is managed by promises

Name	Type	Attribute	Description
then	function(result: object, statusCode: number)		When request it is OK
catch	function(error: string)		When request it is NOK