Class UmbContextConsumer<BaseType, ResultType>

UmbContextConsumer

Type Parameters

BaseType = unknown
ResultType extends BaseType = BaseType

Hierarchy (View Summary)

UmbContextConsumer
- UmbContextConsumerController

Index

Constructors

Accessors

Methods

_onResponse asPromise destroy hostConnected hostDisconnected passContextAliasMatches request setInstance skipHost

Constructors

constructor

new UmbContextConsumer<BaseType = unknown, ResultType = BaseType>(
    host: Element | HostElementMethod,
    contextIdentifier: string | UmbContextToken<BaseType, ResultType>,
    callback?: UmbContextCallback<ResultType>,
): UmbContextConsumer<BaseType, ResultType>
Creates an instance of UmbContextConsumer.
Type Parameters
- BaseType = unknown
- ResultType = BaseType
Parameters
- host: Element | HostElementMethod
  The host element.
- contextIdentifier: string | UmbContextToken<BaseType, ResultType>
  The context identifier, an alias or a Context Token.
- Optionalcallback: UmbContextCallback<ResultType>
  The callback.
Returns UmbContextConsumer<BaseType, ResultType>
Memberof
UmbContextConsumer
- Defined in src/libs/context-api/consume/context-consumer.ts:37

Properties

`Protected`_retrieveHost

_retrieveHost: HostElementMethod

Accessors

instance

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

Methods

`Protected`_onResponse

_onResponse(instance: BaseType): boolean
Parameters
- instance: BaseType
Returns boolean
- 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.
- Defined in src/libs/context-api/consume/context-consumer.ts:114

destroy

destroy(): void
Returns void
- Defined in src/libs/context-api/consume/context-consumer.ts:183

hostConnected

hostConnected(): void
Returns void
- Defined in src/libs/context-api/consume/context-consumer.ts:142

hostDisconnected

hostDisconnected(): void
Returns void
- Defined in src/libs/context-api/consume/context-consumer.ts:149

passContextAliasMatches

passContextAliasMatches(): UmbContextConsumer<BaseType, ResultType>
Returns UmbContextConsumer<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.
- 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.
- Defined in src/libs/context-api/consume/context-consumer.ts:132

`Protected`setInstance

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

skipHost

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

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