Class Client

IQRF Gateway Webapp API client class

Client is a wrapper around API methods of IQRF Gateway Webapp providing shared configuration for Axios instance.

Instantiate with defaults

const client = new Client();

Instantiate with custom configuration

const config: AxiosRequestConfig = {
    baseURL: 'https://iqrf-gw.exaple.org/api/',
};
const client = new Client({config});

Instantiate with custom Axios instance advanced

const config: AxiosRequestConfig = {
    baseURL: 'https://iqrf-gw.exaple.org/api/',
}
const axiosInstance = axios.create(config);
const client = new Client({axiosInstance});

Constructors

constructor

Properties

axiosInstance defaultAxiosConfig requestInterceptorId token

Methods

clearRequestInterceptors clearResponseInterceptors ejectRequestInterceptor ejectResponseInterceptor getAccountService getApiKeyService getAuthenticationService getAxiosInstance getCloudServices getConfigServices getFeatureService getGatewayServices getInstallationService getIqrfServices getMaintenanceServices getMenderService getNetworkServices getOpenApiService getServiceService getUserService getVersionService registerRequestInterceptor setToken useRequestInterceptor useResponseInterceptor

Constructors

constructor

  • new Client(__namedParameters?): Client

  • Constructs IQRF Gateway Webapp API client

    Parameters

    Returns Client

Properties

Private axiosInstance

axiosInstance: AxiosInstance

Private Readonly defaultAxiosConfig

defaultAxiosConfig: AxiosRequestConfig<any> = ...

Private Readonly requestInterceptorId

requestInterceptorId: undefined | number

Private token

token: null | string = null

Methods

clearRequestInterceptors

  • clearRequestInterceptors(): void

  • Clears all request interceptors

    Returns void

clearResponseInterceptors

  • clearResponseInterceptors(): void

  • Clears all response interceptors

    Returns void

ejectRequestInterceptor

  • ejectRequestInterceptor(interceptorId): void

  • Ejects a request interceptor

    Parameters

    • interceptorId: number

      Interceptor ID

    Returns void

ejectResponseInterceptor

  • ejectResponseInterceptor(interceptorId): void

  • Ejects a response interceptor

    Parameters

    • interceptorId: number

      Interceptor ID

    Returns void

getAccountService

  • getAccountService(): AccountService

  • Returns Account service

    Returns AccountService

    Account service

getApiKeyService

  • getApiKeyService(): ApiKeyService

  • Returns API key service

    Returns ApiKeyService

    API key service

getAuthenticationService

  • getAuthenticationService(): AuthenticationService

  • Returns Authentication service

    Returns AuthenticationService

    Authentication service

getAxiosInstance

  • getAxiosInstance(): AxiosInstance

  • Returns Axios instance

    Returns AxiosInstance

    Axios instance

getCloudServices

  • getCloudServices(): CloudServices

  • Returns Cloud services

    Returns CloudServices

    Cloud services

getConfigServices

  • getConfigServices(): ConfigServices

  • Returns configuration services

    Returns ConfigServices

    Configuration services

getFeatureService

  • getFeatureService(): FeatureService

  • Returns Feature service

    Returns FeatureService

    Feature service

getGatewayServices

  • getGatewayServices(): GatewayServices

  • Returns Gateway services

    Returns GatewayServices

    Gateway services

getInstallationService

  • getInstallationService(): InstallationService

  • Returns Installation service

    Returns InstallationService

    Installation service

getIqrfServices

  • getIqrfServices(): IqrfServices

  • Returns IQRF services

    Returns IqrfServices

    IQRF services

getMaintenanceServices

  • getMaintenanceServices(): MaintenanceServices

  • Returns Maintenance services

    Returns MaintenanceServices

    Maintenance services

getMenderService

  • getMenderService(): MenderService

  • Returns Mender service

    Returns MenderService

    Mender service

getNetworkServices

  • getNetworkServices(): NetworkServices

  • Returns Network services

    Returns NetworkServices

    Network services

getOpenApiService

  • getOpenApiService(): OpenApiService

  • Returns OpenAPI specification service

    Returns OpenApiService

    OpenAPI specification service

getServiceService

  • getServiceService(): ServiceService

  • Returns System service service

    Returns ServiceService

    System service service

getUserService

  • getUserService(): UserService

  • Returns User service

    Returns UserService

    User service

getVersionService

  • getVersionService(): VersionService

  • Returns Version service

    Returns VersionService

    Version service

Private registerRequestInterceptor

  • registerRequestInterceptor(): void
  • Private

    Registers a request interceptor that adds an Authorization header with API key or JWT token

    Returns void

setToken

  • setToken(token): void

  • Sets API key or JWT token

    Parameters

    • token: null | string

      API key or JWT token

    Returns void

    Todo

    Implement API key and JWT validation

useRequestInterceptor

  • useRequestInterceptor(onFulfilled?, onRejected?, options?): number

  • Adds a request interceptor

    Parameters

    • Optional onFulfilled: null | ((value) => InternalAxiosRequestConfig<any> | Promise<InternalAxiosRequestConfig<any>>)

      Fulfilled callback

    • Optional onRejected: null | ((error) => any)

      Rejected callback

    • Optional options: AxiosInterceptorOptions

      Interceptor options

    Returns number

    Interceptor ID

useResponseInterceptor

  • useResponseInterceptor(onFulfilled?, onRejected?, options?): number

  • Adds a response interceptor

    Parameters

    • Optional onFulfilled: null | ((value) => AxiosResponse<any, any> | Promise<AxiosResponse<any, any>>)

      Fulfilled callback

    • Optional onRejected: null | ((error) => any)

      Rejected callback

    • Optional options: AxiosInterceptorOptions

      Interceptor options

    Returns number

    Interceptor ID

Settings

Member Visibility

Theme

On This Page

constructoraxiosInstancedefaultAxiosConfigrequestInterceptorIdtokenclearRequestInterceptorsclearResponseInterceptorsejectRequestInterceptorejectResponseInterceptorgetAccountServicegetApiKeyServicegetAuthenticationServicegetAxiosInstancegetCloudServicesgetConfigServicesgetFeatureServicegetGatewayServicesgetInstallationServicegetIqrfServicesgetMaintenanceServicesgetMenderServicegetNetworkServicesgetOpenApiServicegetServiceServicegetUserServicegetVersionServiceregisterRequestInterceptorsetTokenuseRequestInterceptoruseResponseInterceptor