Class LabelInfoService

See

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-label-info

Hierarchy

CommonHttpService
- LabelInfoService

Index

Constructors

Methods

getAllLabelContent initialize

Constructors

constructor

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

Methods

getAllLabelContent

getAllLabelContent(params): Promise<LabelDetails>
Returns label information and a list of contents associated with the label.

Permissions required: Permission to access the Confluence site ('Can use' global permission). Only contents that the user is permitted to view is returned.
Parameters
- params: {
      limit?: number;
      name: string;
      start?: number;
      type?:
          | "attachment"
          | "page"
          | "blogpost"
          | "page_template";
  }
  - Optionallimit?: number
    The number of results to be returned.
  - name: string
    Name of the label to query.
  - Optionalstart?: number
    The starting offset for the results.
  - Optionaltype?:
        | "attachment"
        | "page"
        | "blogpost"
        | "page_template"
    The type of contents that are to be returned.
Returns Promise<LabelDetails>
Returned if the query fetches zero or more results.

Path
GET /wiki/rest/api/label @scopes-current read:confluence-content.summary @scopes-beta read:label:confluence, read:content:confluence

See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-label-info#api-wiki-rest-api-label-get

`Protected` `Static`initialize

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

Returns void
Overrides CommonHttpService.initialize