Watch methods: update, delete

Reference for Watch, one group of Watch methods.

Watch.update

Changes the given properties of a Watch. Verb page.

TypeScript

interface WatchVerbs {
  update(input: WatchUpdateInput, options?: SB.CallOptions): SB.Call<Watch>
}

Emits Watch.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Watch.
`selector`	`string`		The Event selector, such as `Order.placed`.
`url`	`url`		Where deliveries go.
`payload`	`string`		One of `full`, or `thin`: the record as the Action left it, or only its versioned address. The default is full.

Returns

Output	Type	Required	Description
`watch`	Watch	required	The Watch.

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 watch = await $.Watch.update({ id: 'watch_9o4vCuR17L', url: 'https://leaseline.app' })

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

TypeScript

interface WatchVerbs {
  delete(input: WatchDeleteInput, options?: SB.CallOptions): SB.Call<Watch>
}

Emits Watch.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`watch`	Watch	required	The Watch.

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 watch = await $.Watch.delete({ id: 'watch_9o4vCuR17L' })