Gathering methods: update, delete

Reference for Gathering, one group of Gathering methods.

Gathering.update

Changes the given properties of a Gathering. Verb page.

TypeScript

interface GatheringVerbs {
  update(input: GatheringUpdateInput, options?: SB.CallOptions): SB.Call<Gathering>
}

Emits Gathering.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Gathering.
`title`	`string`		What the Gathering is called on its Page and invitations.
`at`	`datetime`		When it starts.
`capacity`	`integer`		The most Registrations it admits before new ones join the waitlist.
`recording`	`url`		Where the replay lives once it ends.

Returns

Output	Type	Required	Description
`gathering`	Gathering	required	The Gathering.

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 gathering = await $.Gathering.update({ id: 'gathering_ACB9Q1atRR', title: 'Leaseline Pro' })

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

TypeScript

interface GatheringVerbs {
  delete(input: GatheringDeleteInput, options?: SB.CallOptions): SB.Call<Gathering>
}

Emits Gathering.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`gathering`	Gathering	required	The Gathering.

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 gathering = await $.Gathering.delete({ id: 'gathering_ACB9Q1atRR' })