Skip to main content

Methods

batchCreate()

Create multiple custom context items in one request.

Parameters

CreateCustomContextItemInput[]
required
Items to create (same fields as CustomContextItemsResource.create).

Returns

Promise<CreatedCustomContextItem[]> Created item metadata for each input.

create()

Create a custom context item.

Parameters

CreateCustomContextItemInput
required

Returns

Promise<CreatedCustomContextItem> Created item ids and hierarchy metadata.

delete()

Delete a custom context item.

Parameters

string
required
Item uid.

Returns

Promise<CustomContextItemDeletion> Deletion confirmation with uid and context type.

get()

Retrieve a custom context item by uid.

Parameters

string
required
Item uid.

Returns

Promise<object> The custom context item.

list()

List custom context items.

Parameters

{ pageSize: number; pageToken: string; searchQuery: string; topics: string[] }

Returns

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

update()

Update a custom context item.

Parameters

string
required
Item uid.
UpdateCustomContextItemInput
required
Fields to change (kind and hierarchy ids cannot be changed).

Returns

Promise<{ uid: string }> The updated item uid.