Implementation of the fetchText and writeText callbacks against Acoustic Content.

API Documentation

Home > @acoustic-content-sdk/redux-ajax

redux-ajax package

Implementation of the fetchText and writeText callbacks.

Functions

| Function | Description | | --- | --- | | fetchTextAjax(apiBase, aLoggerService) | Creates a callback function that loads content via HTTP GET from the API routes. | | writeJsonAjax(apiBase, aLoggerService) | Creates a callback function that writes content to API routes via PUST, POST or delete |

Variables

| Variable | Description | | --- | --- | | VERSION | Version and build number of the package |

Home > @acoustic-content-sdk/redux-ajax > fetchTextAjax

fetchTextAjax() function

Creates a callback function that loads content via HTTP GET from the API routes.

Signature:

export declare function fetchTextAjax(apiBase: StaticHubInfoUrlProvider | PromiseLike<StaticHubInfoUrlProvider>, aLoggerService?: LoggerService): FetchText;

Parameters

| Parameter | Type | Description | | --- | --- | --- | | apiBase | StaticHubInfoUrlProvider | PromiseLike<StaticHubInfoUrlProvider> | the API URL. | | aLoggerService | LoggerService | |

Returns:

FetchText

the callback function

Home > @acoustic-content-sdk/redux-ajax > writeJsonAjax

writeJsonAjax() function

Creates a callback function that writes content to API routes via PUST, POST or delete

Signature:

export declare function writeJsonAjax(apiBase: StaticHubInfoUrlProvider | PromiseLike<StaticHubInfoUrlProvider>, aLoggerService?: LoggerService): WriteText;

Parameters

| Parameter | Type | Description | | --- | --- | --- | | apiBase | StaticHubInfoUrlProvider | PromiseLike<StaticHubInfoUrlProvider> | the API URL. | | aLoggerService | LoggerService | |

Returns:

WriteText

the callback function

Home > @acoustic-content-sdk/redux-ajax > VERSION

VERSION variable

Version and build number of the package

Signature:

VERSION: {
    version: {
        major: string;
        minor: string;
        patch: string;
        branch: string;
    };
    build: Date;
}