Search
Extends:
Direct Subclass:
This extends BaseSearch and allow make request to any available resource into Opengate North API.
Constructor Summary
| Public Constructor | ||
| public |
constructor(ogapi: InternalOpenGateAPI, url: string, filter: object, limit: object, sort: object, group: object, select: object, timeout: nubmer) |
|
Inherited Summary
| From class BaseSearch | ||
| public |
cancel: * |
|
| public |
cancelAsyncPaging(message: *) |
|
| public |
This invoke a request to OpenGate North API and the callback is managed by promises |
|
| public |
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} |
|
Public Constructors
public constructor(ogapi: InternalOpenGateAPI, url: string, filter: object, limit: object, sort: object, group: object, select: object, timeout: nubmer) source
Constructor
Override:
BaseSearch#constructorParams:
| Name | Type | Attribute | Description |
| ogapi | InternalOpenGateAPI |
|
this is configuration about Opengate North API. |
| url | string |
|
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 defined parameters to order the result of search |
|
| group | object | ||
| select | object | ||
| timeout | nubmer |