Class ConnectionREST

Hierarchy (view full)

ConnectionREST
- ConnectionGQL

Index

Constructors

Properties

apiKey? authEnabled host http oidcAuth?

Methods

delete get head login parseAuthParams patch postEmpty postReturn put sanitizeParams

Constructors

constructor

new ConnectionREST(params): ConnectionREST
Parameters
- params: InternalConnectionParams
Returns ConnectionREST
- Defined in connection/http.ts:62

Properties

`Private` `Optional` apiKey

apiKey?: string

`Protected` authEnabled

authEnabled: boolean

`Readonly` host

host: string

`Readonly` http

http: HttpClient

`Optional` oidcAuth

oidcAuth?: OidcAuthenticator

Methods

delete

delete(path, payload, expectReturnContent?): any
Parameters
- path: string
- payload: any
- expectReturnContent: boolean = false
Returns any
- Defined in connection/http.ts:146

get

get<T>(path, expectReturnContent?): Promise<T>
Type Parameters
- T
Parameters
- path: string
- expectReturnContent: boolean = true
Returns Promise<T>
- Defined in connection/http.ts:160

head

head(path, payload): any
Parameters
- path: string
- payload: any
Returns any
- Defined in connection/http.ts:153

login

login(): Promise<string>
Returns Promise<string>
- Defined in connection/http.ts:167

`Private` parseAuthParams

parseAuthParams(params): boolean
Parameters
- params: InternalConnectionParams
Returns boolean
- Defined in connection/http.ts:69

patch

patch(path, payload): any
Parameters
- path: string
- payload: any
Returns any
- Defined in connection/http.ts:139

postEmpty

postEmpty<B>(path, payload): Promise<void>
Type Parameters
- B
Parameters
- path: string
- payload: B
Returns Promise<void>
- Defined in connection/http.ts:125

postReturn

postReturn<B, T>(path, payload): Promise<T>
Type Parameters
- B
- T
Parameters
- path: string
- payload: B
Returns Promise<T>
- Defined in connection/http.ts:116

put

put(path, payload, expectReturnContent?): any
Parameters
- path: string
- payload: any
- expectReturnContent: boolean = true
Returns any
- Defined in connection/http.ts:132

`Private` sanitizeParams

sanitizeParams(params): InternalConnectionParams
Parameters
- params: InternalConnectionParams
Returns InternalConnectionParams
- Defined in connection/http.ts:86