Pre Filtered Search Builder

PreFilteredSearchBuilder

PreFilteredSearchBuilder Objects

class PreFilteredSearchBuilder()

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
function constructor()

Constructor

Arguments:

  • parent InternalOpenGateAPI - this is ogapi instance
  • routes object - this defined the routes. One of those routes must be called on Builder before call build method.
collected
function collected() -> 'PreFilteredSearchBuilder'

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

Returns:

  • PreFilteredSearchBuilder

Example:

ogapi.subscribersSearchBuilder().collected()
disableCaseSensitive
function disableCaseSensitive(flag: *) -> 'EntitiesSearchBuilder'

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

Arguments:

  • flag *

Returns:

  • EntitiesSearchBuilder

Example:

ogapi.entitiesSearchBuilder().disableCaseSensitive()
disableDefaultSorted
function disableDefaultSorted() -> 'PreFilteredSearchBuilder'

The response will return a response without sorted

Returns:

  • PreFilteredSearchBuilder

Example:

ogapi.assetsSearchBuilder().disableDefaultSorted()
provisioned
function provisioned() -> 'PreFilteredSearchBuilder'

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

Returns:

  • PreFilteredSearchBuilder

Example:

ogapi.subscribersSearchBuilder().provisioned()
removeCaseSensitive
function removeCaseSensitive() -> 'EntitiesSearchBuilder'

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

Returns:

  • EntitiesSearchBuilder

Example:

ogapi.entitiesSearchBuilder().removeCaseSensitive()
select
function select(select: SelectBuilder,object) -> 'PreFilteredSearchBuilder'

The search request will have this filter

Arguments:

  • select SelectBuilder,object

Returns:

  • 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