Home Manual Reference Source Test Repository 
import RawSearchBuilder from 'opengate-js/src/searching/builder/RawSearchBuilder.js'
public class | source

RawSearchBuilder

Defined a search over custom resource and custom filter

Example:

ogapi.rawSearchBuilder().from('myresource').filter({and:[]})

Constructor Summary

Public Constructor
public

constructor(ogapi: *)

Method Summary

Public Methods
public

build(): *

Create Search instance
public

filter(rawFilter: object): *

Set raw filter
public

from(url: string): *

Set custom url
public

limit(rawLimit: object): *

Set raw limit

Public Constructors

public constructor(ogapi: *) source

Params:

NameTypeAttributeDescription
ogapi *

Public Methods

public build(): * source

Create Search instance

Return:

*

Search

Throw:

Error

throw error when url is not typeof string

public filter(rawFilter: object): * source

Set raw filter

Params:

NameTypeAttributeDescription
rawFilter object

raw filter

Return:

*

RawSearchBuilder

public from(url: string): * source

Set custom url

Params:

NameTypeAttributeDescription
url string

custom Opengate North API url

Return:

*

RawSearchBuilder

Throw:

Error

throw error when url is not typeof string

public limit(rawLimit: object): * source

Set raw limit

Params:

NameTypeAttributeDescription
rawLimit object

raw limit

Return:

*

RawSearchBuilder