Class ContentService

See

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

Hierarchy

CommonHttpService
- ContentService

Index

Constructors

Methods

convertContentIdsToContentTypes initialize

Constructors

constructor

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

Methods

convertContentIdsToContentTypes

convertContentIdsToContentTypes(params): Promise<ContentIdToContentTypeResponse>
Converts a list of content ids into their associated content types. This is useful for users migrating from v1 to v2 who may have stored just content ids without their associated type. This will return types as they should be used in v2. Notably, this will return inline-comment for inline comments and footer-comment for footer comments, which is distinct from them both being represented by comment in v1.

Permissions required: Permission to view the requested content. Any content that the user does not have permission to view or does not exist will map to null in the response.
Parameters
- params: {
      requestBody: {
          contentIds: (string | number)[];
      } & {
          [key: string]: unknown;
      };
  }
  - requestBody: {
    contentIds: (string | number)[];
    } & {
    [key: string]: unknown;
    }
Returns Promise<ContentIdToContentTypeResponse>
Returned if the requested content ids are successfully converted to their content types

Path
POST /content/convert-ids-to-types @scopes-current read:content.metadata:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content#api-content-convert-ids-to-types-post

`Protected` `Static`initialize

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

Returns void
Overrides CommonHttpService.initialize