Class SpaceSettings

Index

Constructors

Properties

Methods

getSpaceSettings updateSpaceSettings

Constructors

constructor

new SpaceSettings(client): Api.SpaceSettings
Parameters
- client: Client
Returns Api.SpaceSettings
- Defined in api/spaceSettings.ts:8

Properties

`Private` client

client: Client

Methods

getSpaceSettings

getSpaceSettings<T>(parameters, callback): Promise<void>
Returns the settings of a space. Currently only the routeOverrideEnabled setting can be returned.

Permissions required: 'View' permission for the space.
Type Parameters
- T = Models.SpaceSettings
Parameters
- parameters: GetSpaceSettings
- callback: Callback<T>
Returns Promise<void>
- Defined in api/spaceSettings.ts:15
getSpaceSettings<T>(parameters, callback?): Promise<T>
Returns the settings of a space. Currently only the routeOverrideEnabled setting can be returned.

Permissions required: 'View' permission for the space.
Type Parameters
- T = Models.SpaceSettings
Parameters
- parameters: GetSpaceSettings
- Optional callback: undefined
Returns Promise<T>
- Defined in api/spaceSettings.ts:24

updateSpaceSettings

updateSpaceSettings<T>(parameters, callback): Promise<void>
Updates the settings for a space. Currently only the routeOverrideEnabled setting can be updated.

Permissions required: 'Admin' permission for the space.
Type Parameters
- T = Models.SpaceSettings
Parameters
- parameters: UpdateSpaceSettings
- callback: Callback<T>
Returns Promise<void>
- Defined in api/spaceSettings.ts:45
updateSpaceSettings<T>(parameters, callback?): Promise<T>
Updates the settings for a space. Currently only the routeOverrideEnabled setting can be updated.

Permissions required: 'Admin' permission for the space.
Type Parameters
- T = Models.SpaceSettings
Parameters
- parameters: UpdateSpaceSettings
- Optional callback: undefined
Returns Promise<T>
- Defined in api/spaceSettings.ts:54

Generated using TypeDoc v0.25.12