@acoustic-content-sdk/ng-rest 中文文档教程

发布于 4年前 浏览 11 更新于 3年前

npm

基于 REST 后端的 Angular SDK 服务的实现。

API Documentation

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

ng-rest package

基于 REST 后端的 React SDK 服务的实现。

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

提供 ACOUSTIC_TOKEN_API_URL 的模块。 使用它来显式覆盖 API URL,例如,在应用程序托管在外部或系统配置为本地开发的情况下。 在典型的生产案例中,当应用程序由 Acoustic Content 托管时,无需显式配置 API URL。

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 公开了

Signature:

export declare class AcNgRestAuthStatusModule 

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

AcNgRestContentModule class

的 Angular 模块>

Signature:

export declare class AcNgRestContentModule 

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

AcNgRestFetchTextModule class

Angular Module 提供了 ACOUSTIC_TOKEN

Signature:

export declare class AcNgRestFetchTextModule 

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

AcNgRestLayoutMappingModule class

Angular Module 公开了 ACOUSTIC_MAPEL_DELAYOUTPLAYING_TOKEN 的实现>

Signature:

export declare class AcNgRestLayoutMappingModule 

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

AcNgRestLayoutModule class

Angular Module 公开了 ACOUSTEL_codeDIVERYVERRY ACOUSTEL_codeRESIVEVERRY 的实现>

Signature:

export declare class AcNgRestLayoutModule 

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

AcNgRestModule class

Angular Module 公开通用服务。

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 模块 ACOUSTELDRESAGEKVERYK >

Signature:

export declare class AcNgRestPageModule 

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

AcNgRestSiteModule class

的 Angular 模块>

Signature:

export declare class AcNgRestSiteModule 

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

AcNgRestTypeModule class

的 Angular 模块>

Signature:

export declare class AcNgRestTypeModule 

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

AcNgRestUrlConfigModule class

Angular Module 公开了 ACOUSTIC_TOKENG 的实现>

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

首页 > @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;
}

首页 > @acoustic-content-sdk/ng-rest > AcNgRestApiUrlModule > forRoot

AcNgRestApiUrlModule.forRoot() method

提供API URL

签名:

static forRoot(aApiUrl?: HubInfoUrlProvider): ModuleWithProviders;

Parameters

Parameter Type Description
aApiUrl HubInfoUrlProvider the API URL

返回:

ModuleWithProviders

预配置模块

首页 @acoustic-content-sdk/ng-rest > AcNgRestModule > VERSION

AcNgRestModule.VERSION property

暴露这个模块的版本信息

Signature:

VERSION: WchSdkVersion;

npm

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;
更多

友情链接

    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文