Class AzureWebCore

Class to handle Azure-specific web core operations. Implements the WebCoreService interface.

Implements

Constructors

constructor

Properties

config logger sharedAxiosInstance tokenStorage

Methods

buildRequest buildSignedRequest getSavedToken getSharedAxiosInstance getTokenStorage init isAuthenticated logout request saveOAuthToken setUseXLemonIdentity setUseXLemonLanguage signedRequest

Constructors

constructor

Properties

Private Readonly config

config: WebCoreConfig<"azure">

The configuration for the Azure web core.

Private Readonly logger

logger: LoggerService

Private sharedAxiosInstance

sharedAxiosInstance: AxiosInstance

Private Readonly tokenStorage

tokenStorage: AzureStorageService

Methods

buildRequest

buildSignedRequest

getSavedToken

  • getSavedToken(): Promise<{
        [key: string]: string;
    }>

  • Retrieves all saved tokens from the storage.

    Returns Promise<{
        [key: string]: string;
    }>

    • An object containing all saved tokens.

getSharedAxiosInstance

getTokenStorage

init

isAuthenticated

logout

  • logout(): Promise<void>

  • Logs the user out by clearing the OAuth token from the storage.

    Returns Promise<void>

    • A promise that resolves when the user is logged out.

request

  • request<T>(method, url, params?, body?, config?): Promise<HttpResponse<T>>

  • Executes a HTTP request without Credentials.

    Type Parameters

    • T

    Parameters

    • method: string

      The HTTP method.

    • url: string

      The request URL.

    • Optional params: Params = {}

      The request parameters.

    • Optional body: Body

      The request body.

    • Optional config: AxiosRequestConfig<any>

      Additional Axios request configuration.

    Returns Promise<HttpResponse<T>>

    • The Axios response.

saveOAuthToken

  • saveOAuthToken(token): Promise<void>

  • Saves an OAuth token to the storage.

    Parameters

    Returns Promise<void>

    • A promise that resolves when the token is saved.

setUseXLemonIdentity

  • setUseXLemonIdentity(use): Promise<void>

  • Sets whether to use the x-lemon-identity header.

    Parameters

    • use: boolean

      True to use the x-lemon-identity header, otherwise false.

    Returns Promise<void>

    • A promise that resolves when the setting is updated.

setUseXLemonLanguage

  • setUseXLemonLanguage(use, key?): Promise<void>

  • Sets whether to use the X-Lemon-Language header with a specific key.

    Parameters

    • use: boolean

      Whether to use the X-Lemon-Language header.

    • Optional key: string

    Returns Promise<void>

signedRequest

  • signedRequest<T>(method, url, params?, body?, config?): Promise<HttpResponse<T>>

  • Executes a signed HTTP request.

    Type Parameters

    • T

    Parameters

    • method: string

      The HTTP method to use for the request.

    • url: string

      The URL for the request.

    • Optional params: Params = {}

      The URL parameters for the request.

    • Optional body: Body

      The request body.

    • Optional config: AxiosRequestConfig<any>

      Additional Axios request configuration.

    Returns Promise<HttpResponse<T>>

    • The Axios response.

Settings

Member Visibility

Theme

On This Page

constructorconfigloggersharedAxiosInstancetokenStoragebuildRequestbuildSignedRequestgetSavedTokengetSharedAxiosInstancegetTokenStorageinitisAuthenticatedlogoutrequestsaveOAuthTokensetUseXLemonIdentitysetUseXLemonLanguagesignedRequest