import FlattenedSearchBuilder from 'opengate-js/src/searching/builder/FlattenedSearchBuilder.js'

public class | source

FlattenedSearchBuilder

SearchBuilder → FlattenedSearchBuilder

This is a abstract class. It is a class that extends from base to make all kind of summary search request to OpenGate North API.

Constructor Summary

Public Constructor
public	constructor(parent: InternalOpenGateAPI, routes: object) Constructor

Public Methods
public	build(): Search Build a instance of Search
public	flattened(): FlattenedSearchBuilder The response will return a flattened response

From class SearchBuilder
public	[route]: *
public	addSortAscendingBy(filterField: string): SearchBuilder Add ascending param into the sort search object
public	addSortBy(filterField: string, typeSort: string): SearchBuilder Add ascending/descending param into the sort search object
public	addSortDescendingBy(filterField: string): SearchBuilder Add descending param into the sort search object
public	build(): Search Build a instance of Search
public	filter(filter: FilterBuilder \| object): SearchBuilder The search request will have this filter
public	findAllFields(input: *): Promise Return a promise which it will contains an array with fields recommended with complete structure
public	findFieldPath(field: *): Promise Return a promise which it will contains an string with the path of a field
public	findFields(input: *): Promise Return a promise which it will contains an array with fields recommended with only identifier
public	limit(size: number, start: number): SearchBuilder Set reponse pagination.
public	removeSortBy(filterField: string): SearchBuilder Remove sort param from the search object
public	withTimeout(ms: number): SearchBuilder The request will have a specific time out if it will be exceeded then the promise throw an exception

Constructor

Name	Type	Attribute	Description
parent	InternalOpenGateAPI	nullable: false	this is ogapi instance
routes	object	nullable: false	this defined the routes. One of those routes must be called on Builder before call build method.

Build a instance of Search

Throw error on url build

 ogapi.devicesSearchBuilder().onProvisioned().build()

The response will return a flattened response

ogapi.entitiesSearchBuilder().flattened()