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

public class | source

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 Summary

Public Constructor
public	constructor(ogapi: InternalOpenGateAPI, timeout: number) Constructor

Member Summary

Public Members
public	path: *
public	publicParameters: boolean

Method Summary

Public Methods
public	build(): *
public	execute(): Promise This invoke a request to OpenGate North API and the callback is managed by promises
public	withPath(path: string): BasicTypesSearchBuilder Sets path to search
public	withPublicParameters(publicParameters: boolean): BasicTypesSearchBuilder Sets publicParameters to search

Public Constructors

public constructor(ogapi: InternalOpenGateAPI, timeout: number) source

Constructor

Params:

Name	Type	Attribute	Description
ogapi	InternalOpenGateAPI	nullable: false	this is ogapi instance
timeout	number	optional nullable: false	timeout on request

Public Members

public path: * source

public publicParameters: boolean source

Public Methods

public build(): * source

Return:

public execute(): Promise source

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

Return:

Promise

Return Properties:

Name	Type	Attribute	Description
then	function(result: object, statusCode: number)		When request it is OK
catch	function(error: string)		When request it is NOK

public withPath(path: string): BasicTypesSearchBuilder source

Sets path to search

Params:

Name	Type	Attribute	Description
path	string	nullable: false	jsonSchemaPath

Return:

BasicTypesSearchBuilder

Example:

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

public withPublicParameters(publicParameters: boolean): BasicTypesSearchBuilder source

Sets publicParameters to search

Params:

Name	Type	Attribute	Description
publicParameters	boolean	nullable: false	boolean

Return:

BasicTypesSearchBuilder

Example:

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