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

public class | source

TimeserieSearchBuilder

Extends:

SearchBuilder → TimeserieSearchBuilder

Defined a search over timeseries

Example:

ogapi.timeserieSearchBuilder(organization, timeserieId)

Constructor Summary

Public Constructor
public	constructor(parent: InternalOpenGateAPI)

Method Summary

Public Methods
public	build(): Search Build a instance of Search
public	group(group: object): TimeserieSearchBuilder The search request will have this group by
public	select(select: SelectBuilder \| object): TimeserieSearchBuilder The search request will have this filter
public	sort(sort: string): TimeserieSearchBuilder The search request will use this sort

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 Methods

public build(): Search source

Build a instance of Search

Override:

SearchBuilder#build

Return:

Throw:

SearchBuilderError

Throw error on url build

Example:

 ogapi.timeserieSearchBuilder(organization, timeserieId).build()

public group(group: object): TimeserieSearchBuilder source

The search request will have this group by

Params:

Name	Type	Attribute	Description
group	object	nullable: false

Return:

TimeserieSearchBuilder

Example:

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

The search request will have this filter

Params:

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

Return:

TimeserieSearchBuilder

Example:

 ogapi.timeserieSearchBuilder(organization, timeserieId).select(
     ogapi.newSelectBuilder().add(SE.element("Identifier", ["value"], "id"), SE.add("Temperature", ["value"]))
 ) // Setting SelectBuilder
 ogapi.timeserieSearchBuilder(organization, timeserieId).select({ "elements": [{"name": "Identifier",
	"fields": [{"field": "value","alias": "identifier"}]},
     {"name": "Temperature","fields": [{"field": "value","alias": "identifier"}]}]
  }) //Custom select

public sort(sort: string): TimeserieSearchBuilder source

The search request will use this sort

Params:

Name	Type	Attribute	Description
sort	string	nullable: false

Return:

TimeserieSearchBuilder