Definition of interfaces for services and components that use the REST API of Acoustic Content.

API Documentation

API Documentation

Home > @acoustic-content-sdk/rest-api

rest-api package

Definition of interfaces for services and components that use the REST API of Acoustic Content.

Enumerations

| Enumeration | Description | | --- | --- | | FETCH_PRIORITY | Priority of the actual request |

Variables

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

Type Aliases

| Type Alias | Description | | --- | --- | | FetchText | Callback interface used to make a GET request to the resource and to ask for text content.The URL can be a relative URL and will be resolved against the API URL | | WriteText | Callback interface used to send data to the server.The URL can be a relative URL and will be resolved against the API URL |

Home > @acoustic-content-sdk/rest-api > FETCH_PRIORITY

FETCH_PRIORITY enum

Priority of the actual request

Signature:

export declare enum FETCH_PRIORITY 

Enumeration Members

| Member | Value | Description | | --- | --- | --- | | HIGH | 2 | | | LOW | 0 | | | NORMAL | 1 | |

Home > @acoustic-content-sdk/rest-api > VERSION

VERSION variable

Version and build number of the package

Signature:

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

Home > @acoustic-content-sdk/rest-api > FetchText

FetchText type

Callback interface used to make a GET request to the resource and to ask for text content.

The URL can be a relative URL and will be resolved against the API URL

Signature:

export declare type FetchText = (aUrl: string, aPriority?: FETCH_PRIORITY) => Observable<string>;

Home > @acoustic-content-sdk/rest-api > WriteText

WriteText type

Callback interface used to send data to the server.

The URL can be a relative URL and will be resolved against the API URL

Signature:

export declare type WriteText = (aUrl: string, aBody: any, aPriority?: FETCH_PRIORITY) => Observable<any>;