Keyword methods: update, delete

Reference for Keyword, one group of Keyword methods.

Keyword.update

Changes the given properties of a Keyword. Verb page.

TypeScript

interface KeywordVerbs {
  update(input: KeywordUpdateInput, options?: SB.CallOptions): SB.Call<Keyword>
}

Emits Keyword.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Keyword.
`phrase`	`string`		The words searched or asked.
`form`	`string`		One of `search` or `question`.

Returns

Output	Type	Required	Description
`keyword`	Keyword	required	The Keyword.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const keyword = await $.Keyword.update({ id: 'keyword_cEoeFM4Drs', form: 'search' })

Deletes a Keyword: a soft delete that keeps its history, undone by Thing.restore. Verb page.

TypeScript

interface KeywordVerbs {
  delete(input: KeywordDeleteInput, options?: SB.CallOptions): SB.Call<Keyword>
}

Emits Keyword.deleted.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Keyword.

Returns

Output	Type	Required	Description
`keyword`	Keyword	required	The Keyword.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const keyword = await $.Keyword.delete({ id: 'keyword_cEoeFM4Drs' })