Class QuickConnectApi

QuickConnectApi - object-oriented interface

Export

QuickConnectApi

Hierarchy

BaseAPI
- QuickConnectApi

Index

Constructors

Properties

axios basePath configuration

Methods

authorizeQuickConnect getQuickConnectEnabled getQuickConnectState initiateQuickConnect

Constructors

constructor

new QuickConnectApi(configuration?, basePath?, axios?): QuickConnectApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns QuickConnectApi
Inherited from BaseAPI.constructor
- Defined in generated-client/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

authorizeQuickConnect

authorizeQuickConnect(requestParameters, options?): Promise<AxiosResponse<boolean, any>>
Parameters
- requestParameters: QuickConnectApiAuthorizeQuickConnectRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<boolean, any>>
Summary
Authorizes a pending quick connect request.

Throws
Memberof
QuickConnectApi
- Defined in generated-client/api/quick-connect-api.ts:337

getQuickConnectEnabled

getQuickConnectEnabled(options?): Promise<AxiosResponse<boolean, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<boolean, any>>
Summary
Gets the current quick connect state.

Throws
Memberof
QuickConnectApi
- Defined in generated-client/api/quick-connect-api.ts:348

getQuickConnectState

getQuickConnectState(requestParameters, options?): Promise<AxiosResponse<QuickConnectResult, any>>
Parameters
- requestParameters: QuickConnectApiGetQuickConnectStateRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<QuickConnectResult, any>>
Summary
Attempts to retrieve authentication information.

Throws
Memberof
QuickConnectApi
- Defined in generated-client/api/quick-connect-api.ts:360

initiateQuickConnect

initiateQuickConnect(options?): Promise<AxiosResponse<QuickConnectResult, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<QuickConnectResult, any>>
Summary
Initiate a new quick connect request.

Throws
Memberof
QuickConnectApi
- Defined in generated-client/api/quick-connect-api.ts:371