Comment methods: create, get, list

Reference for Comment, one group of Comment methods.

Comment.create

Creates a Comment. Verb page.

TypeScript

interface CommentVerbs {
  create(input: CommentCreateInput, options?: SB.CallOptions): SB.Call<Comment>
}

Emits Comment.created.

Inputs

Input	Type	Required	Description
`body`	`text`	required	What it says.
`thing`	Thing		A Comment is an internal note on one Thing, never sent to a Contact.
`worker`	Worker		Every Comment names the Worker, human or agent, who wrote it.

Returns

Output	Type	Required	Description
`comment`	Comment	required	The Comment.

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 comment = await $.Comment.create({ body: 'Example body' })

Returns one Comment by id. Verb page.

TypeScript

interface CommentVerbs {
  get(input: CommentGetInput, options?: SB.CallOptions): SB.Call<Comment>
}

Reads only: it emits no Event.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Comment.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

Returns

Output	Type	Required	Description
`comment`	Comment	required	The Comment.

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 comment = await $.Comment.get({ id: 'comment_MUIgpgdysq' })

Returns Comments, newest first, one page at a time. Verb page.

TypeScript

interface CommentVerbs {
  list(input?: CommentListInput, options?: SB.CallOptions): SB.ListCall<Comment>
}

Reads only: it emits no Event.

Inputs

Input	Type	Description
`limit`	`integer`	At most this many records, up to 100. The default is 20.
`after`	`string`	The cursor from the previous page.
`where`	`string`	A filter over the properties, such as `paidAt = null and total.amount > 500`.
`sort`	`string`	Properties to sort by, comma-separated; a leading minus sorts descending.
`total`	`boolean`	True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above.
`facets`	`string`	Properties to count by value, comma-separated, returned as `meta.facets`.
`fields`	`string`	Properties to return on each record, comma-separated; `$id` and `$type` always return.
`include`	`string`	Related records to embed in place of their URLs, comma-separated.
`depth`	`integer`	How many levels of related records to embed. The default is 1.
`q`	`string`	Words to match across the text properties, ranked by relevance.
`match`	`string`	Ranks the search by `words`, or `meaning`; words is the default.

Returns

Output	Type	Required	Description
`comments`	list of Comment	required	One page of Comments.

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 comments = await $.Comment.list({ limit: 20 })