Implementation of services for the Angular SDK based on a REST backend.

API Documentation

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

ng-rest package

Implementation of services for the React SDK based on a REST backend.

Classes

| Class | Description | | --- | --- | | AcNgRestApiUrlModule | Module that provides the ACOUSTIC_TOKEN_API_URL. Use this to explicitly override the API URL, e.g. in case the application is hosted externally or in case the system is configured for local development. In the typical production case when the application is hosted from Acoustic Content there is no need to configure the API URL explicitly. | | AcNgRestAuthStatusModule | /** Angular Module that exposes an implementation of ACOUSTIC_TOKEN_AUTH_STATUS. | | AcNgRestContentModule | Angular Module that exposes an implementation of ACOUSTIC_TOKEN_DELIVERY_CONTENT_RESOLVER. | | AcNgRestFetchTextModule | Angular Module that provides an implementation of ACOUSTIC_TOKEN_FETCH_TEXT | | AcNgRestLayoutMappingModule | Angular Module that exposes an implementation of ACOUSTIC_TOKEN_DELIVERY_LAYOUT_MAPPING_RESOLVER. | | AcNgRestLayoutModule | Angular Module that exposes an implementation of ACOUSTIC_TOKEN_DELIVERY_LAYOUT_RESOLVER. | | AcNgRestModule | Angular Module that exposes common services. | | AcNgRestPageModule | Angular Module that exposes an implementation of ACOUSTIC_TOKEN_DELIVERY_PAGE_RESOLVER. | | AcNgRestSiteModule | Angular Module that exposes an implementation of ACOUSTIC_TOKEN_DELIVERY_SITE_RESOLVER. | | AcNgRestTypeModule | Angular Module that exposes an implementation of ACOUSTIC_TOKEN_DELIVERY_TYPE_RESOLVER. | | AcNgRestUrlConfigModule | Angular Module that exposes an implementation of ACOUSTIC_TOKEN_URL_CONFIG. |

Functions

| Function | Description | | --- | --- | | proxyCreateUrlConfig(aBaseUrl, aApiUrl, aResourceUrl, aDocument) | |

Variables

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

Home > @acoustic-content-sdk/ng-rest > AcNgRestApiUrlModule

AcNgRestApiUrlModule class

Module that provides the ACOUSTIC_TOKEN_API_URL. Use this to explicitly override the API URL, e.g. in case the application is hosted externally or in case the system is configured for local development. In the typical production case when the application is hosted from Acoustic Content there is no need to configure the API URL explicitly.

Signature:

export declare class AcNgRestApiUrlModule 

Methods

| Method | Modifiers | Description | | --- | --- | --- | | forRoot(aApiUrl) | static | Provides the API URL |

Home > @acoustic-content-sdk/ng-rest > AcNgRestAuthStatusModule

AcNgRestAuthStatusModule class

/** Angular Module that exposes an implementation of ACOUSTIC_TOKEN_AUTH_STATUS.

Signature:

export declare class AcNgRestAuthStatusModule 

Home > @acoustic-content-sdk/ng-rest > AcNgRestContentModule

AcNgRestContentModule class

Angular Module that exposes an implementation of ACOUSTIC_TOKEN_DELIVERY_CONTENT_RESOLVER.

Signature:

export declare class AcNgRestContentModule 

Home > @acoustic-content-sdk/ng-rest > AcNgRestFetchTextModule

AcNgRestFetchTextModule class

Angular Module that provides an implementation of ACOUSTIC_TOKEN_FETCH_TEXT

Signature:

export declare class AcNgRestFetchTextModule 

Home > @acoustic-content-sdk/ng-rest > AcNgRestLayoutMappingModule

AcNgRestLayoutMappingModule class

Angular Module that exposes an implementation of ACOUSTIC_TOKEN_DELIVERY_LAYOUT_MAPPING_RESOLVER.

Signature:

export declare class AcNgRestLayoutMappingModule 

Home > @acoustic-content-sdk/ng-rest > AcNgRestLayoutModule

AcNgRestLayoutModule class

Angular Module that exposes an implementation of ACOUSTIC_TOKEN_DELIVERY_LAYOUT_RESOLVER.

Signature:

export declare class AcNgRestLayoutModule 

Home > @acoustic-content-sdk/ng-rest > AcNgRestModule

AcNgRestModule class

Angular Module that exposes common services.

Signature:

export declare class AcNgRestModule 

Properties

| Property | Modifiers | Type | Description | | --- | --- | --- | --- | | VERSION | | WchSdkVersion | Exposes the version information of this module |

Home > @acoustic-content-sdk/ng-rest > AcNgRestPageModule

AcNgRestPageModule class

Angular Module that exposes an implementation of ACOUSTIC_TOKEN_DELIVERY_PAGE_RESOLVER.

Signature:

export declare class AcNgRestPageModule 

Home > @acoustic-content-sdk/ng-rest > AcNgRestSiteModule

AcNgRestSiteModule class

Angular Module that exposes an implementation of ACOUSTIC_TOKEN_DELIVERY_SITE_RESOLVER.

Signature:

export declare class AcNgRestSiteModule 

Home > @acoustic-content-sdk/ng-rest > AcNgRestTypeModule

AcNgRestTypeModule class

Angular Module that exposes an implementation of ACOUSTIC_TOKEN_DELIVERY_TYPE_RESOLVER.

Signature:

export declare class AcNgRestTypeModule 

Home > @acoustic-content-sdk/ng-rest > AcNgRestUrlConfigModule

AcNgRestUrlConfigModule class

Angular Module that exposes an implementation of ACOUSTIC_TOKEN_URL_CONFIG.

Signature:

export declare class AcNgRestUrlConfigModule 

Home > @acoustic-content-sdk/ng-rest > proxyCreateUrlConfig

proxyCreateUrlConfig() function

Signature:

export declare function proxyCreateUrlConfig(aBaseUrl?: HubInfoUrlProvider, aApiUrl?: HubInfoUrlProvider, aResourceUrl?: HubInfoUrlProvider, aDocument?: any): Observable<UrlConfig>;

Parameters

| Parameter | Type | Description | | --- | --- | --- | | aBaseUrl | HubInfoUrlProvider | | | aApiUrl | HubInfoUrlProvider | | | aResourceUrl | HubInfoUrlProvider | | | aDocument | any | |

Returns:

Observable<UrlConfig>

Home > @acoustic-content-sdk/ng-rest > 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/ng-rest > AcNgRestApiUrlModule > forRoot

AcNgRestApiUrlModule.forRoot() method

Provides the API URL

Signature:

static forRoot(aApiUrl?: HubInfoUrlProvider): ModuleWithProviders;

Parameters

| Parameter | Type | Description | | --- | --- | --- | | aApiUrl | HubInfoUrlProvider | the API URL |

Returns:

ModuleWithProviders

the preconfigured module

Home > @acoustic-content-sdk/ng-rest > AcNgRestModule > VERSION

AcNgRestModule.VERSION property

Exposes the version information of this module

Signature:

VERSION: WchSdkVersion;