Skip to content

Latest commit

 

History

History
265 lines (191 loc) · 7.79 KB

api.md

File metadata and controls

265 lines (191 loc) · 7.79 KB
Raw

Classes

Confluence

Members

request

Node.js wrapper for Atlassian's Confluence API. See https://developer.atlassian.com/confdev/confluence-rest-api

Copyright (c) 2015, John Duane Released under the MIT License

Confluence

Kind: global class
this: {Confluence}

new Confluence(config)

Construct Confluence.

Param Type Description
config Object
config.username string
config.password string
config.baseUrl string
config.version number Optional

confluence.getSpace(space, callback)

Get space information.

Kind: instance method of Confluence

Param Type
space string
callback function

confluence.getSpaceHomePage(space, callback)

Get space home page.

Kind: instance method of Confluence

Param Type
space string
callback function

confluence.getContentById(id, callback)

Get stored content for a specific space and page title.

Kind: instance method of Confluence

Param Type
id string
callback function

confluence.getCustomContentById(options, callback)

Get stored content for a specific page id with optional custom expanders.

Kind: instance method of Confluence

Param Type Description
options object for the custom content request
callback function

confluence.getContentByPageTitle(space, title, callback)

Get stored content for a specific space and page title.

Kind: instance method of Confluence

Param Type
space string
title string
callback function

confluence.postContent(space, title, content, parentId, callback, representation)

Post content to a new page.

Kind: instance method of Confluence

Param Type Description
space string
title string
content string
parentId number A null value will cause the page to be added under the space's home page
callback function
representation string Optional

confluence.putContent(space, id, version, title, content, callback, minorEdit, representation)

Put/update stored content for a page.

Kind: instance method of Confluence

Param Type Description
space string
id string
version number
title string
content string
callback function
minorEdit boolean Optional
representation string Optional

confluence.deleteContent(id, callback)

Delete a page.

Kind: instance method of Confluence

Param Type
id string
callback function

confluence.getAttachments(space, id, callback)

Get attachments

Kind: instance method of Confluence

Param Type
space string
id string
callback function

confluence.createAttachment(space, id, filepath, callback)

This allows you to post attachments to the pages you create.

Kind: instance method of Confluence

Param Type Description
space string
id string
filepath string absolute path of the file you are sending
callback function

confluence.updateAttachmentData(space, id, attachmentId, filepath, callback)

This allows you to update posted attachments data

Kind: instance method of Confluence

Param Type
space string
id string
attachmentId string
filepath string
callback function

confluence.getLabels(id, callback)

Get labels from content

Kind: instance method of Confluence

Param Type
id string
callback function

confluence.postLabels(id, labels, callback)

Post content labels to a existing page.

Kind: instance method of Confluence

Param Type
id string
labels Array.<{prefix:string, name:string}>
callback function

confluence.deleteLabel(id, label, callback)

Delete a label from a page.

Kind: instance method of Confluence

Param Type
id string
label string
callback function

confluence.search(query, callback)

Search by query

Kind: instance method of Confluence

Param Type
query string
callback function

request

Node.js wrapper for Atlassian's Confluence API. See https://developer.atlassian.com/confdev/confluence-rest-api

Copyright (c) 2015, John Duane Released under the MIT License

Kind: global variable