@acoustic-content-sdk/component-rest 中文文档教程
基类的实现,实现基于REST的SDK服务。
Home > @acoustic-content-sdk/component-rest
component-rest package
基类的实现,实现基于REST的SDK服务。
Classes
Class | Description |
---|---|
AbstractAuthStatusService | Checks for the authentication status based on a REST request |
AbstractDeliveryContentResolverService | Base class to implement DeliveryContentResolver |
AbstractDeliveryLayoutMappingResolverService | Base class to implement DeliveryLayoutMappingResolver |
AbstractDeliveryLayoutResolverService | Base class to implement DeliveryLayoutResolver |
AbstractDeliveryPageResolverService | Base class to implement DeliveryPageResolver |
AbstractDeliveryTypeResolverService | Base class to implement DeliveryTypeResolver |
AbstractSiteResolverService |
Functions
Function | Description |
---|---|
createUrlConfig(aBaseUrl, aApiUrl, aResourceUrl, aDocument) | Construcs a UrlConfig object based on some configuration |
Variables
Variable | Description |
---|---|
VERSION | Version and build number of the package |
Home > @acoustic-content-sdk/component-rest > AbstractAuthStatusService
AbstractAuthStatusService class
Checks for the authentication status based on a REST request
Signature:
export declare class AbstractAuthStatusService implements AuthStatus
Constructors
Constructor | Modifiers | Description |
---|---|---|
(constructor)(aFetchText, aLogSvc) | Initialization of the service. |
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
authenticated$ | Observable<boolean> |
主页 > @acoustic-content-sdk/component-rest > AbstractDeliveryContentResolverService
AbstractDeliveryContentResolverService class
Base class to implement DeliveryContentResolver
Signature:
export declare class AbstractDeliveryContentResolverService implements DeliveryContentResolver
Constructors
Constructor | Modifiers | Description |
---|---|---|
(constructor)(aSearch, aLogSvc) | Initialization |
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
getDeliveryContentItem | (aID: string) => Observable<DeliveryContentItem> |
主页 > @acoustic-content-sdk/component-rest > AbstractDeliveryLayoutMappingResolverService
AbstractDeliveryLayoutMappingResolverService class
Base class to implement DeliveryLayoutMappingResolver
Signature:
export declare class AbstractDeliveryLayoutMappingResolverService implements DeliveryLayoutMappingResolver
Constructors
Constructor | Modifiers | Description |
---|---|---|
(constructor)(aSearch, aLogSvc) | Initialization |
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
getDeliveryLayoutMapping | (aTypeId: string) => Observable<DeliveryLayoutMapping> |
主页 > @acoustic-content-sdk/component-rest > AbstractDeliveryLayoutResolverService
AbstractDeliveryLayoutResolverService class
Base class to implement DeliveryLayoutResolver
Signature:
export declare class AbstractDeliveryLayoutResolverService implements DeliveryLayoutResolver
Constructors
Constructor | Modifiers | Description |
---|---|---|
(constructor)(aSearch, aLogSvc) | Initialization |
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
getDeliveryLayout | (aID: string) => Observable<DeliveryLayout> |
主页 > @acoustic-content-sdk/component-rest > AbstractDeliveryPageResolverService
AbstractDeliveryPageResolverService class
Base class to implement DeliveryPageResolver
Signature:
export declare class AbstractDeliveryPageResolverService implements DeliveryPageResolver
Constructors
Constructor | Modifiers | Description |
---|---|---|
(constructor)(aSearch, aLogSvc) | Initialization |
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
getDeliveryPage | (aPath: string) => Observable<DeliveryContentItem> |
主页 > @acoustic-content-sdk/component-rest > AbstractDeliveryTypeResolverService
AbstractDeliveryTypeResolverService class
Base class to implement DeliveryTypeResolver
Signature:
export declare class AbstractDeliveryTypeResolverService implements DeliveryTypeResolver
Constructors
Constructor | Modifiers | Description |
---|---|---|
(constructor)(aSearch, aLogSvc) | Initialization |
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
getDeliveryType | (aId: string) => Observable<DeliveryType> |
主页 > @acoustic-content-sdk/component-rest > AbstractSiteResolverService
AbstractSiteResolverService class
Signature:
export declare class AbstractSiteResolverService implements DeliverySiteResolver
Constructors
Constructor | Modifiers | Description |
---|---|---|
(constructor)(aFetchText, aProtected, aLogSvc) | Constructs a new instance of the AbstractSiteResolverService class |
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
getSiteDeliveryContentItem | () => Observable<SiteDeliveryContentItem> |
Home > ; @acoustic-content-sdk/component-rest > createUrlConfig
createUrlConfig() function
根据一些配置构造一个UrlConfig
对象
签名:
export declare function createUrlConfig(aBaseUrl?: HubInfoUrlProvider, aApiUrl?: HubInfoUrlProvider, aResourceUrl?: HubInfoUrlProvider, aDocument?: any): Observable<UrlConfig>;
Parameters
Parameter | Type | Description |
---|---|---|
aBaseUrl | HubInfoUrlProvider | the base URL |
aApiUrl | HubInfoUrlProvider | the API URL |
aResourceUrl | HubInfoUrlProvider | the resource URL |
aDocument | any | the document |
返回:
Observable
the observable of the UrlConfig
object
Home > @acoustic-content-sdk/component-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/component-rest > AbstractAuthStatusService > (构造函数)
AbstractAuthStatusService.(constructor)
服务的初始化。
Signature:
protected constructor(aFetchText: FetchText, aLogSvc?: LoggerService);
Parameters
Parameter | Type | Description |
---|---|---|
aFetchText | FetchText | the callback to make a request |
aLogSvc | LoggerService | the logger service |
Home > @acoustic-content-sdk/component-rest > AbstractAuthStatusService > authenticated$
AbstractAuthStatusService.authenticated$ property
Signature:
authenticated$: Observable<boolean>;
Home > @acoustic-content-sdk/component-rest > AbstractDeliveryContentResolverService > (constructor)
AbstractDeliveryContentResolverService.(constructor)
Initialization
Signature:
protected constructor(aSearch: DeliverySearchResolver, aLogSvc?: LoggerService);
Parameters
Parameter | Type | Description |
---|---|---|
aSearch | DeliverySearchResolver | search service that is uses to back the content service |
aLogSvc | LoggerService | logger service |
Home > @acoustic-content-sdk/component-rest > AbstractDeliveryContentResolverService > getDeliveryContentItem
AbstractDeliveryContentResolverService.getDeliveryContentItem property
Signature:
getDeliveryContentItem: (aID: string) => Observable<DeliveryContentItem>;
Home > ; @acoustic-content-sdk/component-rest > AbstractDeliveryLayoutMappingResolverService > (constructor)
AbstractDeliveryLayoutMappingResolverService.(constructor)
Initialization
Signature:
protected constructor(aSearch: DeliverySearchResolver, aLogSvc?: LoggerService);
Parameters
Parameter | Type | Description |
---|---|---|
aSearch | DeliverySearchResolver | search service that is uses to back the content service |
aLogSvc | LoggerService | logger service |
Home > @acoustic-content-sdk/component-rest > AbstractDeliveryLayoutMappingResolverService > getDeliveryLayoutMapping
AbstractDeliveryLayoutMappingResolverService.getDeliveryLayoutMapping property
Signature:
getDeliveryLayoutMapping: (aTypeId: string) => Observable<DeliveryLayoutMapping>;
Home > ; @acoustic-content-sdk/component-rest > AbstractDeliveryLayoutResolverService > (constructor)
AbstractDeliveryLayoutResolverService.(constructor)
Initialization
Signature:
protected constructor(aSearch: DeliverySearchResolver, aLogSvc?: LoggerService);
Parameters
Parameter | Type | Description |
---|---|---|
aSearch | DeliverySearchResolver | search service that is uses to back the content service |
aLogSvc | LoggerService | logger service |
Home > @acoustic-content-sdk/component-rest > AbstractDeliveryLayoutResolverService > getDeliveryLayout
AbstractDeliveryLayoutResolverService.getDeliveryLayout property
Signature:
getDeliveryLayout: (aID: string) => Observable<DeliveryLayout>;
Home > ; @acoustic-content-sdk/component-rest > AbstractDeliveryPageResolverService > (constructor)
AbstractDeliveryPageResolverService.(constructor)
Initialization
Signature:
protected constructor(aSearch: DeliverySearchResolver, aLogSvc?: LoggerService);
Parameters
Parameter | Type | Description |
---|---|---|
aSearch | DeliverySearchResolver | search service that is uses to back the content service |
aLogSvc | LoggerService | logger service |
Home > @acoustic-content-sdk/component-rest > AbstractDeliveryPageResolverService > getDeliveryPage
AbstractDeliveryPageResolverService.getDeliveryPage property
Signature:
getDeliveryPage: (aPath: string) => Observable<DeliveryContentItem>;
Home > ; @acoustic-content-sdk/component-rest > AbstractDeliveryTypeResolverService > (constructor)
AbstractDeliveryTypeResolverService.(constructor)
Initialization
Signature:
protected constructor(aSearch: DeliverySearchResolver, aLogSvc?: LoggerService);
Parameters
Parameter | Type | Description |
---|---|---|
aSearch | DeliverySearchResolver | search service that is uses to back the content service |
aLogSvc | LoggerService | logger service |
Home > @acoustic-content-sdk/component-rest > AbstractDeliveryTypeResolverService > getDeliveryType
AbstractDeliveryTypeResolverService.getDeliveryType property
Signature:
getDeliveryType: (aId: string) => Observable<DeliveryType>;
Home > ; @acoustic-content-sdk/component-rest > AbstractSiteResolverService > (constructor)
AbstractSiteResolverService.(constructor)
Constructs a new instance of the AbstractSiteResolverService
class
Signature:
protected constructor(aFetchText: FetchText, aProtected: ProtectedContent, aLogSvc?: LoggerService);
Parameters
Parameter | Type | Description |
---|---|---|
aFetchText | FetchText | |
aProtected | ProtectedContent | |
aLogSvc | LoggerService |
主页 > @acoustic-content-sdk/component-rest > AbstractSiteResolverService > getSiteDeliveryContentItem
AbstractSiteResolverService.getSiteDeliveryContentItem property
签名:
getSiteDeliveryContentItem: () => Observable<SiteDeliveryContentItem>;
Implementation of base classes to implement SDK services based on REST.
Home > @acoustic-content-sdk/component-rest
component-rest package
Implementation of base classes to implement SDK services based on REST.
Classes
Class | Description |
---|---|
AbstractAuthStatusService | Checks for the authentication status based on a REST request |
AbstractDeliveryContentResolverService | Base class to implement DeliveryContentResolver |
AbstractDeliveryLayoutMappingResolverService | Base class to implement DeliveryLayoutMappingResolver |
AbstractDeliveryLayoutResolverService | Base class to implement DeliveryLayoutResolver |
AbstractDeliveryPageResolverService | Base class to implement DeliveryPageResolver |
AbstractDeliveryTypeResolverService | Base class to implement DeliveryTypeResolver |
AbstractSiteResolverService |
Functions
Function | Description |
---|---|
createUrlConfig(aBaseUrl, aApiUrl, aResourceUrl, aDocument) | Construcs a UrlConfig object based on some configuration |
Variables
Variable | Description |
---|---|
VERSION | Version and build number of the package |
Home > @acoustic-content-sdk/component-rest > AbstractAuthStatusService
AbstractAuthStatusService class
Checks for the authentication status based on a REST request
Signature:
export declare class AbstractAuthStatusService implements AuthStatus
Constructors
Constructor | Modifiers | Description |
---|---|---|
(constructor)(aFetchText, aLogSvc) | Initialization of the service. |
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
authenticated$ | Observable<boolean> |
Home > @acoustic-content-sdk/component-rest > AbstractDeliveryContentResolverService
AbstractDeliveryContentResolverService class
Base class to implement DeliveryContentResolver
Signature:
export declare class AbstractDeliveryContentResolverService implements DeliveryContentResolver
Constructors
Constructor | Modifiers | Description |
---|---|---|
(constructor)(aSearch, aLogSvc) | Initialization |
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
getDeliveryContentItem | (aID: string) => Observable<DeliveryContentItem> |
Home > @acoustic-content-sdk/component-rest > AbstractDeliveryLayoutMappingResolverService
AbstractDeliveryLayoutMappingResolverService class
Base class to implement DeliveryLayoutMappingResolver
Signature:
export declare class AbstractDeliveryLayoutMappingResolverService implements DeliveryLayoutMappingResolver
Constructors
Constructor | Modifiers | Description |
---|---|---|
(constructor)(aSearch, aLogSvc) | Initialization |
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
getDeliveryLayoutMapping | (aTypeId: string) => Observable<DeliveryLayoutMapping> |
Home > @acoustic-content-sdk/component-rest > AbstractDeliveryLayoutResolverService
AbstractDeliveryLayoutResolverService class
Base class to implement DeliveryLayoutResolver
Signature:
export declare class AbstractDeliveryLayoutResolverService implements DeliveryLayoutResolver
Constructors
Constructor | Modifiers | Description |
---|---|---|
(constructor)(aSearch, aLogSvc) | Initialization |
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
getDeliveryLayout | (aID: string) => Observable<DeliveryLayout> |
Home > @acoustic-content-sdk/component-rest > AbstractDeliveryPageResolverService
AbstractDeliveryPageResolverService class
Base class to implement DeliveryPageResolver
Signature:
export declare class AbstractDeliveryPageResolverService implements DeliveryPageResolver
Constructors
Constructor | Modifiers | Description |
---|---|---|
(constructor)(aSearch, aLogSvc) | Initialization |
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
getDeliveryPage | (aPath: string) => Observable<DeliveryContentItem> |
Home > @acoustic-content-sdk/component-rest > AbstractDeliveryTypeResolverService
AbstractDeliveryTypeResolverService class
Base class to implement DeliveryTypeResolver
Signature:
export declare class AbstractDeliveryTypeResolverService implements DeliveryTypeResolver
Constructors
Constructor | Modifiers | Description |
---|---|---|
(constructor)(aSearch, aLogSvc) | Initialization |
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
getDeliveryType | (aId: string) => Observable<DeliveryType> |
Home > @acoustic-content-sdk/component-rest > AbstractSiteResolverService
AbstractSiteResolverService class
Signature:
export declare class AbstractSiteResolverService implements DeliverySiteResolver
Constructors
Constructor | Modifiers | Description |
---|---|---|
(constructor)(aFetchText, aProtected, aLogSvc) | Constructs a new instance of the AbstractSiteResolverService class |
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
getSiteDeliveryContentItem | () => Observable<SiteDeliveryContentItem> |
Home > @acoustic-content-sdk/component-rest > createUrlConfig
createUrlConfig() function
Construcs a UrlConfig
object based on some configuration
Signature:
export declare function createUrlConfig(aBaseUrl?: HubInfoUrlProvider, aApiUrl?: HubInfoUrlProvider, aResourceUrl?: HubInfoUrlProvider, aDocument?: any): Observable<UrlConfig>;
Parameters
Parameter | Type | Description |
---|---|---|
aBaseUrl | HubInfoUrlProvider | the base URL |
aApiUrl | HubInfoUrlProvider | the API URL |
aResourceUrl | HubInfoUrlProvider | the resource URL |
aDocument | any | the document |
Returns:
Observable<UrlConfig>
the observable of the UrlConfig
object
Home > @acoustic-content-sdk/component-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/component-rest > AbstractAuthStatusService > (constructor)
AbstractAuthStatusService.(constructor)
Initialization of the service.
Signature:
protected constructor(aFetchText: FetchText, aLogSvc?: LoggerService);
Parameters
Parameter | Type | Description |
---|---|---|
aFetchText | FetchText | the callback to make a request |
aLogSvc | LoggerService | the logger service |
Home > @acoustic-content-sdk/component-rest > AbstractAuthStatusService > authenticated$
AbstractAuthStatusService.authenticated$ property
Signature:
authenticated$: Observable<boolean>;
Home > @acoustic-content-sdk/component-rest > AbstractDeliveryContentResolverService > (constructor)
AbstractDeliveryContentResolverService.(constructor)
Initialization
Signature:
protected constructor(aSearch: DeliverySearchResolver, aLogSvc?: LoggerService);
Parameters
Parameter | Type | Description |
---|---|---|
aSearch | DeliverySearchResolver | search service that is uses to back the content service |
aLogSvc | LoggerService | logger service |
Home > @acoustic-content-sdk/component-rest > AbstractDeliveryContentResolverService > getDeliveryContentItem
AbstractDeliveryContentResolverService.getDeliveryContentItem property
Signature:
getDeliveryContentItem: (aID: string) => Observable<DeliveryContentItem>;
Home > @acoustic-content-sdk/component-rest > AbstractDeliveryLayoutMappingResolverService > (constructor)
AbstractDeliveryLayoutMappingResolverService.(constructor)
Initialization
Signature:
protected constructor(aSearch: DeliverySearchResolver, aLogSvc?: LoggerService);
Parameters
Parameter | Type | Description |
---|---|---|
aSearch | DeliverySearchResolver | search service that is uses to back the content service |
aLogSvc | LoggerService | logger service |
Home > @acoustic-content-sdk/component-rest > AbstractDeliveryLayoutMappingResolverService > getDeliveryLayoutMapping
AbstractDeliveryLayoutMappingResolverService.getDeliveryLayoutMapping property
Signature:
getDeliveryLayoutMapping: (aTypeId: string) => Observable<DeliveryLayoutMapping>;
Home > @acoustic-content-sdk/component-rest > AbstractDeliveryLayoutResolverService > (constructor)
AbstractDeliveryLayoutResolverService.(constructor)
Initialization
Signature:
protected constructor(aSearch: DeliverySearchResolver, aLogSvc?: LoggerService);
Parameters
Parameter | Type | Description |
---|---|---|
aSearch | DeliverySearchResolver | search service that is uses to back the content service |
aLogSvc | LoggerService | logger service |
Home > @acoustic-content-sdk/component-rest > AbstractDeliveryLayoutResolverService > getDeliveryLayout
AbstractDeliveryLayoutResolverService.getDeliveryLayout property
Signature:
getDeliveryLayout: (aID: string) => Observable<DeliveryLayout>;
Home > @acoustic-content-sdk/component-rest > AbstractDeliveryPageResolverService > (constructor)
AbstractDeliveryPageResolverService.(constructor)
Initialization
Signature:
protected constructor(aSearch: DeliverySearchResolver, aLogSvc?: LoggerService);
Parameters
Parameter | Type | Description |
---|---|---|
aSearch | DeliverySearchResolver | search service that is uses to back the content service |
aLogSvc | LoggerService | logger service |
Home > @acoustic-content-sdk/component-rest > AbstractDeliveryPageResolverService > getDeliveryPage
AbstractDeliveryPageResolverService.getDeliveryPage property
Signature:
getDeliveryPage: (aPath: string) => Observable<DeliveryContentItem>;
Home > @acoustic-content-sdk/component-rest > AbstractDeliveryTypeResolverService > (constructor)
AbstractDeliveryTypeResolverService.(constructor)
Initialization
Signature:
protected constructor(aSearch: DeliverySearchResolver, aLogSvc?: LoggerService);
Parameters
Parameter | Type | Description |
---|---|---|
aSearch | DeliverySearchResolver | search service that is uses to back the content service |
aLogSvc | LoggerService | logger service |
Home > @acoustic-content-sdk/component-rest > AbstractDeliveryTypeResolverService > getDeliveryType
AbstractDeliveryTypeResolverService.getDeliveryType property
Signature:
getDeliveryType: (aId: string) => Observable<DeliveryType>;
Home > @acoustic-content-sdk/component-rest > AbstractSiteResolverService > (constructor)
AbstractSiteResolverService.(constructor)
Constructs a new instance of the AbstractSiteResolverService
class
Signature:
protected constructor(aFetchText: FetchText, aProtected: ProtectedContent, aLogSvc?: LoggerService);
Parameters
Parameter | Type | Description |
---|---|---|
aFetchText | FetchText | |
aProtected | ProtectedContent | |
aLogSvc | LoggerService |
Home > @acoustic-content-sdk/component-rest > AbstractSiteResolverService > getSiteDeliveryContentItem
AbstractSiteResolverService.getSiteDeliveryContentItem property
Signature:
getSiteDeliveryContentItem: () => Observable<SiteDeliveryContentItem>;