@ibm-wch-sdk/ng-pzn

Module to attach personalization functionality to an WCH based Angular application.

Stats

StarsIssuesVersionUpdatedCreatedSize
@ibm-wch-sdk/ng-pzn
6.0.5242 years ago3 years agoMinified + gzip package size for @ibm-wch-sdk/ng-pzn in KB

Readme

ibm-wch-sdk-ng-pzn

Module to attach personalization functionality to an WCH based Angular application. The library exposes the WchNgPznModul module.

Changes

CHANGELOG

Class documentation

Refer to the documentation.

WchNgPznModule

Concept

The WchNgPznModule module contains everything you need to render personalized content. It does not determine a user context or personalized content. However, it provides the interfaces and abstract classes to integrate with existing solutions.

The idea is the following:

  1. Your client-side analytics service provides contextual data.
  2. Based on that data, your backend abstraction communicates the user profile to your cloud marketing software. The backend abstraction can also receive offers for certain spots on the site, called "interactionpoints".
  3. The interactionpoint component in this module asks the backend abstraction for offers for its "interactionpoint".
  4. The reveiced offers are rendered by the InteractionpointLayoutComponent component.

Prereqs

  • ibm-wch-sdk-ng
  • Angular 4.0 or higher (including Angular 5)
  • An analytics script extending AbstractAnalyticsService
  • A backend abstraction for your marketing software, extending AbstractBackendService

Usage

Install the module

Install the module via

npm install --save ibm-wch-sdk-ng-pzn

Add the module to your root application

@NgModule({
  ...
  imports: [
    ...
    WchNgPznModule
  ],
  ...
})
export class AppModule { }

The module exposes:

  • Components: InteractionpointLayoutComponent
  • Interfaces: PznOffer, PznContext
  • Abstract classes: AbstractAnalyticsService, AbstractBackendService
  • Injection tokens: ANALYTICS_SERVICE_TOKEN, BACKEND_SERVICE_TOKEN.

Integrate your clientside analytics:

Generate an Angular Service

ng generate service your-analytics-service

extend AbstractAnalyticsService and add your analytics logic.

import { PznContext, AbstractAnalyticsService } from 'ibm-wch-sdk-ng-pzn';
...
@Injectable()
export class YourAnalyticsService extends AbstractAnalyticsService {

    constructor(@Inject(Injector) aInjector: Injector) {
        // default
        super();

        /*
        Do some analytics here
        */
        let analyticsResult: Observable<PznContext>;

        // provide the context
        that.onPznContext = analyticsResult;
    }
}

Provide it via the ANALYTICS_SERVICE_TOKEN in your app.module.ts:

...
import { ANALYTICS_SERVICE_TOKEN, WchNgPznModule } from 'ibm-wch-sdk-pzn';
import { YourAnalyticsService } from './services/your.analytics.service';
...
@NgModule({
    imports: [
        ...
        WchNgPznModule
    ],
    ...
    providers: [
      {provide: ANALYTICS_SERVICE_TOKEN, useClass: YourAnalyticsService}
    ],
    ...
})
...

Add your backend abstraction:

Generate an Angular Service

ng generate service your-backend-service

Extend AbstractBackendService

...
import { BehaviourSubject } from 'rxjs/BehaviourSubject';
import { PznContext, PznOffer, ANALYTICS_SERVICE_TOKEN, AbstractBackendService } from 'ibm-wch-sdk-ng-pzn';
...

@Injectable()
export class YourBackendService extends AbstractBackendService {
    constructor(@Inject(Injector) aInjector: Injector) {
        // default
        super();

        // get the analytics service
        const analytics = aInjector.get(ANALYTICS_SERVICE_TOKEN);

        // implement the session observer, e.g. as BehaviourSubject
        const _session = new BehaviourSubject<PznContext>({});
        that.session = _session;

        // subscribe it to analytics
        analytics.onPznContext.subscribe(that.session);


        /*
        Talk to your marketing software
        */


        // Assign getOffers
        that.getOffers = (interactionpointId) => { /* do something with _session to return the offers*/ };
    }
    ...
}

Provide it via the BACKEND_SERVICE_TOKEN in module.ts:

...
import { BACKEND_SERVICE_TOKEN, WchNgPznModule } from 'ibm-wch-sdk-pzn';
import { YourBackendService } from './services/your.backend.service';
...
@NgModule({
    imports: [
        ...
        WchNgPznModule
    ],
    ...
    providers: [
      {provide: BACKEND_SERVICE_TOKEN, useClass: YourBackendService}
    ],
    ...
})
...

Add the content-type

The content-type, layout and layout-mapping for interactionpoint get pushed automatically by executing from your repo's root.

ibm-wch-sdk-cli run:wchtools push -tlm --aggregated

You need to have ibm-wch-sdk-cli installed and ibm-wch-sdk-ng-pzn required in your package.json.

WchNgPznModule classes and interfaces

InteractionpointLayoutComponent component

Implements a Layout for the content-type 'Interactionpoint'. Renders a wch-content-query. As query it loads the onQuery output from TypeInteractionpointComponent asynchronously.

TypeInteractionpointComponent component

Gets the interactionpoint id from the content types field name via the WCH Angular SDK. Calls the backend service's getOffers method with the id. Recieves a PznOffer, generates a query from it and provides it via the onQuery output as Observable of type Query from the WCH Angular SDK.

AbstractAnalyticsService abstract class

Your clientside analytics should provide a service extending this class. The service should expose an Observable onPznContext. The injection token to provide it should be the ANALYTICS_SERVICE_TOKEN from this module.

    onPznContext: Observable<PznContext>;

AbstractBackendService abstract class

Your backend abstraction should provide a service extending this class. The service should expose a function getOffers, an Observer session and an Observer refresh, that triggers a reload of all offers on the page. The injection token to provide it should be the BACKEND_SERVICE_TOKEN from this module.

    session: Observer<PznContext>;

    refresh: Observer<any>;

    getOffers: (id: string) => Observable<PznOffer>;

Interface PznContext

An interface for structuring contextual information

export interface PznContext {
    [key: string]: string;
}

Interface PznOffer

Use this interface to create valid offers

export type PznOffer = {
    'sortOrder': string;
    'display': boolean;
    'rows': string;
    [key: string]: string | boolean;
};

Sample implementation

Demo implementation of AbstractAnalyticsService:

ibm-wch-sdk-ng-demo-analytics on npm

Demo implementation of AbstractBackendService:

ibm-wch-sdk-ng-demo-backend-abstraction on npm

Changelog

Current

Added

  • Initial version

WchNgPznModule

Concept

The WchNgPznModule module contains everything you need to render personalized content. It does not determine a user context or personalized content. However, it provides the interfaces and abstract classes to integrate with existing solutions.

The idea is the following:

  1. Your client-side analytics service provides contextual data.
  2. Based on that data, your backend abstraction communicates the user profile to your cloud marketing software. The backend abstraction can also receive offers for certain spots on the site, called "interactionpoints".
  3. The interactionpoint component in this module asks the backend abstraction for offers for its "interactionpoint".
  4. The reveiced offers are rendered by the InteractionpointLayoutComponent component.

Prereqs

  • ibm-wch-sdk-ng
  • Angular 4.0 or higher (including Angular 5)
  • An analytics script extending AbstractAnalyticsService
  • A backend abstraction for your marketing software, extending AbstractBackendService

Usage

Install the module

Install the module via

npm install --save ibm-wch-sdk-ng-pzn

Add the module to your root application

@NgModule({
  ...
  imports: [
    ...
    WchNgPznModule
  ],
  ...
})
export class AppModule { }

The module exposes:

  • Components: InteractionpointLayoutComponent
  • Interfaces: PznOffer, PznContext
  • Abstract classes: AbstractAnalyticsService, AbstractBackendService
  • Injection tokens: ANALYTICS_SERVICE_TOKEN, BACKEND_SERVICE_TOKEN.

Integrate your clientside analytics:

Generate an Angular Service

ng generate service your-analytics-service

extend AbstractAnalyticsService and add your analytics logic.

import { PznContext, AbstractAnalyticsService } from 'ibm-wch-sdk-ng-pzn';
...
@Injectable()
export class YourAnalyticsService extends AbstractAnalyticsService {

    constructor(@Inject(Injector) aInjector: Injector) {
        // default
        super();

        /*
        Do some analytics here
        */
        let analyticsResult: Observable<PznContext>;

        // provide the context
        that.onPznContext = analyticsResult;
    }
}

Provide it via the ANALYTICS_SERVICE_TOKEN in your app.module.ts:

...
import { ANALYTICS_SERVICE_TOKEN, WchNgPznModule } from 'ibm-wch-sdk-pzn';
import { YourAnalyticsService } from './services/your.analytics.service';
...
@NgModule({
    imports: [
        ...
        WchNgPznModule
    ],
    ...
    providers: [
      {provide: ANALYTICS_SERVICE_TOKEN, useClass: YourAnalyticsService}
    ],
    ...
})
...

Add your backend abstraction:

Generate an Angular Service

ng generate service your-backend-service

Extend AbstractBackendService

...
import { BehaviourSubject } from 'rxjs/BehaviourSubject';
import { PznContext, PznOffer, ANALYTICS_SERVICE_TOKEN, AbstractBackendService } from 'ibm-wch-sdk-ng-pzn';
...

@Injectable()
export class YourBackendService extends AbstractBackendService {
    constructor(@Inject(Injector) aInjector: Injector) {
        // default
        super();

        // get the analytics service
        const analytics = aInjector.get(ANALYTICS_SERVICE_TOKEN);

        // implement the session observer, e.g. as BehaviourSubject
        const _session = new BehaviourSubject<PznContext>({});
        that.session = _session;

        // subscribe it to analytics
        analytics.onPznContext.subscribe(that.session);

        /*
        Talk to your marketing software
        */

        // Assign getOffers
        that.getOffers = (interactionpointId) => { /* do something with _session to return the offers*/ };
    }
    ...
}

Provide it via the BACKEND_SERVICE_TOKEN in module.ts:

...
import { BACKEND_SERVICE_TOKEN, WchNgPznModule } from 'ibm-wch-sdk-pzn';
import { YourBackendService } from './services/your.backend.service';
...
@NgModule({
    imports: [
        ...
        WchNgPznModule
    ],
    ...
    providers: [
      {provide: BACKEND_SERVICE_TOKEN, useClass: YourBackendService}
    ],
    ...
})
...

Add the content-type

The content-type, layout and layout-mapping for interactionpoint get pushed automatically by executing from your repo's root.

ibm-wch-sdk-cli run:wchtools push -tlm --aggregated

You need to have ibm-wch-sdk-cli installed and ibm-wch-sdk-ng-pzn required in your package.json.

WchNgPznModule classes and interfaces

InteractionpointLayoutComponent component

Implements a Layout for the content-type 'Interactionpoint'. Renders a wch-content-query. As query it loads the onQuery output from TypeInteractionpointComponent asynchronously.

TypeInteractionpointComponent component

Gets the interactionpoint id from the content types field name via the WCH Angular SDK. Calls the backend service's getOffers method with the id. Recieves a PznOffer, generates a query from it and provides it via the onQuery output as Observable of type Query from the WCH Angular SDK.

AbstractAnalyticsService abstract class

Your clientside analytics should provide a service extending this class. The service should expose an Observable onPznContext. The injection token to provide it should be the ANALYTICS_SERVICE_TOKEN from this module.

    onPznContext: Observable<PznContext>;

AbstractBackendService abstract class

Your backend abstraction should provide a service extending this class. The service should expose a function getOffers, an Observer session and an Observer refresh, that triggers a reload of all offers on the page. The injection token to provide it should be the BACKEND_SERVICE_TOKEN from this module.

    session: Observer<PznContext>;

    refresh: Observer<any>;

    getOffers: (id: string) => Observable<PznOffer>;

Interface PznContext

An interface for structuring contextual information

export interface PznContext {
    [key: string]: string;
}

Interface PznOffer

Use this interface to create valid offers

export type PznOffer = {
    'sortOrder': string;
    'display': boolean;
    'rows': string;
    [key: string]: string \| boolean;
};

Sample implementation

Demo implementation of AbstractAnalyticsService:

ibm-wch-sdk-ng-demo-analytics on npm

Demo implementation of AbstractBackendService:

ibm-wch-sdk-ng-demo-backend-abstraction on npm

Index

External modules


@ibm-wch-sdk/ng-pzn > "components/interactionpoint/abstractInteractionpointComponent"

External module: "components/interactionpoint/abstractInteractionpointComponent"

Index

Classes


@ibm-wch-sdk/ng-pzn > "components/interactionpoint/typeInteractionpointComponent"

External module: "components/interactionpoint/typeInteractionpointComponent"

Index

Classes

Variables


Variables

<Const> LOGGER

● LOGGER: "TypeInteractionpointComponent" = "TypeInteractionpointComponent"

Defined in components/interactionpoint/typeInteractionpointComponent.ts:14


@ibm-wch-sdk/ng-pzn > "index"

External module: "index"

Index


@ibm-wch-sdk/ng-pzn > "interfaces/pzn.context"

External module: "interfaces/pzn.context"

Index

Interfaces

Type aliases


Type aliases

PznOffer

Ƭ PznOffer: object

Defined in interfaces/pzn.context.ts:7

Type declaration

[key: string]: string | boolean

display: boolean

rows: string

sortOrder: string


@ibm-wch-sdk/ng-pzn > "layouts/interactionpoint/interactionpointLayout"

External module: "layouts/interactionpoint/interactionpointLayout"

Index

Classes


@ibm-wch-sdk/ng-pzn > "module"

External module: "module"

Index

Classes


@ibm-wch-sdk/ng-pzn > "services/pzn/analytics.service"

External module: "services/pzn/analytics.service"

Index

Classes

Variables


Variables

<Const> ANALYTICS_SERVICE_TOKEN

● ANALYTICS_SERVICE_TOKEN: InjectionToken<AbstractAnalyticsService> = new InjectionToken('AnalyticsService')

Defined in services/pzn/analytics.service.ts:8


@ibm-wch-sdk/ng-pzn > "services/pzn/backend.service"

External module: "services/pzn/backend.service"

Index

Classes

Variables


Variables

<Const> BACKEND_SERVICE_TOKEN

● BACKEND_SERVICE_TOKEN: InjectionToken<AbstractBackendService> = new InjectionToken('BackendService')

Defined in services/pzn/backend.service.ts:8


WchNgPznModule

Concept

The WchNgPznModule module contains everything you need to render personalized content. It does not determine a user context or personalized content. However, it provides the interfaces and abstract classes to integrate with existing solutions.

The idea is the following:

  1. Your client-side analytics service provides contextual data.
  2. Based on that data, your backend abstraction communicates the user profile to your cloud marketing software. The backend abstraction can also receive offers for certain spots on the site, called "interactionpoints".
  3. The interactionpoint component in this module asks the backend abstraction for offers for its "interactionpoint".
  4. The reveiced offers are rendered by the InteractionpointLayoutComponent component.

Prereqs

  • ibm-wch-sdk-ng
  • Angular 4.0 or higher (including Angular 5)
  • An analytics script extending AbstractAnalyticsService
  • A backend abstraction for your marketing software, extending AbstractBackendService

Usage

Install the module

Install the module via

npm install --save ibm-wch-sdk-ng-pzn

Add the module to your root application

@NgModule({
  ...
  imports: [
    ...
    WchNgPznModule
  ],
  ...
})
export class AppModule { }

The module exposes:

  • Components: InteractionpointLayoutComponent
  • Interfaces: PznOffer, PznContext
  • Abstract classes: AbstractAnalyticsService, AbstractBackendService
  • Injection tokens: ANALYTICS_SERVICE_TOKEN, BACKEND_SERVICE_TOKEN.

Integrate your clientside analytics:

Generate an Angular Service

ng generate service your-analytics-service

extend AbstractAnalyticsService and add your analytics logic.

import { PznContext, AbstractAnalyticsService } from 'ibm-wch-sdk-ng-pzn';
...
@Injectable()
export class YourAnalyticsService extends AbstractAnalyticsService {

    constructor(@Inject(Injector) aInjector: Injector) {
        // default
        super();

        /*
        Do some analytics here
        */
        let analyticsResult: Observable<PznContext>;

        // provide the context
        that.onPznContext = analyticsResult;
    }
}

Provide it via the ANALYTICS_SERVICE_TOKEN in your app.module.ts:

...
import { ANALYTICS_SERVICE_TOKEN, WchNgPznModule } from 'ibm-wch-sdk-pzn';
import { YourAnalyticsService } from './services/your.analytics.service';
...
@NgModule({
    imports: [
        ...
        WchNgPznModule
    ],
    ...
    providers: [
      {provide: ANALYTICS_SERVICE_TOKEN, useClass: YourAnalyticsService}
    ],
    ...
})
...

Add your backend abstraction:

Generate an Angular Service

ng generate service your-backend-service

Extend AbstractBackendService

...
import { BehaviourSubject } from 'rxjs/BehaviourSubject';
import { PznContext, PznOffer, ANALYTICS_SERVICE_TOKEN, AbstractBackendService } from 'ibm-wch-sdk-ng-pzn';
...

@Injectable()
export class YourBackendService extends AbstractBackendService {
    constructor(@Inject(Injector) aInjector: Injector) {
        // default
        super();

        // get the analytics service
        const analytics = aInjector.get(ANALYTICS_SERVICE_TOKEN);

        // implement the session observer, e.g. as BehaviourSubject
        const _session = new BehaviourSubject<PznContext>({});
        that.session = _session;

        // subscribe it to analytics
        analytics.onPznContext.subscribe(that.session);

        /*
        Talk to your marketing software
        */

        // Assign getOffers
        that.getOffers = (interactionpointId) => { /* do something with _session to return the offers*/ };
    }
    ...
}

Provide it via the BACKEND_SERVICE_TOKEN in module.ts:

...
import { BACKEND_SERVICE_TOKEN, WchNgPznModule } from 'ibm-wch-sdk-pzn';
import { YourBackendService } from './services/your.backend.service';
...
@NgModule({
    imports: [
        ...
        WchNgPznModule
    ],
    ...
    providers: [
      {provide: BACKEND_SERVICE_TOKEN, useClass: YourBackendService}
    ],
    ...
})
...

Add the content-type

The content-type, layout and layout-mapping for interactionpoint get pushed automatically by executing from your repo's root.

ibm-wch-sdk-cli run:wchtools push -tlm --aggregated

You need to have ibm-wch-sdk-cli installed and ibm-wch-sdk-ng-pzn required in your package.json.

WchNgPznModule classes and interfaces

InteractionpointLayoutComponent component

Implements a Layout for the content-type 'Interactionpoint'. Renders a wch-content-query. As query it loads the onQuery output from TypeInteractionpointComponent asynchronously.

TypeInteractionpointComponent component

Gets the interactionpoint id from the content types field name via the WCH Angular SDK. Calls the backend service's getOffers method with the id. Recieves a PznOffer, generates a query from it and provides it via the onQuery output as Observable of type Query from the WCH Angular SDK.

AbstractAnalyticsService abstract class

Your clientside analytics should provide a service extending this class. The service should expose an Observable onPznContext. The injection token to provide it should be the ANALYTICS_SERVICE_TOKEN from this module.

    onPznContext: Observable<PznContext>;

AbstractBackendService abstract class

Your backend abstraction should provide a service extending this class. The service should expose a function getOffers, an Observer session and an Observer refresh, that triggers a reload of all offers on the page. The injection token to provide it should be the BACKEND_SERVICE_TOKEN from this module.

    session: Observer<PznContext>;

    refresh: Observer<any>;

    getOffers: (id: string) => Observable<PznOffer>;

Interface PznContext

An interface for structuring contextual information

export interface PznContext {
    [key: string]: string;
}

Interface PznOffer

Use this interface to create valid offers

export type PznOffer = {
    'sortOrder': string;
    'display': boolean;
    'rows': string;
    [key: string]: string \| boolean;
};

Sample implementation

Demo implementation of AbstractAnalyticsService:

ibm-wch-sdk-ng-demo-analytics on npm

Demo implementation of AbstractBackendService:

ibm-wch-sdk-ng-demo-backend-abstraction on npm

Index

External modules


@ibm-wch-sdk/ng-pzn > "components/interactionpoint/abstractInteractionpointComponent" > AbstractInteractionpointComponent

Class: AbstractInteractionpointComponent

Hierarchy

AbstractRenderingComponent

↳ AbstractInteractionpointComponent

TypeInteractionpointComponent

Implements

  • OnInit
  • OnDestroy
  • OnChanges
  • DoCheck
  • AfterContentInit
  • AfterContentChecked
  • AfterViewInit
  • AfterViewChecked
  • OnDestroy
  • RenderingContextProvider

Index

Constructors

Properties

Methods


Constructors

<Protected> constructor

new AbstractInteractionpointComponent(): AbstractInteractionpointComponent

Overrides AbstractRenderingComponent.__constructor

Defined in components/interactionpoint/abstractInteractionpointComponent.ts:34

Returns: AbstractInteractionpointComponent


Properties

<Protected> _id

● _id: string

Inherited from AbstractRenderingComponent._id

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract-rendering.component.d.ts:7


<Protected> context

● context: Observable<RenderingContext>

Inherited from AbstractRenderingComponent.context

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract-rendering.component.d.ts:19


layoutMode

● layoutMode: string

Inherited from AbstractRenderingComponent.layoutMode

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract-rendering.component.d.ts:17

The current layout mode for convenience


name

● name: string

Defined in components/interactionpoint/abstractInteractionpointComponent.ts:34


<Protected> onAfterContentChecked

● onAfterContentChecked: Observable<void>

Inherited from AbstractLifeCycleComponent.onAfterContentChecked

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:75

see: AfterContentChecked

returns: the observable representation of this callback


<Protected> onAfterContentInit

● onAfterContentInit: Observable<void>

Inherited from AbstractLifeCycleComponent.onAfterContentInit

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:80

see: AfterContentInit

returns: the observable representation of this callback


<Protected> onAfterViewChecked

● onAfterViewChecked: Observable<void>

Inherited from AbstractLifeCycleComponent.onAfterViewChecked

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:65

see: AfterViewChecked

returns: the observable representation of this callback


<Protected> onAfterViewInit

● onAfterViewInit: Observable<void>

Inherited from AbstractLifeCycleComponent.onAfterViewInit

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:70

see: AfterViewInit

returns: the observable representation of this callback


<Protected> onDoCheck

● onDoCheck: Observable<void>

Inherited from AbstractLifeCycleComponent.onDoCheck

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:85

see: DoCheck

returns: the observable representation of this callback


onLayoutMode

● onLayoutMode: Observable<string>

Inherited from AbstractRenderingComponent.onLayoutMode

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract-rendering.component.d.ts:9


onName

● onName: Observable<string>

Defined in components/interactionpoint/abstractInteractionpointComponent.ts:28


<Protected> onOnChanges

● onOnChanges: Observable<SimpleChanges>

Inherited from AbstractLifeCycleComponent.onOnChanges

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:90

see: OnChanges

returns: the observable representation of this callback


<Protected> onOnDestroy

● onOnDestroy: Observable<void>

Inherited from AbstractLifeCycleComponent.onOnDestroy

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:100

see: OnDestroy

returns: the observable representation of this callback


<Protected> onOnInit

● onOnInit: Observable<void>

Inherited from AbstractLifeCycleComponent.onOnInit

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:95

see: OnInit

returns: the observable representation of this callback


onRenderingContext

● onRenderingContext: Observable<RenderingContext>

Inherited from AbstractRenderingComponent.onRenderingContext

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract-rendering.component.d.ts:8


renderingContext

● renderingContext: RenderingContext

Inherited from AbstractRenderingComponent.renderingContext

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract-rendering.component.d.ts:13

The current rendering context for convenience


Methods

<Protected> describeSetter

describeSetter<T>(aSubject: Subject<T>): PropertyDescriptor

Inherited from AbstractLifeCycleComponent.describeSetter

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:121

Returns a property descriptor for a setter that dispatches to the given subject. The subject will automatically be completed and unsubscribed on the onDestroy method. The resulting descriptor may be used to define input properties in the closure of the constructor of a component.

deprecated: use createSetter instead

Type parameters:

T

Parameters:

Name Type Description
aSubject Subject<T> the subject

Returns: PropertyDescriptor the property descriptor


ngAfterContentChecked

ngAfterContentChecked(): void

Inherited from AbstractLifeCycleComponent.ngAfterContentChecked

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:35

see: AfterContentChecked

override:

Returns: void


ngAfterContentInit

ngAfterContentInit(): void

Inherited from AbstractLifeCycleComponent.ngAfterContentInit

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:40

see: AfterContentInit

override:

Returns: void


ngAfterViewChecked

ngAfterViewChecked(): void

Inherited from AbstractLifeCycleComponent.ngAfterViewChecked

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:25

see: AfterViewChecked

override:

Returns: void


ngAfterViewInit

ngAfterViewInit(): void

Inherited from AbstractLifeCycleComponent.ngAfterViewInit

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:30

see: AfterViewInit

override:

Returns: void


ngDoCheck

ngDoCheck(): void

Inherited from AbstractLifeCycleComponent.ngDoCheck

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:45

see: DoCheck

override:

Returns: void


ngOnChanges

ngOnChanges(changes: SimpleChanges): void

Inherited from AbstractLifeCycleComponent.ngOnChanges

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:50

see: OnChanges

override:

Parameters:

Name Type
changes SimpleChanges

Returns: void


ngOnDestroy

ngOnDestroy(): void

Inherited from AbstractRenderingComponent.ngOnDestroy

Overrides AbstractLifeCycleComponent.ngOnDestroy

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract-rendering.component.d.ts:21

Returns: void


ngOnInit

ngOnInit(): void

Inherited from AbstractLifeCycleComponent.ngOnInit

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:55

see: OnInit

override:

Returns: void


safeSubscribe

safeSubscribe<T>(aObservable: Subscribable<T>, aObserver?: PartialObserver<T> | function | string, error?: function, complete?: function): void

Inherited from AbstractLifeCycleComponent.safeSubscribe

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:134

Subscribes to an observable and makes sure to clean the subscription in ngOnDestroy to avoid memory leaks.

deprecated: use takeUntil(onOnDestroy) instead

Type parameters:

T

Parameters:

Name Type Description
aObservable Subscribable<T> the observable to subscribe to
Optional aObserver PartialObserver<T> | function | string the handler. If this value is a 'string', then the subscription will automatically update the respective property on the instance.
Optional error function optional error handler
Optional complete function optional completion handler

Returns: void


trackByComponentId

trackByComponentId(aIndex: number, aRenderingContext: RenderingContext): string

Inherited from AbstractRenderingComponent.trackByComponentId

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract-rendering.component.d.ts:20

Parameters:

Name Type
aIndex number
aRenderingContext RenderingContext

Returns: string


<Protected> unsubscribeOnDestroy

unsubscribeOnDestroy(aSubscription: Subscription): void

Inherited from AbstractLifeCycleComponent.unsubscribeOnDestroy

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:109

Unsubscribes the given subscription in the ngOnDestroy method. This method exists for convenience only, consider to use the {@link #safeSubscribe} method instead.

deprecated: use takeUntil(onOnDestroy) instead

Parameters:

Name Type Description
aSubscription Subscription the subscription to unsubscribe on

Returns: void


@ibm-wch-sdk/ng-pzn > "components/interactionpoint/typeInteractionpointComponent" > TypeInteractionpointComponent

Class: TypeInteractionpointComponent

Hierarchy

AbstractInteractionpointComponent

↳ TypeInteractionpointComponent

InteractionpointLayoutComponent

Implements

  • OnInit
  • OnDestroy
  • OnChanges
  • DoCheck
  • AfterContentInit
  • AfterContentChecked
  • AfterViewInit
  • AfterViewChecked
  • OnDestroy
  • RenderingContextProvider

Index

Constructors

Properties

Methods


Constructors

constructor

new TypeInteractionpointComponent(aInjector: Injector): TypeInteractionpointComponent

Overrides AbstractInteractionpointComponent.constructor

Defined in components/interactionpoint/typeInteractionpointComponent.ts:34

Parameters:

Name Type
aInjector Injector

Returns: TypeInteractionpointComponent


Properties

<Protected> _id

● _id: string

Inherited from AbstractRenderingComponent._id

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract-rendering.component.d.ts:7


<Protected> context

● context: Observable<RenderingContext>

Inherited from AbstractRenderingComponent.context

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract-rendering.component.d.ts:19


layoutMode

● layoutMode: string

Inherited from AbstractRenderingComponent.layoutMode

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract-rendering.component.d.ts:17

The current layout mode for convenience


name

● name: string

Inherited from AbstractInteractionpointComponent.name

Defined in components/interactionpoint/abstractInteractionpointComponent.ts:34


<Protected> onAfterContentChecked

● onAfterContentChecked: Observable<void>

Inherited from AbstractLifeCycleComponent.onAfterContentChecked

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:75

see: AfterContentChecked

returns: the observable representation of this callback


<Protected> onAfterContentInit

● onAfterContentInit: Observable<void>

Inherited from AbstractLifeCycleComponent.onAfterContentInit

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:80

see: AfterContentInit

returns: the observable representation of this callback


<Protected> onAfterViewChecked

● onAfterViewChecked: Observable<void>

Inherited from AbstractLifeCycleComponent.onAfterViewChecked

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:65

see: AfterViewChecked

returns: the observable representation of this callback


<Protected> onAfterViewInit

● onAfterViewInit: Observable<void>

Inherited from AbstractLifeCycleComponent.onAfterViewInit

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:70

see: AfterViewInit

returns: the observable representation of this callback


onDisplay

● onDisplay: Observable<boolean>

Defined in components/interactionpoint/typeInteractionpointComponent.ts:34


<Protected> onDoCheck

● onDoCheck: Observable<void>

Inherited from AbstractLifeCycleComponent.onDoCheck

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:85

see: DoCheck

returns: the observable representation of this callback


onLayoutMode

● onLayoutMode: Observable<string>

Inherited from AbstractRenderingComponent.onLayoutMode

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract-rendering.component.d.ts:9


onName

● onName: Observable<string>

Inherited from AbstractInteractionpointComponent.onName

Defined in components/interactionpoint/abstractInteractionpointComponent.ts:28


<Protected> onOnChanges

● onOnChanges: Observable<SimpleChanges>

Inherited from AbstractLifeCycleComponent.onOnChanges

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:90

see: OnChanges

returns: the observable representation of this callback


<Protected> onOnDestroy

● onOnDestroy: Observable<void>

Inherited from AbstractLifeCycleComponent.onOnDestroy

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:100

see: OnDestroy

returns: the observable representation of this callback


<Protected> onOnInit

● onOnInit: Observable<void>

Inherited from AbstractLifeCycleComponent.onOnInit

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:95

see: OnInit

returns: the observable representation of this callback


onQuery

● onQuery: Observable<Query>

Defined in components/interactionpoint/typeInteractionpointComponent.ts:31


onRenderingContext

● onRenderingContext: Observable<RenderingContext>

Inherited from AbstractRenderingComponent.onRenderingContext

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract-rendering.component.d.ts:8


renderingContext

● renderingContext: RenderingContext

Inherited from AbstractRenderingComponent.renderingContext

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract-rendering.component.d.ts:13

The current rendering context for convenience


Methods

<Protected> describeSetter

describeSetter<T>(aSubject: Subject<T>): PropertyDescriptor

Inherited from AbstractLifeCycleComponent.describeSetter

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:121

Returns a property descriptor for a setter that dispatches to the given subject. The subject will automatically be completed and unsubscribed on the onDestroy method. The resulting descriptor may be used to define input properties in the closure of the constructor of a component.

deprecated: use createSetter instead

Type parameters:

T

Parameters:

Name Type Description
aSubject Subject<T> the subject

Returns: PropertyDescriptor the property descriptor


ngAfterContentChecked

ngAfterContentChecked(): void

Inherited from AbstractLifeCycleComponent.ngAfterContentChecked

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:35

see: AfterContentChecked

override:

Returns: void


ngAfterContentInit

ngAfterContentInit(): void

Inherited from AbstractLifeCycleComponent.ngAfterContentInit

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:40

see: AfterContentInit

override:

Returns: void


ngAfterViewChecked

ngAfterViewChecked(): void

Inherited from AbstractLifeCycleComponent.ngAfterViewChecked

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:25

see: AfterViewChecked

override:

Returns: void


ngAfterViewInit

ngAfterViewInit(): void

Inherited from AbstractLifeCycleComponent.ngAfterViewInit

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:30

see: AfterViewInit

override:

Returns: void


ngDoCheck

ngDoCheck(): void

Inherited from AbstractLifeCycleComponent.ngDoCheck

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:45

see: DoCheck

override:

Returns: void


ngOnChanges

ngOnChanges(changes: SimpleChanges): void

Inherited from AbstractLifeCycleComponent.ngOnChanges

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:50

see: OnChanges

override:

Parameters:

Name Type
changes SimpleChanges

Returns: void


ngOnDestroy

ngOnDestroy(): void

Inherited from AbstractRenderingComponent.ngOnDestroy

Overrides AbstractLifeCycleComponent.ngOnDestroy

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract-rendering.component.d.ts:21

Returns: void


ngOnInit

ngOnInit(): void

Inherited from AbstractLifeCycleComponent.ngOnInit

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:55

see: OnInit

override:

Returns: void


safeSubscribe

safeSubscribe<T>(aObservable: Subscribable<T>, aObserver?: PartialObserver<T> | function | string, error?: function, complete?: function): void

Inherited from AbstractLifeCycleComponent.safeSubscribe

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:134

Subscribes to an observable and makes sure to clean the subscription in ngOnDestroy to avoid memory leaks.

deprecated: use takeUntil(onOnDestroy) instead

Type parameters:

T

Parameters:

Name Type Description
aObservable Subscribable<T> the observable to subscribe to
Optional aObserver PartialObserver<T> | function | string the handler. If this value is a 'string', then the subscription will automatically update the respective property on the instance.
Optional error function optional error handler
Optional complete function optional completion handler

Returns: void


trackByComponentId

trackByComponentId(aIndex: number, aRenderingContext: RenderingContext): string

Inherited from AbstractRenderingComponent.trackByComponentId

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract-rendering.component.d.ts:20

Parameters:

Name Type
aIndex number
aRenderingContext RenderingContext

Returns: string


<Protected> unsubscribeOnDestroy

unsubscribeOnDestroy(aSubscription: Subscription): void

Inherited from AbstractLifeCycleComponent.unsubscribeOnDestroy

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:109

Unsubscribes the given subscription in the ngOnDestroy method. This method exists for convenience only, consider to use the {@link #safeSubscribe} method instead.

deprecated: use takeUntil(onOnDestroy) instead

Parameters:

Name Type Description
aSubscription Subscription the subscription to unsubscribe on

Returns: void


@ibm-wch-sdk/ng-pzn > "interfaces/pzn.context" > PznContext

Interface: PznContext

Hierarchy

PznContext

Indexable

[key: string]: string

Index


@ibm-wch-sdk/ng-pzn > "layouts/interactionpoint/interactionpointLayout" > InteractionpointLayoutComponent

Class: InteractionpointLayoutComponent

Hierarchy

TypeInteractionpointComponent

↳ InteractionpointLayoutComponent

Implements

  • OnInit
  • OnDestroy
  • OnChanges
  • DoCheck
  • AfterContentInit
  • AfterContentChecked
  • AfterViewInit
  • AfterViewChecked
  • OnDestroy
  • RenderingContextProvider

Index

Constructors

Properties

Methods


Constructors

constructor

new InteractionpointLayoutComponent(aInjector: Injector): InteractionpointLayoutComponent

Overrides TypeInteractionpointComponent.constructor

Defined in layouts/interactionpoint/interactionpointLayout.ts:21

Parameters:

Name Type
aInjector Injector

Returns: InteractionpointLayoutComponent


Properties

<Protected> _id

● _id: string

Inherited from AbstractRenderingComponent._id

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract-rendering.component.d.ts:7


<Protected> context

● context: Observable<RenderingContext>

Inherited from AbstractRenderingComponent.context

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract-rendering.component.d.ts:19


layoutMode

● layoutMode: string

Inherited from AbstractRenderingComponent.layoutMode

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract-rendering.component.d.ts:17

The current layout mode for convenience


name

● name: string

Inherited from AbstractInteractionpointComponent.name

Defined in components/interactionpoint/abstractInteractionpointComponent.ts:34


<Protected> onAfterContentChecked

● onAfterContentChecked: Observable<void>

Inherited from AbstractLifeCycleComponent.onAfterContentChecked

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:75

see: AfterContentChecked

returns: the observable representation of this callback


<Protected> onAfterContentInit

● onAfterContentInit: Observable<void>

Inherited from AbstractLifeCycleComponent.onAfterContentInit

Defined in /usr/build/node_modules/@ibm-wch-sdk/ng/src/components/rendering/abstract.lifecycle.component.d.ts:80

see: Aft

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.