Portal methods: update, delete

Reference for Portal, one group of Portal methods.

Portal.update

Changes the given properties of a Portal. Verb page.

TypeScript

interface PortalVerbs {
  update(input: PortalUpdateInput, options?: SB.CallOptions): SB.Call<Portal>
}

Emits Portal.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Portal.
`path`	`string`		Where it is mounted on the Site, `/portal` by default.
`tools`	`string[]`		Developer tools a keyed Offer adds: `keys`, `usage`, `requests`, `watches`, `version` and `testMode`.

Returns

Output	Type	Required	Description
`portal`	Portal	required	The Portal.

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 portal = await $.Portal.update({ id: 'portal_DDBhWh6mF5', path: '/' })

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

TypeScript

interface PortalVerbs {
  delete(input: PortalDeleteInput, options?: SB.CallOptions): SB.Call<Portal>
}

Emits Portal.deleted.

Inputs

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

Returns

Output	Type	Required	Description
`portal`	Portal	required	The Portal.

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 portal = await $.Portal.delete({ id: 'portal_DDBhWh6mF5' })