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

public class | source

PreFilteredSearchBuilder

Extends:

SearchBuilder → FlattenedSearchBuilder → PreFilteredSearchBuilder

Direct Subclass:

AssetsSearchBuilder, DevicesSearchBuilder, SubscribersSearchBuilder, SubscriptionsSearchBuilder

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

Method Summary

Public Methods
public	collected(): PreFilteredSearchBuilder This option forces search api to add a filter of collected content
public	disableCaseSensitive(flag: *): EntitiesSearchBuilder The response will return a response by applying the filter with likes case-no-sensitive
public	disableDefaultSorted(): PreFilteredSearchBuilder The response will return a response without sorted
public	provisioned(): PreFilteredSearchBuilder This option forces search api to add a filter of provisioned content
public	removeCaseSensitive(): EntitiesSearchBuilder The response will return a response by applying the filter with likes case-no-sensitive
public	select(select: SelectBuilder \| object): PreFilteredSearchBuilder The search request will have this filter

Inherited Summary

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

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

Public Constructors

public constructor(parent: InternalOpenGateAPI, routes: object) source

Constructor

Override:

FlattenedSearchBuilder#constructor

Params:

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.

Public Methods

public collected(): PreFilteredSearchBuilder source

This option forces search api to add a filter of collected content

Return:

PreFilteredSearchBuilder

Example:

ogapi.subscribersSearchBuilder().collected()

public disableCaseSensitive(flag: *): EntitiesSearchBuilder source

The response will return a response by applying the filter with likes case-no-sensitive

Params:

Name	Type	Attribute	Description
flag	*

Return:

EntitiesSearchBuilder

Example:

ogapi.entitiesSearchBuilder().disableCaseSensitive()

public disableDefaultSorted(): PreFilteredSearchBuilder source

The response will return a response without sorted

Return:

PreFilteredSearchBuilder

Example:

ogapi.assetsSearchBuilder().disableDefaultSorted()

public provisioned(): PreFilteredSearchBuilder source

This option forces search api to add a filter of provisioned content

Return:

PreFilteredSearchBuilder

Example:

ogapi.subscribersSearchBuilder().provisioned()

public removeCaseSensitive(): EntitiesSearchBuilder source

The response will return a response by applying the filter with likes case-no-sensitive

Return:

EntitiesSearchBuilder

Example:

ogapi.entitiesSearchBuilder().removeCaseSensitive()

public select(select: SelectBuilder | object): PreFilteredSearchBuilder source

The search request will have this filter

Params:

Name	Type	Attribute	Description
select	SelectBuilder \| object	nullable: false

Return:

PreFilteredSearchBuilder

Example:

 ogapi.devicesSearchBuilder().select(
     ogapi.newSelectBuilder().add(SE.element("provision.device.identifier", ["value"], "id"), SE.add("device.temperature.value", ["value"]))
 ) // Setting SelectBuilder
 ogapi.devicesSearchBuilder().select({
     "elements": [
         {"name": "provision.device.identifier","fields": ["value"],"alias": "id"},
         {"name": "device.temperature.value","fields": ["value"]}
     ]
 }) //Custom select