Class SpaceSettings

Index

Constructors

Methods

getSpaceSettings updateSpaceSettings

Constructors

constructor

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

Methods

getSpaceSettings

getSpaceSettings<T = Models.SpaceSettings>(
parameters: GetSpaceSettings,
callback: Callback<T>,
): 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 src/api/spaceSettings.ts:15
getSpaceSettings<T = Models.SpaceSettings>(
parameters: GetSpaceSettings,
callback?: undefined,
): 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
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/spaceSettings.ts:24

updateSpaceSettings

updateSpaceSettings<T = Models.SpaceSettings>(
parameters: UpdateSpaceSettings,
callback: Callback<T>,
): 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 src/api/spaceSettings.ts:45
updateSpaceSettings<T = Models.SpaceSettings>(
parameters: UpdateSpaceSettings,
callback?: undefined,
): 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
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/spaceSettings.ts:54