ReadItem

Defined in: runtime/item.ts:101

Extends

• BaseReadItem.StandardItem

Properties

createdAt

readonly createdAt: Date

Defined in: runtime/item.ts:28

Inherited from

BaseReadItem.createdAt

---

definition

readonly definition: TemplateDefinition

Defined in: runtime/item.ts:29

Inherited from

BaseReadItem.definition

---

id

readonly id: string

Defined in: runtime/item.ts:27

Inherited from

BaseReadItem.id

---

isArchived

readonly isArchived: boolean

Defined in: runtime/item.ts:91

Inherited from

StandardItem.isArchived

---

isRefreshOverdue

readonly isRefreshOverdue: boolean

Defined in: runtime/item.ts:96

Inherited from

StandardItem.isRefreshOverdue

---

isRefreshPending

readonly isRefreshPending: boolean

Defined in: runtime/item.ts:95

Inherited from

StandardItem.isRefreshPending

---

key

readonly key: string | undefined

Defined in: runtime/item.ts:92

Inherited from

StandardItem.key

---

parentId

readonly parentId: string | undefined

Defined in: runtime/item.ts:93

Inherited from

StandardItem.parentId

---

properties

readonly properties: PropertyMap

Defined in: runtime/item.ts:30

Inherited from

BaseReadItem.properties

---

propertyValues

readonly propertyValues: PropertyValueMap

Defined in: runtime/item.ts:31

Inherited from

BaseReadItem.propertyValues

---

refreshBy

readonly refreshBy: Date | undefined

Defined in: runtime/item.ts:97

Inherited from

StandardItem.refreshBy

---

refreshedAt

readonly refreshedAt: Date | undefined

Defined in: runtime/item.ts:98

Inherited from

StandardItem.refreshedAt

---

relations

readonly relations: Record<string, ReadRelationInstance>

Defined in: runtime/item.ts:33

Inherited from

BaseReadItem.relations

---

state

readonly state: ReadStateInstance<string | null> | null

Defined in: runtime/item.ts:34

Inherited from

BaseReadItem.state

---

templatePrn

readonly templatePrn: string

Defined in: runtime/item.ts:32

Inherited from

BaseReadItem.templatePrn

---

workspaceId

readonly workspaceId: string

Defined in: runtime/item.ts:35

Inherited from

BaseReadItem.workspaceId

Methods

assertRole()

assertRole(role): Promise<true>

Defined in: runtime/item.ts:41

Asserts that the current, active item instance has the current role. If successful, this will return true. Otherwise it will throw an Error.

Parameters

role

TemplateRoleInstance

Returns

Promise<true>

Inherited from

BaseReadItem.assertRole

---

checkRole()

checkRole(role): Promise<boolean>

Defined in: runtime/item.ts:47

Checks that the current, active item instance has the current role; returning true/false if that role is present.

Parameters

role

TemplateRoleInstance

Returns

Promise<boolean>

Inherited from

BaseReadItem.checkRole

---

currentRoles()

currentRoles(): Promise<BaseRoleInstance[]>

Defined in: runtime/item.ts:57

Returns the roles that the current user has available on this item. Note that for sudo/system users this will be all available roles.

MATT: This is currently async. Maybe we can revisit that later.

Returns

Promise<BaseRoleInstance[]>

Inherited from

BaseReadItem.currentRoles

---

extensions()

extensions<TReadTemplate>(template): Promise<ReadTemplateExtension>

Defined in: runtime/item.ts:108

Configure property extensions for children of this item. The provided template must be extensible or an error will be thrown.

Type Parameters

TReadTemplate

TReadTemplate extends ReadTemplate<ReadItem> & object

Parameters

template

TReadTemplate

Returns

Promise<ReadTemplateExtension>

---

getChildByKey()

getChildByKey(key): Promise<ReadItem | undefined>

Defined in: runtime/item.ts:59

Parameters

key

string

Returns

Promise<ReadItem | undefined>

Inherited from

BaseReadItem.getChildByKey

---

getParent()

getParent(): Promise<ReadItem | undefined>

Defined in: runtime/item.ts:60

Returns

Promise<ReadItem | undefined>

Inherited from

BaseReadItem.getParent

---

selectChildren()

selectChildren(): ItemCursorSelector<ReadItem>

Defined in: runtime/item.ts:102

Returns

ItemCursorSelector<ReadItem>