Class UmbDocumentItemDataResolver<DocumentItemModel>

A controller for resolving data for a document item

Exports

UmbDocumentItemDataResolver

Type Parameters

DocumentItemModel extends UmbDocumentItemDataResolverModel

Hierarchy (View Summary)

UmbControllerBase
- UmbDocumentItemDataResolver

Implements

UmbItemDataResolver

Constructors

constructor

new UmbDocumentItemDataResolver<
DocumentItemModel extends UmbDocumentItemDataResolverModel,
>(
host: UmbControllerHost,
): UmbDocumentItemDataResolver<DocumentItemModel>
Type Parameters
- DocumentItemModel extends UmbDocumentItemDataResolverModel
Parameters
- host: UmbControllerHost
Returns UmbDocumentItemDataResolver<DocumentItemModel>
Overrides UmbControllerBase.constructor
- Defined in src/packages/documents/documents/item/document-item-data-resolver.ts:77

Properties

_host

_host: UmbControllerHost

`Readonly`createDate

createDate: Observable<Date | undefined> = ...

`Readonly`entityType

entityType: Observable<"document" | undefined> = ...

`Readonly`flags

flags: Observable<UmbEntityFlag[]> = ...

`Readonly`hasCollection

hasCollection: Observable<boolean> = ...

`Readonly`icon

icon: Observable<string | undefined> = ...

`Readonly`isDraft

isDraft: Observable<boolean | undefined> = ...

`Readonly`isTrashed

isTrashed: Observable<boolean | undefined> = ...

`Readonly`name

name: Observable<string | undefined> = ...

`Readonly`state

state: Observable<DocumentVariantStateModel | null | undefined> = ...

`Readonly`typeUnique

typeUnique: Observable<string | undefined> = ...

`Readonly`unique

unique: Observable<string | undefined> = ...

`Readonly`updateDate

updateDate: Observable<Date | undefined> = ...

Accessors

controllerAlias

get controllerAlias(): UmbControllerAlias
Returns UmbControllerAlias
Implementation of UmbItemDataResolver.controllerAlias
Inherited from UmbControllerBase.controllerAlias
- Defined in src/libs/controller-api/controller.interface.ts:3

Methods

addEventListener

addEventListener(
    type: string,
    callback: EventListenerOrEventListenerObject | null,
    options?: boolean | AddEventListenerOptions,
): void
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference
Parameters
- type: string
- callback: EventListenerOrEventListenerObject | null
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Implementation of UmbItemDataResolver.addEventListener
Inherited from UmbControllerBase.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11569

addUmbController

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

consumeContext

consumeContext<
    BaseType extends UmbContextMinimal = UmbContextMinimal,
    ResultType extends UmbContextMinimal = BaseType,
>(
    alias: string | UmbContextToken<BaseType, ResultType>,
    callback: UmbContextCallback<ResultType>,
): UmbContextConsumerController<BaseType, ResultType>
Type Parameters
- BaseType extends UmbContextMinimal = UmbContextMinimal
- ResultType extends UmbContextMinimal = 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
Implementation of UmbItemDataResolver.consumeContext
Inherited from UmbControllerBase.consumeContext
- Defined in src/libs/class-api/class.interface.ts:64

destroy

destroy(): void
Returns void
Implementation of UmbItemDataResolver.destroy
Inherited from UmbControllerBase.destroy
- Defined in src/libs/controller-api/controller.interface.ts:6

dispatchEvent

dispatchEvent(event: Event): boolean
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

MDN Reference
Parameters
- event: Event
Returns boolean
Implementation of UmbItemDataResolver.dispatchEvent
Inherited from UmbControllerBase.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11575

getContext

getContext<
    BaseType extends UmbContextMinimal = UmbContextMinimal,
    ResultType extends UmbContextMinimal = BaseType,
>(
    alias: string | UmbContextToken<BaseType, ResultType>,
    options?: UmbClassGetContextOptions,
): Promise<ResultType | undefined>
Type Parameters
- BaseType extends UmbContextMinimal = UmbContextMinimal
- ResultType extends UmbContextMinimal = BaseType
Parameters
- alias: string | UmbContextToken<BaseType, ResultType>
- Optionaloptions: UmbClassGetContextOptions
Returns Promise<ResultType | undefined>
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
Implementation of UmbItemDataResolver.getContext
Inherited from UmbControllerBase.getContext
- Defined in src/libs/class-api/class.interface.ts:75

getCreateDate

getCreateDate(): Promise<Date>
Get the create date of the item

Returns Promise<Date>
The create date of the item

Memberof
UmbDocumentItemDataResolver
- Defined in src/packages/documents/documents/item/document-item-data-resolver.ts:204

getCulture

getCulture(): string | null | undefined
Get the display culture or fallback culture

Returns string | null | undefined
The display culture or fallback culture

Memberof
UmbDocumentItemDataResolver
- Defined in src/packages/documents/documents/item/document-item-data-resolver.ts:113

getData

getData(): DocumentItemModel | undefined
Get the current item

Returns DocumentItemModel | undefined
The current item

Memberof
UmbDocumentItemDataResolver
Implementation of UmbItemDataResolver.getData
- Defined in src/packages/documents/documents/item/document-item-data-resolver.ts:122

getEntityType

getEntityType(): Promise<string | undefined>
Get the entity type of the item

Returns Promise<string | undefined>
The entity type of the item

Memberof
UmbDocumentItemDataResolver
Implementation of UmbItemDataResolver.getEntityType
- Defined in src/packages/documents/documents/item/document-item-data-resolver.ts:141

getHasCollection

getHasCollection(): boolean
Test if the item has a collection

Returns boolean
Boolean of whether the item has a collection.

Memberof
UmbDocumentItemDataResolver
- Defined in src/packages/documents/documents/item/document-item-data-resolver.ts:222

getHostElement

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

getIcon

getIcon(): Promise<string | undefined>
Get the icon of the item

Returns Promise<string | undefined>
The icon of the item

Memberof
UmbDocumentItemDataResolver
Implementation of UmbItemDataResolver.getIcon
- Defined in src/packages/documents/documents/item/document-item-data-resolver.ts:168

getIsDraft

getIsDraft(): Promise<boolean>
Get the isDraft of the item

Returns Promise<boolean>
The isDraft of the item

Memberof
UmbDocumentItemDataResolver
- Defined in src/packages/documents/documents/item/document-item-data-resolver.ts:186

getIsTrashed

getIsTrashed(): Promise<boolean>
Get the isTrashed of the item

Returns Promise<boolean>
The isTrashed of the item

Memberof
UmbDocumentItemDataResolver
- Defined in src/packages/documents/documents/item/document-item-data-resolver.ts:195

getName

getName(): Promise<string>
Get the name of the item

Returns Promise<string>
The name of the item

Memberof
UmbDocumentItemDataResolver
Implementation of UmbItemDataResolver.getName
- Defined in src/packages/documents/documents/item/document-item-data-resolver.ts:159

getState

getState(): Promise<DocumentVariantStateModel | null | undefined>
Get the state of the item

Returns Promise<DocumentVariantStateModel | null | undefined>
The state of the item

Memberof
UmbDocumentItemDataResolver
- Defined in src/packages/documents/documents/item/document-item-data-resolver.ts:177

getUmbControllers

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

getUnique

getUnique(): Promise<string | undefined>
Get the unique of the item

Returns Promise<string | undefined>
The unique of the item

Memberof
UmbDocumentItemDataResolver
Implementation of UmbItemDataResolver.getUnique
- Defined in src/packages/documents/documents/item/document-item-data-resolver.ts:150

getUpdateDate

getUpdateDate(): Promise<Date>
Get the update date of the item

Returns Promise<Date>
The update date of the item

Memberof
UmbDocumentItemDataResolver
- Defined in src/packages/documents/documents/item/document-item-data-resolver.ts:213

observe

observe<
    ObservableType extends Observable<T>
    | undefined,
    T,
    SpecificT = ObservableType extends Observable<U>
        ? ObservableType extends undefined ? U | undefined : U
        : undefined,
    SpecificR = ObservableType extends undefined
        ? UmbObserverController<SpecificT>
        | undefined
        : UmbObserverController<SpecificT>,
>(
    source: ObservableType,
    callback?: ObserverCallback<SpecificT>,
    controllerAlias?: UmbControllerAlias | null,
): SpecificR
Type Parameters
- ObservableType extends Observable<T> | undefined
- T
- SpecificT = ObservableType extends Observable<U>
  ? ObservableType extends undefined ? U | undefined : U
  : undefined
- SpecificR = ObservableType extends undefined
      ? UmbObserverController<SpecificT>
      | undefined
      : UmbObserverController<SpecificT>
Parameters
- source: ObservableType
  An Observable to observe from.
- Optionalcallback: ObserverCallback<SpecificT>
  Callback method called when data is changed.
- OptionalcontrollerAlias: UmbControllerAlias | null
  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
Implementation of UmbItemDataResolver.observe
Inherited from UmbControllerBase.observe
- Defined in src/libs/class-api/class.interface.ts:27

provideContext

provideContext<R extends UmbContextMinimal = UmbContextMinimal>(
alias: string | UmbContextToken<R, R>,
instance: R,
): UmbContextProviderController<R>
Type Parameters
- R extends UmbContextMinimal = UmbContextMinimal
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
Implementation of UmbItemDataResolver.provideContext
Inherited from UmbControllerBase.provideContext
- Defined in src/libs/class-api/class.interface.ts:52

removeEventListener

removeEventListener(
    type: string,
    callback: EventListenerOrEventListenerObject | null,
    options?: boolean | EventListenerOptions,
): void
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

MDN Reference
Parameters
- type: string
- callback: EventListenerOrEventListenerObject | null
- Optionaloptions: boolean | EventListenerOptions
Returns void
Implementation of UmbItemDataResolver.removeEventListener
Inherited from UmbControllerBase.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11581

removeUmbController

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

removeUmbControllerByAlias

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

setData

setData(data: DocumentItemModel | undefined): void
Set the current item
Parameters
- data: DocumentItemModel | undefined
  The current item
Returns void
Memberof
UmbDocumentItemDataResolver
Implementation of UmbItemDataResolver.setData
- Defined in src/packages/documents/documents/item/document-item-data-resolver.ts:131

Class UmbDocumentItemDataResolver<DocumentItemModel>

Exports

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns UmbDocumentItemDataResolver<DocumentItemModel>

Properties

_host

ReadonlycreateDate

ReadonlyentityType

Readonlyflags

ReadonlyhasCollection

Readonlyicon

ReadonlyisDraft

ReadonlyisTrashed

Readonlyname

Readonlystate

ReadonlytypeUnique

Readonlyunique

ReadonlyupdateDate

Accessors

controllerAlias

Returns UmbControllerAlias

Methods

addEventListener

Parameters

Returns void

addUmbController

Parameters

Returns void

consumeContext

Type Parameters

Parameters

Returns UmbContextConsumerController<BaseType, ResultType>

Description

Memberof

destroy

Returns void

dispatchEvent

Parameters

Returns boolean

getContext

Type Parameters

Parameters

Returns Promise<ResultType | undefined>

Description

Memberof

getCreateDate

Returns Promise<Date>

Memberof

getCulture

Returns string | null | undefined

Memberof

getData

Returns DocumentItemModel | undefined

Memberof

getEntityType

Returns Promise<string | undefined>

Memberof

getHasCollection

Returns boolean

Memberof

getHostElement

Returns Element

getIcon

Returns Promise<string | undefined>

Memberof

getIsDraft

Returns Promise<boolean>

Memberof

getIsTrashed

`Readonly`createDate

`Readonly`entityType

`Readonly`flags

`Readonly`hasCollection

`Readonly`icon

`Readonly`isDraft

`Readonly`isTrashed

`Readonly`name

`Readonly`state

`Readonly`typeUnique

`Readonly`unique

`Readonly`updateDate