Table of Contents

• API Documentation

Home > @acoustic-content-sdk/ng

ng package

Services and components for Angular based Acoustic Content SPAs.

Classes

| Class | Description | | --- | --- | | AcNgComponentsModule | | | AcNgLoggerModule | Modules that exposes the ACOUSTIC_TOKEN_LOGGER_SERVICE token | | AcNgProtectedContentModule | | | AcNgRouterModule | | | AcNgSearchModule | | | AcNgServicesModule | | | PageComponent | The page component monitors | | WchSelectFirstRootPageGuard | |

Functions

| Function | Description | | --- | --- | | LayoutComponent(aDirective) | Layout decorator and metadata. | | LayoutMapping(aID, aSelector, aLayoutMode) | Layout mapping decorator and metadata |

Interfaces

| Interface | Description | | --- | --- | | LayoutComponentDirective | Type of the Layout metadata. | | LayoutMappingDirective | Type of the LayoutMapping metadata. |

Variables

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

Type Aliases

| Type Alias | Description | | --- | --- | | RenderingContextDirective | Converts a rendering context to something else |

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

AcNgComponentsModule class

Signature:

export declare class AcNgComponentsModule 

Properties

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

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

AcNgLoggerModule class

Modules that exposes the ACOUSTIC_TOKEN_LOGGER_SERVICE token

Signature:

export declare class AcNgLoggerModule 

Properties

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

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

AcNgProtectedContentModule class

Signature:

export declare class AcNgProtectedContentModule 

Properties

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

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

AcNgRouterModule class

Signature:

export declare class AcNgRouterModule 

Properties

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

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

AcNgSearchModule class

Signature:

export declare class AcNgSearchModule 

Properties

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

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

AcNgServicesModule class

Signature:

export declare class AcNgServicesModule 

Properties

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

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

PageComponent class

The page component monitors

Signature:

export declare class PageComponent extends AbstractBaseComponent implements OnDestroy, RenderingContextProviderV2 

Constructors

| Constructor | Modifiers | Description | | --- | --- | --- | | (constructor)(aZoneService, aRoute, aPageService, aActivePage, aTitleService, aMetaService, aProvider, aLogSvc) | | Constructs a new instance of the PageComponent class |

Properties

| Property | Modifiers | Type | Description | | --- | --- | --- | --- | | component$ | | ReplaySubject<any> | Event that propagates the newly created component | | layoutMode$ | | Observable<string> | Fires whenever the layout mode changed, includes the initial default mode. | | renderingContext$ | | Observable<RenderingContextV2> | The rendering context for the page. This is the context of the element that is referenced by the currently active route. | | state$ | | Observable<ComponentState> | The component state |

Methods

| Method | Modifiers | Description | | --- | --- | --- | | ngOnDestroy() | | just dispatch, otherwise the method will not be recognized |

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

WchSelectFirstRootPageGuard class

Signature:

export declare class WchSelectFirstRootPageGuard implements CanActivate 

Constructors

| Constructor | Modifiers | Description | | --- | --- | --- | | (constructor)(aDeliveryPageResolver, aRouter, aLogSvc) | | Constructs a new instance of the WchSelectFirstRootPageGuard class |

Methods

| Method | Modifiers | Description | | --- | --- | --- | | canActivate(route, state) | | |

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

LayoutComponent() function

Layout decorator and metadata.

Signature:

export declare function LayoutComponent<T extends Type<any>>(aDirective?: LayoutComponentDirective): (cls: T) => void;

Parameters

| Parameter | Type | Description | | --- | --- | --- | | aDirective | LayoutComponentDirective | |

Returns:

(cls: T) => void

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

LayoutMapping() function

Layout mapping decorator and metadata

Signature:

export declare function LayoutMapping<T extends Type<any>>(aID: string | string[] | LayoutMappingDirective, aSelector?: string | string[] | Type<any>, aLayoutMode?: string | string[]): (cls: T) => void;

Parameters

| Parameter | Type | Description | | --- | --- | --- | | aID | string | string[] | LayoutMappingDirective | | | aSelector | string | string[] | Type<any> | | | aLayoutMode | string | string[] | |

Returns:

(cls: T) => void

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

LayoutComponentDirective interface

Type of the Layout metadata.

Signature:

export interface LayoutComponentDirective 

Properties

| Property | Type | Description | | --- | --- | --- | | componentFactoryResolver | ComponentFactoryResolver | The optional component factory resolver used to instantiate the component | | layoutMode | string | string[] | An optional layout mode used with a default layout mapping. | | mappingId | string | string[] | ID of the content item, content type or the content type name used for a default layout mapping. If the ID is not given, this layout will not be mapped by default. | | selector | string | string[] | Defines the mapping between the layout controller to the layout implementation. If this property is missing, the selector of the component will be used instead. |

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

LayoutMappingDirective interface

Type of the LayoutMapping metadata.

Signature:

export interface LayoutMappingDirective 

Properties

| Property | Type | Description | | --- | --- | --- | | id | string | string[] | Type IDs or content IDs to map this to | | kind | CONTENT_ITEM_KIND | CONTENT_ITEM_KIND[] | Type IDs to map this to | | layoutMode | string | string[] | An optional layout mode used with this layout mapping. | | selector | string | string[] | Defines the mapping between the layout controller to the layout implementation. If this property is missing, the selector of the component will be used instead. |

Home > @acoustic-content-sdk/ng > 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 > RenderingContextDirective

RenderingContextDirective type

Converts a rendering context to something else

Signature:

export declare type RenderingContextDirective<T> = (ctx: RenderingContextV2) => T;

Home > @acoustic-content-sdk/ng > AcNgLoggerModule > VERSION

AcNgLoggerModule.VERSION property

Exposes the version information of this module

Signature:

VERSION: WchSdkVersion;

Home > @acoustic-content-sdk/ng > AcNgComponentsModule > VERSION

AcNgComponentsModule.VERSION property

Exposes the version information of this module

Signature:

VERSION: WchSdkVersion;

Home > @acoustic-content-sdk/ng > AcNgProtectedContentModule > VERSION

AcNgProtectedContentModule.VERSION property

Exposes the version information of this module

Signature:

VERSION: WchSdkVersion;

Home > @acoustic-content-sdk/ng > AcNgRouterModule > VERSION

AcNgRouterModule.VERSION property

Exposes the version information of this module

Signature:

VERSION: WchSdkVersion;

Home > @acoustic-content-sdk/ng > AcNgServicesModule > VERSION

AcNgServicesModule.VERSION property

Exposes the version information of this module

Signature:

VERSION: WchSdkVersion;

Home > @acoustic-content-sdk/ng > AcNgSearchModule > VERSION

AcNgSearchModule.VERSION property

Exposes the version information of this module

Signature:

VERSION: WchSdkVersion;

Home > @acoustic-content-sdk/ng > PageComponent > (constructor)

PageComponent.(constructor)

Constructs a new instance of the PageComponent class

Signature:

constructor(aZoneService: ZoneService, aRoute: ActivatedRoute, aPageService: AcNgPageService, aActivePage: Subject<RenderingContextV2>, aTitleService: Title, aMetaService: Meta, aProvider: RenderingContextProviderV2, aLogSvc: LoggerService);

Parameters

| Parameter | Type | Description | | --- | --- | --- | | aZoneService | ZoneService | | | aRoute | ActivatedRoute | | | aPageService | AcNgPageService | | | aActivePage | Subject<RenderingContextV2> | | | aTitleService | Title | | | aMetaService | Meta | | | aProvider | RenderingContextProviderV2 | | | aLogSvc | LoggerService | |

Home > @acoustic-content-sdk/ng > PageComponent > component$

PageComponent.component$ property

Event that propagates the newly created component

Signature:

readonly component$: ReplaySubject<any>;

Home > @acoustic-content-sdk/ng > PageComponent > layoutMode$

PageComponent.layoutMode$ property

Fires whenever the layout mode changed, includes the initial default mode.

Signature:

readonly layoutMode$: Observable<string>;

Home > @acoustic-content-sdk/ng > PageComponent > renderingContext$

PageComponent.renderingContext$ property

The rendering context for the page. This is the context of the element that is referenced by the currently active route.

Signature:

readonly renderingContext$: Observable<RenderingContextV2>;

Home > @acoustic-content-sdk/ng > PageComponent > state$

PageComponent.state$ property

The component state

Signature:

readonly state$: Observable<ComponentState>;

Home > @acoustic-content-sdk/ng > PageComponent > ngOnDestroy

PageComponent.ngOnDestroy() method

just dispatch, otherwise the method will not be recognized

Signature:

ngOnDestroy(): void;

Returns:

void

Home > @acoustic-content-sdk/ng > WchSelectFirstRootPageGuard > (constructor)

WchSelectFirstRootPageGuard.(constructor)

Constructs a new instance of the WchSelectFirstRootPageGuard class

Signature:

constructor(aDeliveryPageResolver: DeliveryPageResolver, aRouter: Router, aLogSvc: LoggerService);

Parameters

| Parameter | Type | Description | | --- | --- | --- | | aDeliveryPageResolver | DeliveryPageResolver | | | aRouter | Router | | | aLogSvc | LoggerService | |

Home > @acoustic-content-sdk/ng > WchSelectFirstRootPageGuard > canActivate

WchSelectFirstRootPageGuard.canActivate() method

Signature:

canActivate(route: ActivatedRouteSnapshot, state: RouterStateSnapshot): Observable<boolean>;

Parameters

| Parameter | Type | Description | | --- | --- | --- | | route | ActivatedRouteSnapshot | | | state | RouterStateSnapshot | |

Returns:

Observable<boolean>

Home > @acoustic-content-sdk/ng > LayoutComponentDirective > componentFactoryResolver

LayoutComponentDirective.componentFactoryResolver property

The optional component factory resolver used to instantiate the component

Signature:

componentFactoryResolver?: ComponentFactoryResolver;

Home > @acoustic-content-sdk/ng > LayoutComponentDirective > layoutMode

LayoutComponentDirective.layoutMode property

An optional layout mode used with a default layout mapping.

Signature:

layoutMode?: string | string[];

Home > @acoustic-content-sdk/ng > LayoutComponentDirective > mappingId

LayoutComponentDirective.mappingId property

ID of the content item, content type or the content type name used for a default layout mapping. If the ID is not given, this layout will not be mapped by default.

Signature:

mappingId?: string | string[];

Home > @acoustic-content-sdk/ng > LayoutComponentDirective > selector

LayoutComponentDirective.selector property

Defines the mapping between the layout controller to the layout implementation. If this property is missing, the selector of the component will be used instead.

Signature:

selector?: string | string[];

Home > @acoustic-content-sdk/ng > LayoutMappingDirective > id

LayoutMappingDirective.id property

Type IDs or content IDs to map this to

Signature:

id?: string | string[];

Home > @acoustic-content-sdk/ng > LayoutMappingDirective > kind

LayoutMappingDirective.kind property

Type IDs to map this to

Signature:

kind?: CONTENT_ITEM_KIND | CONTENT_ITEM_KIND[];

Home > @acoustic-content-sdk/ng > LayoutMappingDirective > layoutMode

LayoutMappingDirective.layoutMode property

An optional layout mode used with this layout mapping.

Signature:

layoutMode?: string | string[];

Home > @acoustic-content-sdk/ng > LayoutMappingDirective > selector

LayoutMappingDirective.selector property

Defines the mapping between the layout controller to the layout implementation. If this property is missing, the selector of the component will be used instead.

Signature:

selector?: string | string[];