Class ConnectionREST

Hierarchy (View Summary)

ConnectionREST
- ConnectionGQL

Implements

IConnection

Index

Constructors

Properties

authEnabled host http oidcAuth?

Methods

delete get getDetails head isWcdOnGcp login patch postEmpty postReturn put

Constructors

constructor

new ConnectionREST(params: InternalConnectionParams): ConnectionREST
Parameters
- params: InternalConnectionParams
Returns ConnectionREST
- Defined in packages/core/src/connection/http.ts:83

Properties

`Protected`authEnabled

authEnabled: boolean

`Readonly`host

host: string

`Readonly`http

http: HttpClient

`Optional`oidcAuth

oidcAuth?: OidcAuthenticator

Methods

delete

delete(path: string, payload: any, expectReturnContent?: boolean): any
Parameters
- path: string
- payload: any
- expectReturnContent: boolean = false
Returns any
Implementation of IConnection.delete
- Defined in packages/core/src/connection/http.ts:170

get

get<T>(path: string, expectReturnContent?: boolean): Promise<T>
Type Parameters
- T
Parameters
- path: string
- expectReturnContent: boolean = true
Returns Promise<T>
Implementation of IConnection.get
- Defined in packages/core/src/connection/http.ts:184

getDetails

getDetails(): Promise<ConnectionDetails>
Returns Promise<ConnectionDetails>
Implementation of IConnection.getDetails
- Defined in packages/core/src/connection/http.ts:213

head

head(path: string, payload: any): any
Parameters
- path: string
- payload: any
Returns any
Implementation of IConnection.head
- Defined in packages/core/src/connection/http.ts:177

isWcdOnGcp

isWcdOnGcp(): boolean
Returns boolean
- Defined in packages/core/src/connection/http.ts:91

login(): Promise<string>
Returns Promise<string>
Implementation of IConnection.login
- Defined in packages/core/src/connection/http.ts:191

patch

patch(path: string, payload: any): any
Parameters
- path: string
- payload: any
Returns any
Implementation of IConnection.patch
- Defined in packages/core/src/connection/http.ts:163

postEmpty

postEmpty<B>(path: string, payload: B): Promise<void>
Type Parameters
- B
Parameters
- path: string
- payload: B
Returns Promise<void>
Implementation of IConnection.postEmpty
- Defined in packages/core/src/connection/http.ts:149

postReturn

postReturn<B, T>(path: string, payload: B): Promise<T>
Type Parameters
- B
- T
Parameters
- path: string
- payload: B
Returns Promise<T>
Implementation of IConnection.postReturn
- Defined in packages/core/src/connection/http.ts:142

put

put(path: string, payload: any, expectReturnContent?: boolean): any
Parameters
- path: string
- payload: any
- expectReturnContent: boolean = true
Returns any
Implementation of IConnection.put
- Defined in packages/core/src/connection/http.ts:156