Interface UmbClassInterface

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

Hierarchy (View Summary, Expand)

UmbControllerHost
- UmbClassInterface
  - UmbClassMixinInterface
  - UmbElement

Index

Methods

addUmbController consumeContext getContext getHostElement getUmbControllers hasUmbController observe provideContext removeUmbController removeUmbControllerByAlias

Methods

addUmbController

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

consumeContext

consumeContext<BaseType = unknown, ResultType = BaseType>(
alias: string | UmbContextToken<BaseType, ResultType>,
callback: UmbContextCallback<ResultType>,
): 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:54

getContext

getContext<BaseType = unknown, ResultType = BaseType>(
alias: string | UmbContextToken<BaseType, ResultType>,
): 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:65

getHostElement

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

getUmbControllers

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

hasUmbController

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

observe

observe<
    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>,
>(
    source: ObservableType,
    callback?: ObserverCallback<SpecificT>,
    controllerAlias?: null | UmbControllerAlias,
): 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.
- Optionalcallback: ObserverCallback<SpecificT>
  Callback method called when data is changed.
- OptionalcontrollerAlias: null | UmbControllerAlias
  Define an explicit controller alias. If not defined then one will be generated based on the callback function. If null is parsed no controller alias will be given.
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:20

provideContext

provideContext<R = unknown>(
alias: string | UmbContextToken<R, R>,
instance: R,
): UmbContextProviderController<R>
Type Parameters
- R = unknown
Parameters
- alias: string | UmbContextToken<R, R>
- instance: R
  The API instance to be exposed.
Returns UmbContextProviderController<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:45

removeUmbController

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

removeUmbControllerByAlias

removeUmbControllerByAlias(unique: UmbControllerAlias): 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 Summary, Expand)

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

Returns UmbController[]

hasUmbController

Parameters

Returns boolean

observe

Type Parameters

Parameters

Returns SpecificR

Description

Memberof

provideContext

Type Parameters

Parameters

Returns UmbContextProviderController<R>

Description

Memberof

removeUmbController

Parameters

Returns void

removeUmbControllerByAlias

Parameters

Returns void

Settings

On This Page