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

public class | source

DatapointsSearchBuilder

Extends:

SearchBuilder → DatapointsSearchBuilder

Defined a search over Datastreams

Example:

ogapi.datapointsSearchBuilder()

Constructor Summary

Public Constructor
public	constructor(parent: InternalOpenGateAPI)

Member Summary

Public Members
public	fluentFilter: *
public	tagsFilter: *[]

Method Summary

Public Methods
public	betweenDates(fromDate: date, toDate: date): DatapointsSearchBuilder Set time window to search
public	select(select: SelectBuilder \| object): SearchBuilder The search request will have this filter
public	withDatastream(datastreamId: string): DatapointsSearchBuilder Set datastreamId to search
public	withDeviceId(deviceId: string): DatapointsSearchBuilder Set deviceId to search
public	withFeed(feedId: string): DatapointsSearchBuilder Set feedName to search

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

Public Constructors

public constructor(parent: InternalOpenGateAPI) source

Constructor

Override:

SearchBuilder#constructor

Params:

Name	Type	Attribute	Description
parent	InternalOpenGateAPI	nullable: false	Instance of our InternalOpenGateAPI

Public Members

public fluentFilter: * source

public tagsFilter: *[] source

Public Methods

public betweenDates(fromDate: date, toDate: date): DatapointsSearchBuilder source

Set time window to search

Params:

Name	Type	Attribute	Description
fromDate	date	nullable: false	Add from date
toDate	date	nullable: false	Add to date

Return:

DatapointsSearchBuilder

Throw:

Error

throw error when fromDate or toDate is not typeof date

Example:

ogapi.datapointsSearchBuilder().withDeviceId('myDevice').build()

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

The search request will have this filter

Params:

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

Return:

SearchBuilder

Example:

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

public withDatastream(datastreamId: string): DatapointsSearchBuilder source

Set datastreamId to search

Params:

Name	Type	Attribute	Description
datastreamId	string	nullable: false	Datastream.id of Datapoint

Return:

DatapointsSearchBuilder

Throw:

Error

throw error when datastreamId is not typeof string

Example:

ogapi.datapointsSearchBuilder().withDeviceId('myDevice').build()

public withDeviceId(deviceId: string): DatapointsSearchBuilder source

Set deviceId to search

Params:

Name	Type	Attribute	Description
deviceId	string	nullable: false	Prov.customId of Device

Return:

DatapointsSearchBuilder

Throw:

Error

throw error when deviceId is not typeof string

Example:

ogapi.datapointsSearchBuilder().withDeviceId('myDevice').build()

public withFeed(feedId: string): DatapointsSearchBuilder source

Set feedName to search

Params:

Name	Type	Attribute	Description
feedId	string	nullable: false	Datastream.id of Datapoint

Return:

DatapointsSearchBuilder

Throw:

Error

throw error when datastreamId is not typeof string

Example:

ogapi.datapointsSearchBuilder().withDeviceId('myDevice').build()