Registration methods: admit, approve, attend
The Registration Verbs admit, approve, attend as typed SDK methods, with inputs, result, refusals and an example.
Reference for Registration, one group of Registration methods.
Registration.admit
Admit gives the next Contact in line a place at a Gathering when one frees up or its capacity rises. Verb page.
interface RegistrationVerbs {
admit(input: RegistrationAdmitInput, options?: SB.CallOptions): SB.Call<Registration>
}Emits Registration.admitted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
registration | Registration | required | The waitlisted Registration. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
registration | Registration | required | The Registration, now registered. |
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. |
| The Gathering is at capacity | refused | Clear what the check names, then call it again. | None. |
Example
import { $ } from 'startup-builder'
const registration = await $.Registration.admit({ registration: 'registration_95lvb7R17L' })Registration.approve
Approve gives a requested place at a Gathering to the Contact who asked, or a place in line when the Gathering is full. Verb page.
interface RegistrationVerbs {
approve(input: RegistrationApproveInput, options?: SB.CallOptions): SB.Call<Registration>
}Emits Registration.approved.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
registration | Registration | required | The requested Registration. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
registration | Registration | required | The Registration, registered or waitlisted. |
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 = await $.Registration.approve({ registration: 'registration_95lvb7R17L' })Registration.attend
Attend records that a registered Contact joined the Gathering; an online room calls it on join. Verb page.
interface RegistrationVerbs {
attend(input: RegistrationAttendInput, options?: SB.CallOptions): SB.Call<Registration>
}Emits Registration.attended.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
registration | Registration | required | The Registration of the Contact who joined. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
registration | Registration | required | The Registration, now attended. |
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 = await $.Registration.attend({ registration: 'registration_95lvb7R17L' })