Class SpaceSettingsService

See

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-settings

Hierarchy

CommonHttpService
- SpaceSettingsService

Index

Constructors

constructor

Methods

getSpaceSettings updateSpaceSettings initialize

Constructors

constructor

new SpaceSettingsService(getClientInstance): SpaceSettingsService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns SpaceSettingsService
Inherited from CommonHttpService.constructor

Methods

getSpaceSettings

getSpaceSettings(params): Promise<null | SpaceSettings>
Returns the settings of a space. Currently only the routeOverrideEnabled setting can be returned.

Permissions required: 'View' permission for the space.
Parameters
- params: {
  spaceKey: string;
  }
  - spaceKey: string
    The key of the space to be queried for its settings.
Returns Promise<null | SpaceSettings>
Returned if the space settings are returned.

Path
GET /wiki/rest/api/space/{spaceKey}/settings @scopes-current read:confluence-space.summary @scopes-beta read:space.setting:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-settings#api-wiki-rest-api-space-spacekey-settings-get

updateSpaceSettings

updateSpaceSettings(params): Promise<null | SpaceSettings>
Updates the settings for a space. Currently only the routeOverrideEnabled setting can be updated.

Permissions required: 'Admin' permission for the space.
Parameters
- params: {
  spaceKey: string;
  spaceSettingsUpdate: SpaceSettingsUpdate;
  }
  - spaceKey: string
    The key of the space whose settings will be updated.
  - spaceSettingsUpdate: SpaceSettingsUpdate
    The space settings to update.
Returns Promise<null | SpaceSettings>
Returned if space settings are updated.

Path
PUT /wiki/rest/api/space/{spaceKey}/settings @scopes-current write:confluence-space @scopes-beta read:space.setting:confluence, write:space.setting:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-settings#api-wiki-rest-api-space-spacekey-settings-put

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize

Class SpaceSettingsService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns SpaceSettingsService

Methods

getSpaceSettings

Parameters

spaceKey: string

Returns Promise<null | SpaceSettings>

Path

See

updateSpaceSettings

Parameters

spaceKey: string

spaceSettingsUpdate: SpaceSettingsUpdate

Returns Promise<null | SpaceSettings>

Path

See

Protected Staticinitialize

Returns void

Settings

On This Page

`Protected` `Static`initialize