Skip to main content

Methods

get()

Retrieve a knowledge-base item by uid.

Parameters

string
required
Item uid.

Returns

Promise<object> The context item.

list()

List knowledge-base items.

Parameters

{ pageSize: number; pageToken: string; contextType: string }

Returns

Promise<Page<object>> A page of context items.

listValues()

List values stored under a content key on a context item.

Parameters

string
required
Item uid.
string
required
Context type of the item.
string
required
Dot path to the value field inside item content.
{ pageSize: number; pageToken: string }

Returns

Promise<Page<ContextValueRow>> A page of value rows.

listValuesFor()

List values for a context item already loaded via ContextItemsResource.list or ContextItemsResource.get.

Parameters

object
required
Context item (uses item.uid and item.contextType).
string
required
Dot path to the value field inside item content.
{ pageSize: number; pageToken: string }

Returns

Promise<Page<ContextValueRow>> A page of value rows.

lookup()

Look up a knowledge-base item by type and data path.

Parameters

required

Returns

Promise<object | undefined> The matching row, or undefined when no item is found (404).