Gathering methods: register
The Gathering Verbs register as typed SDK methods, with inputs, result, refusals and an example.
Reference for Gathering, one group of Gathering methods.
Gathering.register
Register gives a Contact a place at a Gathering, or a waitlist place when the Gathering is full. Verb page.
interface GatheringVerbs {
register(input: GatheringRegisterInput, options?: SB.CallOptions): SB.Call<GatheringRegisterOutput>
}Emits Gathering.registered.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
gathering | Gathering | required | The Gathering. |
contact | Contact | required | Who takes the place. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
registration | Registration | required | The Registration, registered or waitlisted. |
gathering | Gathering | required | The Gathering with its registered count. |
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 { registration, gathering } = await $.Gathering.register({ gathering: 'gathering_ACB9Q1atRR', contact: 'contact_WsrosCQi6J' })