Interface UmbCollectionContext

interface UmbCollectionContext {
    items: Observable<any[]>;
    pagination: UmbPaginationManager;
    totalItems: Observable<number>;
    getConfig(): UmbCollectionConfiguration | undefined;
    getManifest(): ManifestCollection | undefined;
    requestCollection(): Promise<void>;
    requestItemHref?(item: UmbCollectionItemModel): Promise<string | undefined>;
    setConfig(config: UmbCollectionConfiguration): void;
    setManifest(manifest: ManifestCollection): void;
}

Implemented by

UmbDefaultCollectionContext

Index

Properties

items pagination totalItems

Methods

getConfig getManifest requestCollection requestItemHref? setConfig setManifest

Properties

items

items: Observable<any[]>

pagination

pagination: UmbPaginationManager

totalItems

totalItems: Observable<number>

Methods

getConfig

getConfig(): UmbCollectionConfiguration | undefined
Returns UmbCollectionConfiguration | undefined
- Defined in src/packages/core/collection/types.ts:58

getManifest

getManifest(): ManifestCollection | undefined
Returns ManifestCollection | undefined
- Defined in src/packages/core/collection/types.ts:60

requestCollection

requestCollection(): Promise<void>
Returns Promise<void>
- Defined in src/packages/core/collection/types.ts:61

`Optional`requestItemHref

requestItemHref?(item: UmbCollectionItemModel): Promise<string | undefined>
Parameters
- item: UmbCollectionItemModel
Returns Promise<string | undefined>
- Defined in src/packages/core/collection/types.ts:62

setConfig

setConfig(config: UmbCollectionConfiguration): void
Parameters
- config: UmbCollectionConfiguration
Returns void
- Defined in src/packages/core/collection/types.ts:57

setManifest

setManifest(manifest: ManifestCollection): void
Parameters
- manifest: ManifestCollection
Returns void
- Defined in src/packages/core/collection/types.ts:59