ReadRuntimeInstance
Defined in: runtime/runtime.ts:37
Extends
Section titled “Extends”Extended by
Section titled “Extended by”Properties
Section titled “Properties”
readonlyapps:Record<string,ReadAppInstance>
Defined in: runtime/runtime.ts:38
readonlynow:DateTime
Defined in: runtime/runtime.ts:39
principalId
Section titled “principalId”
readonlyprincipalId:string
Defined in: runtime/runtime.ts:40
readonlyroot:ReadAppInstance
Defined in: runtime/runtime.ts:41
workspaceId
Section titled “workspaceId”
readonlyworkspaceId:string
Defined in: runtime/index.ts:39
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”getItem()
Section titled “getItem()”getItem(
id):Promise<ReadItem|undefined>
Defined in: runtime/runtime.ts:42
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<ReadItem | undefined>
getItemByKeyPath()
Section titled “getItemByKeyPath()”getItemByKeyPath(…
parts):Promise<ReadItem|undefined>
Defined in: runtime/runtime.ts:43
Parameters
Section titled “Parameters”…[string, ...string[]]
Returns
Section titled “Returns”Promise<ReadItem | undefined>
getWorkspaceItem()
Section titled “getWorkspaceItem()”getWorkspaceItem():
Promise<ReadWorkspaceItem|undefined>
Defined in: runtime/runtime.ts:44
Returns
Section titled “Returns”Promise<ReadWorkspaceItem | undefined>
getWorkspaceTemplate()
Section titled “getWorkspaceTemplate()”getWorkspaceTemplate():
ReadTemplate
Defined in: runtime/runtime.ts:45
Returns
Section titled “Returns”hashKey()
Section titled “hashKey()”hashKey(
source):Promise<string>
Defined in: runtime/runtime.ts:52
Creates a key by hashing the provided value. The source can be up to 1,024 characters.
Parameters
Section titled “Parameters”source
Section titled “source”string
Returns
Section titled “Returns”Promise<string>
log(
message, …optional):void
Defined in: runtime/runtime.ts:46
Parameters
Section titled “Parameters”message
Section titled “message”any
optional
Section titled “optional”…any[]
Returns
Section titled “Returns”void
selectItems()
Section titled “selectItems()”selectItems():
ItemCursorSelector<ReadItem>
Defined in: runtime/runtime.ts:58
Returns an item selection builder that allows retrieving items that are in this workspace
Returns
Section titled “Returns”sudo()
Section titled “sudo()”sudo<
TResult>(fn):Promise<TResult>
Defined in: runtime/runtime.ts:65
Moves into a readonly sudo role: This is effectively system, but tracked against the existing principal (if any). Calling this from system does nothing. If you are already sudo, the existing sudo is retained.
Type Parameters
Section titled “Type Parameters”TResult
Section titled “TResult”TResult
Parameters
Section titled “Parameters”(ctx) => Promise<TResult>
Returns
Section titled “Returns”Promise<TResult>
template()
Section titled “template()”template(
prn):Promise<ReadTemplate<ReadItem> |undefined>
Defined in: runtime/runtime.ts:70
Return the template matching the supplied prn.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<ReadTemplate<ReadItem> | undefined>