ReadTemplate

Defined in: runtime/template.ts:31

Template defines the metadata (property definition) for an item. This is the read-version that does not support any updates.

Extended by

• WriteTemplate

Type Parameters

TReadItem

TReadItem extends ReadItem = ReadItem

Properties

definition

readonly definition: TemplateDefinition

Defined in: runtime/template.ts:32

---

grants

readonly grants: TemplateGrantInstance[]

Defined in: runtime/template.ts:33

---

isExtensible

readonly isExtensible: boolean

Defined in: runtime/template.ts:34

---

prn

readonly prn: string

Defined in: runtime/template.ts:35

---

properties

readonly properties: Readonly<Record<string, PropertyDefinition>>

Defined in: runtime/template.ts:36

---

relations

readonly relations: Record<string, RelationDefinition>

Defined in: runtime/template.ts:37

---

roles

readonly roles: Record<string, TemplateRoleInstance>

Defined in: runtime/template.ts:38

Methods

getItem()

getItem(id): Promise<TReadItem | undefined>

Defined in: runtime/template.ts:45

Returns the item of the given identifier if it is of the type of this template. If the item does not exist, there are insufficient permissions, or the template does not match; will result in undefined.

Parameters

id

string

Returns

Promise<TReadItem | undefined>

---

isType()

isType(value): value is TReadItem

Defined in: runtime/template.ts:51

Returns true if the supplied item is of the type of this template.

Parameters

value

unknown

Returns

value is TReadItem

---

selectItems()

selectItems(): TemplateItemCursorSelector<TReadItem>

Defined in: runtime/template.ts:58

Returns an item selection builder that allows retrieving items that match this template. This will be all items, irrespective of parent-child hierarchy. See the ItemSelector documentation for more.

Returns

TemplateItemCursorSelector<TReadItem>