@acoustic-content-sdk/component-edit

Framework independent collection of utilities to implement inline edit.

API Documentation

Home > @acoustic-content-sdk/component-edit

component-edit package

Framework independent collection of utilities to implement inline edit.

Classes

Class	Description
AbstractInlineEditSelectionService
AbstractWchInlineEditService	Implementation of the `WchInlineEditServiceV2 that loads the inline edit library and allows to attach to that library.

Functions

Function	Description
getInlineEditSelection(aDocument, aLogSvc)

Variables

Variable	Description
EMPTY_ACOUSTIC_INLINE_EDIT_SERVICE
VERSION	Version and build number of the package

Home > @acoustic-content-sdk/component-edit > AbstractInlineEditSelectionService

AbstractInlineEditSelectionService class

Signature:

export declare class AbstractInlineEditSelectionService implements Unsubscribable 

Constructors

Constructor	Modifiers	Description
(constructor)(aSelectedClass, aSelectionProvider, aDocument, aLogSvc)		Constructs a new instance of the AbstractInlineEditSelectionService class

Methods

Method	Modifiers	Description
unsubscribe()

Home > @acoustic-content-sdk/component-edit > AbstractWchInlineEditService

AbstractWchInlineEditService class

Implementation of the `WchInlineEditServiceV2 that loads the inline edit library and allows to attach to that library.

Signature:

export declare class AbstractWchInlineEditService implements WchInlineEditServiceV2, Unsubscribable 

Constructors

Constructor	Modifiers	Description
(constructor)(aEventConsumer, aProvider$, aUrlConfig$, aDocument, aLogSvc)		Constructs a new instance of the AbstractWchInlineEditService class

Properties

Property	Modifiers	Type	Description
done$		Subject<any>
fromEvent		<T>(aName: string) => Observable<T>
registerComponent		(nativeElement: any, accessor: AccessorType, renderingContext$: Observable<RenderingContextV2>) => Observable<EventTargetLike>

Methods

Method	Modifiers	Description
unsubscribe()

Home > @acoustic-content-sdk/component-edit > getInlineEditSelection

getInlineEditSelection() function

Signature:

export declare function getInlineEditSelection(aDocument: Document, aLogSvc?: LoggerService): Observable<string>;

Parameters

Parameter	Type	Description
aDocument	Document
aLogSvc	LoggerService

Returns:

Observable<string>

Home > @acoustic-content-sdk/component-edit > EMPTY_ACOUSTIC_INLINE_EDIT_SERVICE

EMPTY_ACOUSTIC_INLINE_EDIT_SERVICE variable

Signature:

EMPTY_ACOUSTIC_INLINE_EDIT_SERVICE: WchInlineEditServiceV2

Home > @acoustic-content-sdk/component-edit > 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-edit > AbstractInlineEditSelectionService > (constructor)

AbstractInlineEditSelectionService.(constructor)

Constructs a new instance of the AbstractInlineEditSelectionService class

Signature:

constructor(aSelectedClass: string, aSelectionProvider: InlineEditSelectionProvider, aDocument?: any, aLogSvc?: LoggerService);

Parameters

Parameter	Type	Description
aSelectedClass	string
aSelectionProvider	InlineEditSelectionProvider
aDocument	any
aLogSvc	LoggerService

Home > @acoustic-content-sdk/component-edit > AbstractInlineEditSelectionService > unsubscribe

AbstractInlineEditSelectionService.unsubscribe() method

Signature:

unsubscribe(): void;

Returns:

void

Home > @acoustic-content-sdk/component-edit > AbstractWchInlineEditService > (constructor)

AbstractWchInlineEditService.(constructor)

Constructs a new instance of the AbstractWchInlineEditService class

Signature:

protected constructor(aEventConsumer: Consumer<WchInlineEditEvent>, aProvider$: Observable<WchInlineEditProviderV2>, aUrlConfig$: Observable<UrlConfig>, aDocument?: any, aLogSvc?: LoggerService);

Parameters

Parameter	Type	Description
aEventConsumer	Consumer<WchInlineEditEvent>
aProvider$	Observable<WchInlineEditProviderV2>
aUrlConfig$	Observable<UrlConfig>
aDocument	any
aLogSvc	LoggerService

Home > @acoustic-content-sdk/component-edit > AbstractWchInlineEditService > done$

AbstractWchInlineEditService.done$ property

Signature:

protected readonly done$: Subject<any>;

Home > @acoustic-content-sdk/component-edit > AbstractWchInlineEditService > fromEvent

AbstractWchInlineEditService.fromEvent property

Signature:

fromEvent: <T>(aName: string) => Observable<T>;

Home > @acoustic-content-sdk/component-edit > AbstractWchInlineEditService > registerComponent

AbstractWchInlineEditService.registerComponent property

Signature:

registerComponent: (nativeElement: any, accessor: AccessorType, renderingContext$: Observable<RenderingContextV2>) => Observable<EventTargetLike>;

Home > @acoustic-content-sdk/component-edit > AbstractWchInlineEditService > unsubscribe

AbstractWchInlineEditService.unsubscribe() method

Signature:

unsubscribe(): void;

Returns:

void