Class Space

Index

Constructors

Properties

Methods

createPrivateSpace createSpace createSpaceProperty createSpacePropertyForKey deleteSpace deleteSpaceProperty getContentByType getContentForSpace getSpace getSpaceProperties getSpaceProperty getSpaces updateSpace updateSpaceProperty

Constructors

constructor

new Space(client): Server.Space
Parameters
- client: Client
Returns Server.Space
- Defined in server/space.ts:9

Properties

`Private` client

client: Client

Methods

createPrivateSpace

createPrivateSpace<T>(parameters, callback): Promise<void>
Creates a new private Space, viewable only by its creator.

The incoming Space does not include an id, but must include a Key and Name, and should include a Description.
Type Parameters
- T = ServerModels.Space
Parameters
- parameters: ServerParameters.CreatePrivateSpace
- callback: Callback<T>
Returns Promise<void>
- Defined in server/space.ts:72
createPrivateSpace<T>(parameters, callback?): Promise<T>
Creates a new private Space, viewable only by its creator.

The incoming Space does not include an id, but must include a Key and Name, and should include a Description.
Type Parameters
- T = ServerModels.Space
Parameters
- parameters: ServerParameters.CreatePrivateSpace
- Optional callback: undefined
Returns Promise<T>
- Defined in server/space.ts:81

createSpace

createSpace<T>(parameters, callback): Promise<void>
Creates a new Space.

The incoming Space does not include an id, but must include a Key and Name, and should include a Description.
Type Parameters
- T = ServerModels.Space
Parameters
- parameters: ServerParameters.CreateSpace
- callback: Callback<T>
Returns Promise<void>
- Defined in server/space.ts:45
createSpace<T>(parameters, callback?): Promise<T>
Creates a new Space.

The incoming Space does not include an id, but must include a Key and Name, and should include a Description.
Type Parameters
- T = ServerModels.Space
Parameters
- parameters: ServerParameters.CreateSpace
- Optional callback: undefined
Returns Promise<T>
- Defined in server/space.ts:51

createSpaceProperty

createSpaceProperty<T>(parameters, callback): Promise<void>
Creates a new space property.
Type Parameters
- T = ServerModels.SpaceProperty
Parameters
- parameters: ServerParameters.CreateSpaceProperty
- callback: Callback<T>
Returns Promise<void>
- Defined in server/space.ts:243
createSpaceProperty<T>(parameters, callback?): Promise<T>
Creates a new space property.
Type Parameters
- T = ServerModels.SpaceProperty
Parameters
- parameters: ServerParameters.CreateSpaceProperty
- Optional callback: undefined
Returns Promise<T>
- Defined in server/space.ts:248

createSpacePropertyForKey

createSpacePropertyForKey<T>(parameters, callback): Promise<void>
Creates a new space property.
Type Parameters
- T = ServerModels.SpaceProperty
Parameters
- parameters: ServerParameters.CreateSpacePropertyForKey
- callback: Callback<T>
Returns Promise<void>
- Defined in server/space.ts:294
createSpacePropertyForKey<T>(parameters, callback?): Promise<T>
Creates a new space property.
Type Parameters
- T = ServerModels.SpaceProperty
Parameters
- parameters: ServerParameters.CreateSpacePropertyForKey
- Optional callback: undefined
Returns Promise<T>
- Defined in server/space.ts:299

deleteSpace

deleteSpace<T>(parameters, callback): Promise<void>
Deletes a Space.

The space is deleted in a long running task, so the space cannot be considered deleted when this resource returns. Clients can follow the status link in the response and poll it until the task completes. Responses
Type Parameters
- T = ServerModels.DeletedSpace
Parameters
- parameters: ServerParameters.DeleteSpace
- callback: Callback<T>
Returns Promise<void>
- Defined in server/space.ts:139
deleteSpace<T>(parameters, callback?): Promise<T>
Deletes a Space.

The space is deleted in a long running task, so the space cannot be considered deleted when this resource returns. Clients can follow the status link in the response and poll it until the task completes. Responses
Type Parameters
- T = ServerModels.DeletedSpace
Parameters
- parameters: ServerParameters.DeleteSpace
- Optional callback: undefined
Returns Promise<T>
- Defined in server/space.ts:146

deleteSpaceProperty

deleteSpaceProperty<T>(parameters, callback): Promise<void>
Deletes a space property.
Type Parameters
- T = void
Parameters
- parameters: ServerParameters.DeleteSpaceProperty
- callback: Callback<T>
Returns Promise<void>
- Defined in server/space.ts:349
deleteSpaceProperty<T>(parameters, callback?): Promise<T>
Deletes a space property.
Type Parameters
- T = void
Parameters
- parameters: ServerParameters.DeleteSpaceProperty
- Optional callback: undefined
Returns Promise<T>
- Defined in server/space.ts:351

getContentByType

getContentByType<T>(parameters, callback): Promise<void>
Returns the content in this given space with the given type
Type Parameters
- T = Pagination<ServerModels.Content>
Parameters
- parameters: GetContentByType
- callback: Callback<T>
Returns Promise<void>
- Defined in server/space.ts:188
getContentByType<T>(parameters, callback?): Promise<T>
Returns the content in this given space with the given type
Type Parameters
- T = Pagination<ServerModels.Content>
Parameters
- parameters: GetContentByType
- Optional callback: undefined
Returns Promise<T>
- Defined in server/space.ts:193

getContentForSpace

getContentForSpace<T>(parameters, callback): Promise<void>
Returns the content in this given space
Type Parameters
- T = Pagination<ServerModels.Content>
Parameters
- parameters: ServerParameters.GetContentForSpace
- callback: Callback<T>
Returns Promise<void>
- Defined in server/space.ts:160
getContentForSpace<T>(parameters, callback?): Promise<T>
Returns the content in this given space
Type Parameters
- T = Pagination<ServerModels.Content>
Parameters
- parameters: ServerParameters.GetContentForSpace
- Optional callback: undefined
Returns Promise<T>
- Defined in server/space.ts:165

getSpace

getSpace<T>(parameters, callback): Promise<void>
Returns information about a space.
Type Parameters
- T = ServerModels.Space
Parameters
- parameters: ServerParameters.GetSpace
- callback: Callback<T>
Returns Promise<void>
- Defined in server/space.ts:100
getSpace<T>(parameters, callback?): Promise<T>
Returns information about a space.
Type Parameters
- T = ServerModels.Space
Parameters
- parameters: ServerParameters.GetSpace
- Optional callback: undefined
Returns Promise<T>
- Defined in server/space.ts:102

getSpaceProperties

getSpaceProperties<T>(parameters, callback): Promise<void>
Returns a paginated list of space properties.
Type Parameters
- T = Pagination<ServerModels.SpaceProperty>
Parameters
- parameters: ServerParameters.GetSpaceProperties
- callback: Callback<T>
Returns Promise<void>
- Defined in server/space.ts:216
getSpaceProperties<T>(parameters, callback?): Promise<T>
Returns a paginated list of space properties.
Type Parameters
- T = Pagination<ServerModels.SpaceProperty>
Parameters
- parameters: ServerParameters.GetSpaceProperties
- Optional callback: undefined
Returns Promise<T>
- Defined in server/space.ts:221

getSpaceProperty

getSpaceProperty<T>(parameters, callback): Promise<void>
Returns a paginated list of space properties.
Type Parameters
- T = ServerModels.SpaceProperty
Parameters
- parameters: ServerParameters.GetSpaceProperty
- callback: Callback<T>
Returns Promise<void>
- Defined in server/space.ts:269
getSpaceProperty<T>(parameters, callback?): Promise<T>
Returns a paginated list of space properties.
Type Parameters
- T = ServerModels.SpaceProperty
Parameters
- parameters: ServerParameters.GetSpaceProperty
- Optional callback: undefined
Returns Promise<T>
- Defined in server/space.ts:274

getSpaces

getSpaces<T>(parameters, callback): Promise<void>
Returns information about a number of spaces.
Type Parameters
- T = Pagination<ServerModels.Space>
Parameters
- parameters: undefined | ServerParameters.GetSpaces
- callback: Callback<T>
Returns Promise<void>
- Defined in server/space.ts:12
getSpaces<T>(parameters?, callback?): Promise<T>
Returns information about a number of spaces.
Type Parameters
- T = Pagination<ServerModels.Space>
Parameters
- Optional parameters: ServerParameters.GetSpaces
- Optional callback: undefined
Returns Promise<T>
- Defined in server/space.ts:17

updateSpace

updateSpace<T>(parameters, callback): Promise<void>
Updates a Space. Currently only the Space name, description and homepage can be updated.
Type Parameters
- T = ServerModels.Space
Parameters
- parameters: ServerParameters.UpdateSpace
- callback: Callback<T>
Returns Promise<void>
- Defined in server/space.ts:116
updateSpace<T>(parameters, callback?): Promise<T>
Updates a Space. Currently only the Space name, description and homepage can be updated.
Type Parameters
- T = ServerModels.Space
Parameters
- parameters: ServerParameters.UpdateSpace
- Optional callback: undefined
Returns Promise<T>
- Defined in server/space.ts:118

updateSpaceProperty

updateSpaceProperty<T>(parameters, callback): Promise<void>
Updates a space property. The body contains the representation of the space property. Must include new version number. If the given version number is 1, attempts to create a new space property, just like #create(String, com.atlassian.confluence.api.model.content.JsonSpaceProperty).
Type Parameters
- T = ServerModels.SpaceProperty
Parameters
- parameters: ServerParameters.UpdateSpaceProperty
- callback: Callback<T>
Returns Promise<void>
- Defined in server/space.ts:323
updateSpaceProperty<T>(parameters, callback?): Promise<T>
Updates a space property. The body contains the representation of the space property. Must include new version number. If the given version number is 1, attempts to create a new space property, just like #create(String, com.atlassian.confluence.api.model.content.JsonSpaceProperty).
Type Parameters
- T = ServerModels.SpaceProperty
Parameters
- parameters: ServerParameters.UpdateSpaceProperty
- Optional callback: undefined
Returns Promise<T>
- Defined in server/space.ts:332

Class Space

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Server.Space

Properties

Private client

Methods

createPrivateSpace

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

createSpace

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

createSpaceProperty

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

createSpacePropertyForKey

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deleteSpace

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deleteSpaceProperty

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getContentByType

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getContentForSpace

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getSpace

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getSpaceProperties

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

`Private` client