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

public class | source

SearchBuilder

Direct Subclass:

AdministrativeStateSearchBuilder, AllowedResourceTypeSearchBuilder, AreasSearchBuilder, BulkExecutionSearchBuilder, BulkSearchBuilder, BundlesSearchBuilder, CertificatesSearchBuilder, CommunicationsModuleTypeSearchBuilder, CountryCodesSearchBuilder, DatamodelsSearchBuilder, DatapointsSearchBuilder, DatasetSearchBuilder, DatasetsCatalogSearchBuilder, DatastreamsSearchBuilder, FeedsSearchBuilder, FieldsDefinitionSearchBuilder, FlattenedSearchBuilder, IoTDatastreamAccessSearchBuilder, IoTDatastreamPeriodSearchBuilder, IoTDatastreamStoragePeriodSearchBuilder, MobilePhoneProviderSearchBuilder, OperationTypesBuilder, OperationalStatusSearchBuilder, OrganizationsSearchBuilder, ResourceTypeSearchBuilder, RuleConfigurationSeveritySearchBuilder, RuleModeSearchBuilder, RuleTypeSearchBuilder, RulesSearchBuilder, SearchWithSummaryBuilder, ServiceGroupSearchBuilder, TicketPrioritySearchBuilder, TicketSeveritySearchBuilder, TicketStatusSearchBuilder, TicketsSearchBuilder, TimeserieDatasetBuilder, TimeserieDownsamplerBuilder, TimeserieSearchBuilder, TimezoneSearchBuilder, UserLanguagesSearchBuilder, UserProfilesSearchBuilder

Indirect Subclass:

AlarmsSearchBuilder, AssetsSearchBuilder, ChannelsSearchBuilder, DatasetEntitiesSearchBuilder, DevicesPlansSearchBuilder, DevicesSearchBuilder, DomainsSearchBuilder, EntitiesSearchBuilder, ExecutionsHistorySearchBuilder, ExecutionsSearchBuilder, OperationsSearchBuilder, PlansSearchBuilder, PreFilteredSearchBuilder, SoftwaresSearchBuilder, SubscribersSearchBuilder, SubscriptionsSearchBuilder, TasksSearchBuilder, UsersSearchBuilder, WorkgroupsSearchBuilder

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

Test:

Constructor Summary

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

Member Summary

Public Members
public	[route]: *

Method Summary

Public Methods
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

Public Constructors

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

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 Members

public [route]: * source

Public Methods

public addSortAscendingBy(filterField: string): SearchBuilder source

Add ascending param into the sort search object

Params:

Name	Type	Attribute	Description
filterField	string	nullable: false	This field must be allowed into the specific resource

Return:

SearchBuilder

Example:

 ogapi.subscriptionsSearchBuilder().addSortAscendingBy('prov.customid') // Order by prov.customid Ascending

Test:

Check funcionality newSearchBuilder module: Check on entity searching: On sort: Ascending sort

public addSortBy(filterField: string, typeSort: string): SearchBuilder source

Add ascending/descending param into the sort search object

Params:

Name	Type	Attribute	Description
filterField	string	nullable: false	This field must be allowed into the specific resource
typeSort	string	nullable: false

Return:

SearchBuilder

Example:

 ogapi.subscriptionsSearchBuilder().addSortBy('prov.customid','ASCENDING') // Order by prov.customid Ascending
 ogapi.devicesSearchBuilder().addSortBy('prov.customid','DESCENDING') // Order by prov.customid Descending

Test:

Check funcionality newSearchBuilder module: Check on entity searching: On sort: Generic sort

public addSortDescendingBy(filterField: string): SearchBuilder source

Add descending param into the sort search object

Params:

Name	Type	Attribute	Description
filterField	string	nullable: false	This field must be allowed into the specific resource

Return:

SearchBuilder

Example:

 ogapi.devicesSearchBuilder().addSortDescendingBy('prov.customid') // Order by prov.customid Descending

Test:

Check funcionality newSearchBuilder module: Check on entity searching: On sort: Ascending sort

public build(): Search source

Build a instance of Search

Return:

Throw:

SearchBuilderError

Throw error on url build

Example:

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

Test:

public filter(filter: FilterBuilder | object): SearchBuilder source

The search request will have this filter

Params:

Name	Type	Attribute	Description
filter	FilterBuilder \| object	nullable: false

Return:

SearchBuilder

Example:

 ogapi.subscriptionsSearchBuilder().filter(
     ogapi.newFilterBuilder().and(Ex.like('prov.customid', 'SN32'), Ex.neq('entityId', '1124'))
 ) // Setting FilterBuilder
 ogapi.subscriptionsSearchBuilder().filter(
      {"and": [{"like": {"entityId": "0000000000000001"}}]}
 ) // Custom filter

Test:

public findAllFields(input: *): Promise source

Return a promise which it will contains an array with fields recommended with complete structure

Params:

Name	Type	Attribute	Description
input	*

Return:

Promise

public findFieldPath(field: *): Promise source

Return a promise which it will contains an string with the path of a field

Params:

Name	Type	Attribute	Description
field	*

Return:

Promise

public findFields(input: *): Promise source

Return a promise which it will contains an array with fields recommended with only identifier

Params:

Name	Type	Attribute	Description
input	*

Return:

Promise

public limit(size: number, start: number): SearchBuilder source

Set reponse pagination.

Params:

Name	Type	Attribute	Description
size	number	nullable: false	Defined the number of elements on response
start	number	optional default: 0	Defined the offset on response

Return:

SearchBuilder

Example:

 ogapi.subscribersSearchBuilder().limit(10) // Without offset
 ogapi.subscribersSearchBuilder().limit(25,50) //With offset value 50

Test:

Check funcionality newSearchBuilder module: Check on entity searching: On limit:

public removeSortBy(filterField: string): SearchBuilder source

Remove sort param from the search object

Params:

Name	Type	Attribute	Description
filterField	string		This field must be allowed into the specific resource

Return:

SearchBuilder

Example:

 ogapi.subscriptionsSearchBuilder().removeSortBy('prov.customid') // Remove order by prov.customid
 ogapi.subscriptionsSearchBuilder().removeSortBy() // Remove all order by parameters

public withTimeout(ms: number): SearchBuilder source

The request will have a specific time out if it will be exceeded then the promise throw an exception

Params:

Name	Type	Attribute	Description
ms	number		timeout in milliseconds

Return:

SearchBuilder

Example:

 ogapi.subscriptionsSearchBuilder().withTimeout(2000)