Rate this page:
A Confluence specific JavaScript module which provides functions to interact with the macro editor.
Save a macro with data that can be accessed when viewing the confluence page.
Name | Type | Description |
---|---|---|
macroParameters | Object | data to be saved with the macro. |
macroBody | String | the macro body to be saved with the macro. If omitted, the existing body will remain untouched. |
1 2 3
AP.confluence.saveMacro({foo: 'bar'});
AP.confluence.saveMacro({foo: 'bar'}, "a new macro body");
Closes the macro editor, if it is open.
This call does not save any modified parameters to the macro, and saveMacro should be called first if necessary.
1
AP.confluence.closeMacroEditor();
Get the data saved in the saveMacro method.
Name | Type | Description |
---|---|---|
callback | function | callback to be passed the macro data. |
1 2 3
AP.confluence.getMacroData(function(data){
alert(data);
});
Get the body saved in the saveMacro method.
Name | Type | Description |
---|---|---|
callback | function | callback to be passed the macro data. |
1 2 3
AP.confluence.getMacroBody(function(body){
alert(body);
});
Provide handlers for property panel control events
Event name components:
control-key
: "key" property provided for the custom control declared in the JSON descriptorevent-type
: type of user interaction, as described belowmacro-key
: "key" property provided for the macro declared in the JSON descriptorEvent types:
click
: the property panel control was clicked by the userName | Type | Description |
---|---|---|
eventBindings | Object | An object which specifies property panel events as keys and handler functions as values. The handler does not take any arguments. |
1 2 3 4 5 6
AP.confluence.onMacroPropertyPanelEvent({
"{event-type}.{control-key}.{macro-key}.macro.property-panel": function() {
// handle button click
AP.confluence.closePropertyPanel();
}
});
Closes the macro property panel, if it is open.
1
AP.confluence.closeMacroPropertyPanel();
Provides the Content Property with the given key, on the current Content, to the callback.
Name | Type | Description |
---|---|---|
key | String | the key of the property to retrieve |
callback | function | callback to be passed the content property |
1 2 3
AP.confluence.getContentProperty('propertyKey', function(property) {
alert(property);
});
Sets the provided Content Property against the current Content, sending the result to the callback.
Name | Type | Description |
---|---|---|
contentProperty | confluence~ContentProperty | the content property to create or update |
callback | function | callback to be passed the result |
1 2 3 4 5 6 7 8 9 10
AP.confluence.setContentProperty({
key: 'propertyKey',
value: 'propertyValue',
version: {
number: 2
}
}, function(result) {
alert(result.property); // the updated property, if successful
alert(result.error); // if unsuccessful, the reason for the failure
});
Raise contentProperty.update event for the Content Property with the given key on the current Content. It also provide content property to the callback like getContentProperty does.
Name | Type | Description |
---|---|---|
key | String | the key of the property to retrieve |
callback | function | callback to be passed the content property |
1 2 3
AP.confluence.syncPropertyFromServer('propertyKey', function(property) {
alert(property);
});
Rate this page: