Class UmbContextConsumerController<BaseType, ResultType>

UmbContextConsumer

Type Parameters

BaseType = unknown
ResultType extends BaseType = BaseType

Hierarchy (view full)

UmbContextConsumer<BaseType, ResultType>
- UmbContextConsumerController

Implements

UmbController

Index

Constructors

constructor

new UmbContextConsumerController<BaseType, ResultType>(host, contextAlias, callback?): UmbContextConsumerController<BaseType, ResultType>
Type Parameters
- BaseType = unknown
- ResultType = BaseType
Parameters
- host: UmbControllerHost
- contextAlias: string | UmbContextToken<BaseType, ResultType>
- Optionalcallback: UmbContextCallback<ResultType>
Returns UmbContextConsumerController<BaseType, ResultType>
Overrides UmbContextConsumer.constructor
- Defined in src/libs/context-api/consume/context-consumer.controller.ts:17

Properties

`Protected`_retrieveHost

_retrieveHost: HostElementMethod

Accessors

controllerAlias

get controllerAlias(): symbol
Returns symbol
Implementation of UmbController.controllerAlias
- Defined in src/libs/context-api/consume/context-consumer.controller.ts:13

instance

get instance(): undefined | ResultType
Returns undefined | ResultType
Inherited from UmbContextConsumer.instance
- Defined in src/libs/context-api/consume/context-consumer.ts:21

Methods

`Protected`_onResponse

_onResponse(instance): boolean
Parameters
- instance: BaseType
Returns boolean
Inherited from UmbContextConsumer._onResponse
- Defined in src/libs/context-api/consume/context-consumer.ts:77

asPromise

asPromise(): Promise<ResultType>
Returns Promise<ResultType>
- A promise that resolves when the context is consumed.
Memberof
UmbContextConsumer

Description
Get the context as a promise.
Inherited from UmbContextConsumer.asPromise
- Defined in src/libs/context-api/consume/context-consumer.ts:114

destroy

destroy(): void
Returns void
Implementation of UmbController.destroy
Overrides UmbContextConsumer.destroy
- Defined in src/libs/context-api/consume/context-consumer.controller.ts:27

hostConnected

hostConnected(): void
Returns void
Implementation of UmbController.hostConnected
Inherited from UmbContextConsumer.hostConnected
- Defined in src/libs/context-api/consume/context-consumer.ts:142

hostDisconnected

hostDisconnected(): void
Returns void
Implementation of UmbController.hostDisconnected
Inherited from UmbContextConsumer.hostDisconnected
- Defined in src/libs/context-api/consume/context-consumer.ts:149

passContextAliasMatches

passContextAliasMatches(): UmbContextConsumerController<BaseType, ResultType>
Returns UmbContextConsumerController<BaseType, ResultType>
- The current instance of the UmbContextConsumer.
Memberof
UmbContextConsumer

Description
Pass beyond any context aliases that matches this. The default behavior is to stop at first Context Alias match, this is to avoid receiving unforeseen descending contexts.
Inherited from UmbContextConsumer.passContextAliasMatches
- Defined in src/libs/context-api/consume/context-consumer.ts:72

request

request(): void
Returns void
Memberof
UmbContextConsumer

Description
Request the context from the host element.
Inherited from UmbContextConsumer.request
- Defined in src/libs/context-api/consume/context-consumer.ts:132

`Protected`setInstance

setInstance(instance): void
Parameters
- instance: ResultType
Returns void
Inherited from UmbContextConsumer.setInstance
- Defined in src/libs/context-api/consume/context-consumer.ts:98

skipHost

skipHost(): UmbContextConsumerController<BaseType, ResultType>
Returns UmbContextConsumerController<BaseType, ResultType>
- The current instance of the UmbContextConsumer.
Memberof
UmbContextConsumer

Description
Make the consumption skip the contexts provided by the Host element.
Inherited from UmbContextConsumer.skipHost
- Defined in src/libs/context-api/consume/context-consumer.ts:60

Class UmbContextConsumerController<BaseType, ResultType>

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns UmbContextConsumerController<BaseType, ResultType>

Properties

Protected_retrieveHost

Accessors

controllerAlias

Returns symbol

instance

Returns undefined | ResultType

Methods

Protected_onResponse

Parameters

Returns boolean

asPromise

Returns Promise<ResultType>

Memberof

Description

destroy

Returns void

hostConnected

Returns void

hostDisconnected

Returns void

passContextAliasMatches

Returns UmbContextConsumerController<BaseType, ResultType>

Memberof

Description

request

Returns void

Memberof

Description

ProtectedsetInstance

Parameters

Returns void

skipHost

Returns UmbContextConsumerController<BaseType, ResultType>

Memberof

Description

Settings

On This Page

`Protected`_retrieveHost

`Protected`_onResponse

`Protected`setInstance