Class ContentVersions

Index

Constructors

constructor

Methods

deleteContentVersion getContentVersion getContentVersions restoreContentVersion

Constructors

constructor

new ContentVersions(client: Client): ContentVersions
Parameters
- client: Client
Returns ContentVersions
- Defined in src/api/contentVersions.ts:8

Methods

deleteContentVersion

deleteContentVersion<T = void>(
parameters: DeleteContentVersion,
callback: Callback<T>,
): 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.
Type Parameters
- T = void
Parameters
- parameters: DeleteContentVersion
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/contentVersions.ts:124
deleteContentVersion<T = void>(
parameters: DeleteContentVersion,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = void
Parameters
- parameters: DeleteContentVersion
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/contentVersions.ts:134

getContentVersion

getContentVersion<T = Version>(
parameters: GetContentVersion,
callback: Callback<T>,
): Promise<void>
Returns a version for a piece of content.

Permissions required: Permission to view the content. If the content is a blog post, 'View' permission for the space is required.
Type Parameters
- T = Version
Parameters
- parameters: GetContentVersion
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/contentVersions.ts:92
getContentVersion<T = Version>(
parameters: GetContentVersion,
callback?: undefined,
): Promise<T>
Returns a version for a piece of content.

Permissions required: Permission to view the content. If the content is a blog post, 'View' permission for the space is required.
Type Parameters
- T = Version
Parameters
- parameters: GetContentVersion
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/contentVersions.ts:102

getContentVersions

getContentVersions<T = VersionArray>(
parameters: GetContentVersions,
callback: Callback<T>,
): Promise<void>
Returns the versions for a piece of content in descending order.

Permissions required: Permission to view the content. If the content is a blog post, 'View' permission for the space is required.
Type Parameters
- T = VersionArray
Parameters
- parameters: GetContentVersions
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/contentVersions.ts:16
getContentVersions<T = VersionArray>(
parameters: GetContentVersions,
callback?: undefined,
): Promise<T>
Returns the versions for a piece of content in descending order.

Permissions required: Permission to view the content. If the content is a blog post, 'View' permission for the space is required.
Type Parameters
- T = VersionArray
Parameters
- parameters: GetContentVersions
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/contentVersions.ts:26

restoreContentVersion

restoreContentVersion<T = Version>(
parameters: RestoreContentVersion,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = Version
Parameters
- parameters: RestoreContentVersion
- callback: Callback<T>
Returns Promise<void>
- Defined in src/api/contentVersions.ts:53
restoreContentVersion<T = Version>(
parameters: RestoreContentVersion,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Version
Parameters
- parameters: RestoreContentVersion
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/api/contentVersions.ts:63

Class ContentVersions

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ContentVersions

Methods

deleteContentVersion

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getContentVersion

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getContentVersions

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

restoreContentVersion

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page