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

public class | source

DevicesSearchBuilder

Extends:

SearchBuilder → FlattenedSearchBuilder → PreFilteredSearchBuilder → DevicesSearchBuilder

Defined a search over Devices

Example:

ogapi.devicesSearchBuilder()

Constructor Summary

Public Constructor
public	constructor(parent: InternalOpenGateAPI)

Method Summary

Public Methods
public	group(group: object): DevicesSearchBuilder The search request will have this group by
public	summary(): DevicesSearchBuilder The response will only have a summary information

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

From class PreFilteredSearchBuilder
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

Public Constructors

public constructor(parent: InternalOpenGateAPI) source

Constructor

Override:

PreFilteredSearchBuilder#constructor

Params:

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

Public Methods

public group(group: object): DevicesSearchBuilder source

The search request will have this group by

Params:

Name	Type	Attribute	Description
group	object	nullable: false

Return:

DevicesSearchBuilder

Example:

public summary(): DevicesSearchBuilder source

The response will only have a summary information

Return:

DevicesSearchBuilder

Example:

ogapi.devicesSearchBuilder().summary()

DevicesSearchBuilder

Extends:

Example:

Constructor Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(parent: InternalOpenGateAPI) source

Override:

Params:

Public Methods

public group(group: object): DevicesSearchBuilder source

Params:

Return:

Example:

public summary(): DevicesSearchBuilder source

Return:

Example:

Test: