Content methods: update, delete
The Content Verbs update, delete as typed SDK methods, with inputs, result, refusals and an example.
Reference for Content, one group of Content methods.
Content.update
Changes the given properties of a Content. Verb page.
interface ContentVerbs {
update(input: ContentUpdateInput, options?: SB.CallOptions): SB.Call<Content>
}Emits Content.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Content. |
title | string | The headline. | |
publishedAt | datetime | When it went live. | |
kind | string | What the Content is, so each System reads its own kind. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
content | Content | required | The Content. |
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
import { $ } from 'startup-builder'
const content = await $.Content.update({ id: 'content_HYlnoorBdP', title: 'Leaseline Pro' })Content.delete
Deletes a Content: a soft delete that keeps its history, undone by Thing.restore. Verb page.
interface ContentVerbs {
delete(input: ContentDeleteInput, options?: SB.CallOptions): SB.Call<Content>
}Emits Content.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Content. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
content | Content | required | The Content. |
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
import { $ } from 'startup-builder'
const content = await $.Content.delete({ id: 'content_HYlnoorBdP' })