Function QuickConnectApiFactory

Returns {
    authorizeQuickConnect(requestParameters: QuickConnectApiAuthorizeQuickConnectRequest, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
    getQuickConnectEnabled(options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
    getQuickConnectState(requestParameters: QuickConnectApiGetQuickConnectStateRequest, options?: RawAxiosRequestConfig): AxiosPromise<QuickConnectResult>;
    initiateQuickConnect(options?: RawAxiosRequestConfig): AxiosPromise<QuickConnectResult>;
}

• authorizeQuickConnect:function

  • authorizeQuickConnect(requestParameters, options?): AxiosPromise<boolean>

  • Parameters

    • requestParameters: QuickConnectApiAuthorizeQuickConnectRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<boolean>

    Summary

    Authorizes a pending quick connect request.

    Throws

• getQuickConnectEnabled:function

  • getQuickConnectEnabled(options?): AxiosPromise<boolean>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<boolean>

    Summary

    Gets the current quick connect state.

    Throws

• getQuickConnectState:function

  • getQuickConnectState(requestParameters, options?): AxiosPromise<QuickConnectResult>

  • Parameters

    • requestParameters: QuickConnectApiGetQuickConnectStateRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<QuickConnectResult>

    Summary

    Attempts to retrieve authentication information.

    Throws

• initiateQuickConnect:function

  • initiateQuickConnect(options?): AxiosPromise<QuickConnectResult>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<QuickConnectResult>

    Summary

    Initiate a new quick connect request.

    Throws