nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

How to fetch the Labels programmatically for a custom plugin in confluence

Vishal K S

How do I fetch all the labels for a page in confluence, through AJS? I can get it by going through the id of the labels, but is there an interface which gives all the labels of a particular page that I'm on?

The desired functionality is to get the labels, and perform some functionality based on the labels.

We have our confluence on a confluence server setup.

Accepted answers

Bill Bailey

Don't know about AJS, but there is a method and property, along the lines of:

$page.getLabels()

All comments

Davin Studer

You can use the REST API to get that info. The REST endpoint is ...

http(s)://{your server}/rest/api/content/{page id}/label

Vishal K S

Thanks Davin. But the problem is I don't want to be making API calls every time the javascript is called, it would be lots of API calls. Is there any other way to this?

Bill Bailey

Don't know about AJS, but there is a method and property, along the lines of:

$page.getLabels()

Vishal K S

Hey Bill, what exactly is this $page and how do I reference this? Do I get this in my javascript or is it a java object?

Bill Bailey

Well my area of quasi expertise is user macros, so velocity and java objects. So $page was just a reference to a content entity object. And the method is a part of the Confluence LabelManager.

So hoping I could point you in the right direction. I did find this exchange that might help point you in the right direction:

How-can-I-remove-a-label-from-a-page-using-the-javascript

Vishal K S

Ah, thanks a ton Bill. In this answer that you linked, the approach was to get it from the labels.

var labels = $(".aui-label-split-main");

The problem with this is, it would work in my current version, but in case we upgrade our confluence, they might end up changing their styles. But this is the closest to what I can get now, I believe.

So my aim is to read the labels and insert a particular message on the UI whenever any page is viewed. Correct me if I'm wrong, but the problem with using LabelManager for this is that to achieve this, I would need a "Pre Page View Event" to be triggered right?

Davin Studer

I would say if you don't want to use the API that they provide for this the only way that I know would be to parse the page DOM.

Davin Studer

If this is only an internal plugin another option would be to do something similar to what Bill has suggested. You could get the labels via velocity or java in a macro and include the macro on every page via the page decorator. The macro would simply output the labels as a JavaScript array. You would then have something reliable as to format.

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

confluence

server

confluence-server

developer

app

confluence-app

aui