Interface UmbClassInterface

interface UmbClassInterface {
    addUmbController(controller: UmbController): void;
    consumeContext<BaseType, ResultType>(alias: string | UmbContextToken<BaseType, ResultType>, callback: UmbContextCallback<ResultType>): UmbContextConsumerController<BaseType, ResultType>;
    getContext<BaseType, ResultType>(alias: string | UmbContextToken<BaseType, ResultType>): Promise<ResultType>;
    getHostElement(): Element;
    getUmbControllers(filterMethod: ((ctrl: UmbController) => boolean)): UmbController[];
    hasUmbController(controller: UmbController): boolean;
    observe<ObservableType, T, SpecificT, SpecificR>(source: ObservableType, callback: ObserverCallback<SpecificT>, controllerAlias?: null | UmbControllerAlias): SpecificR;
    provideContext<R>(alias: string | UmbContextToken<R, R>, instance: R): UmbContextProviderController<R, R, R>;
    removeUmbController(controller: UmbController): void;
    removeUmbControllerByAlias(unique: UmbControllerAlias): void;
}

Hierarchy (view full)

UmbControllerHost
- UmbClassInterface
  - UmbClassMixinInterface
  - UmbElement

Index

Methods

addUmbController consumeContext getContext getHostElement getUmbControllers hasUmbController observe provideContext removeUmbController removeUmbControllerByAlias

Methods

addUmbController

addUmbController(controller): void
Parameters
- controller: UmbController
Returns void
Inherited from UmbControllerHost.addUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:6

consumeContext

consumeContext<BaseType, ResultType>(alias, callback): UmbContextConsumerController<BaseType, ResultType>
Type Parameters
- BaseType = unknown
- ResultType = BaseType
Parameters
- alias: string | UmbContextToken<BaseType, ResultType>
- callback: UmbContextCallback<ResultType>
  Callback method called when context is resolved.
Returns UmbContextConsumerController<BaseType, ResultType>
Reference to the created Context Consumer Controller instance

Description
Setup a subscription for a context. The callback is called when the context is resolved.

Memberof
UmbClassInterface
- Defined in src/libs/class-api/class.interface.ts:53

getContext

getContext<BaseType, ResultType>(alias): Promise<ResultType>
Type Parameters
- BaseType = unknown
- ResultType = BaseType
Parameters
- alias: string | UmbContextToken<BaseType, ResultType>
Returns Promise<ResultType>
A Promise with the reference to the Context Api Instance

Description
Retrieve a context. Notice this is a one time retrieving of a context, meaning if you expect this to be up to date with reality you should instead use the consumeContext method.

Memberof
UmbClassInterface
- Defined in src/libs/class-api/class.interface.ts:64

getHostElement

getHostElement(): Element
Returns Element
Inherited from UmbControllerHost.getHostElement
- Defined in src/libs/controller-api/controller-host.interface.ts:9

getUmbControllers

getUmbControllers(filterMethod): UmbController[]
Parameters
- filterMethod: ((ctrl: UmbController) => boolean)
  - - (ctrl): boolean
    - Parameters
      ctrl: UmbController
      Returns boolean
Returns UmbController[]
Inherited from UmbControllerHost.getUmbControllers
- Defined in src/libs/controller-api/controller-host.interface.ts:5

hasUmbController

hasUmbController(controller): boolean
Parameters
- controller: UmbController
Returns boolean
Inherited from UmbControllerHost.hasUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:4

observe

observe<ObservableType, T, SpecificT, SpecificR>(source, callback, controllerAlias?): SpecificR
Type Parameters
- ObservableType extends undefined | Observable<T>
- T
- SpecificT = ObservableType extends Observable<U>
      ? ObservableType<ObservableType> extends undefined
          ? undefined | U
          : U
      : undefined
- SpecificR = ObservableType extends undefined
  ? undefined | UmbObserverController<SpecificT>
  : UmbObserverController<SpecificT>
Parameters
- source: ObservableType
  An Observable to observe from.
- callback: ObserverCallback<SpecificT>
  Callback method called when data is changed.
- OptionalcontrollerAlias: null | UmbControllerAlias
Returns SpecificR
Reference to the created Observer Controller instance.

Description
Observe an Observable. An Observable is a declared source of data that can be observed. An observables is declared from a UmbState.

Memberof
UmbClassInterface
- Defined in src/libs/class-api/class.interface.ts:19

provideContext

provideContext<R>(alias, instance): UmbContextProviderController<R, R, R>
Type Parameters
- R = unknown
Parameters
- alias: string | UmbContextToken<R, R>
- instance: R
  The API instance to be exposed.
Returns UmbContextProviderController<R, R, R>
Reference to the created Context Provider Controller instance

Description
Provide a context API for this or child elements.

Memberof
UmbClassInterface
- Defined in src/libs/class-api/class.interface.ts:44

removeUmbController

removeUmbController(controller): void
Parameters
- controller: UmbController
Returns void
Inherited from UmbControllerHost.removeUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:8

removeUmbControllerByAlias

removeUmbControllerByAlias(unique): void
Parameters
- unique: UmbControllerAlias
Returns void
Inherited from UmbControllerHost.removeUmbControllerByAlias
- Defined in src/libs/controller-api/controller-host.interface.ts:7

Interface UmbClassInterface

Hierarchy (view full)

Index

Methods

Methods

addUmbController

Parameters

Returns void

consumeContext

Type Parameters

Parameters

Returns UmbContextConsumerController<BaseType, ResultType>

Description

Memberof

getContext

Type Parameters

Parameters

Returns Promise<ResultType>

Description

Memberof

getHostElement

Returns Element

getUmbControllers

Parameters

Parameters

Returns boolean

Returns UmbController[]

hasUmbController

Parameters

Returns boolean

observe

Type Parameters

Parameters

Returns SpecificR

Description

Memberof

provideContext

Type Parameters

Parameters

Returns UmbContextProviderController<R, R, R>

Description

Memberof

removeUmbController

Parameters

Returns void

removeUmbControllerByAlias

Parameters

Returns void

Settings

On This Page