Basic Types Search Builder

BasicTypesSearchBuilder

BasicTypesSearchBuilder Objects

class BasicTypesSearchBuilder()

This is a abstract class, it must be extended to another class that defined the specific search. This class is responsible to manage execute request to OpenGate North API

constructor

function constructor()

Constructor

Arguments:

• ogapi InternalOpenGateAPI - this is ogapi instance
• timeout number (optional) - timeout on request

build

function build() -> '*'

Returns:

• *

execute

function execute() -> 'Promise'

This invoke a request to OpenGate North API and the callback is managed by promises

Returns:

• Promise

path

function path()

publicParameters

function publicParameters()

publicParameters

function publicParameters()

withPath

function withPath(path: string) -> 'BasicTypesSearchBuilder'

Sets path to search

Arguments:

• path string - jsonSchemaPath

Returns:

• BasicTypesSearchBuilder

Example:

 ogapi.basicTypesSearchBuilder().withPath('string').build()

withPublicParameters

function withPublicParameters(publicParameters: boolean) -> 'BasicTypesSearchBuilder'

Sets publicParameters to search

Arguments:

• publicParameters boolean - boolean

Returns:

• BasicTypesSearchBuilder

Example:

 ogapi.basicTypesSearchBuilder().withPublicParameters(true).build()