Class ContentVersionsService

See

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-versions

Hierarchy

CommonHttpService
- ContentVersionsService

Index

Constructors

Methods

deleteContentVersion restoreContentVersion initialize

Constructors

constructor

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

Methods

deleteContentVersion

deleteContentVersion(params): Promise<void>
Delete a historical version. This does not delete the changes made to the content in that version, rather the changes for the deleted version are rolled up into the next version. Note, you cannot delete the current version.

Permissions required: Permission to update the content.
Parameters
- params: {
  id: string;
  versionNumber: number;
  }
  - id: string
    The ID of the content that the version will be deleted from.
  - versionNumber: number
    The number of the version to be deleted. The version number starts from 1 up to current version.
Returns Promise<void>
Path
DELETE /wiki/rest/api/content/{id}/version/{versionNumber} @scopes-current write:confluence-content @scopes-beta delete:content:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-versions#api-wiki-rest-api-content-id-version-versionnumber-delete

restoreContentVersion

restoreContentVersion(params): Promise<null | VersionV1>
Restores a historical version to be the latest version. That is, a new version is created with the content of the historical version.

Permissions required: Permission to update the content.
Parameters
- params: {
      expand?: string[];
      id: string;
      versionRestore: VersionRestore;
  }
  - Optionalexpand?: string[]
    A multi-value parameter indicating which properties of the content to expand. By default, the content object is expanded.
    
    collaborators returns the users that collaborated on the version.
    
    content returns the content for the version.
  - id: string
    The ID of the content for which the history will be restored.
  - versionRestore: VersionRestore
    The content version to be restored.
Returns Promise<null | VersionV1>
Returned if the version is restored.

Path
POST /wiki/rest/api/content/{id}/version @scopes-current write:confluence-content @scopes-beta read:content-details:confluence, write:content:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-versions#api-wiki-rest-api-content-id-version-post

`Protected` `Static`initialize

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

Returns void
Overrides CommonHttpService.initialize