- addAnonymousPermissionsToSpace(List, String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Give anonymous users the permissions {{permissions}} on the space with the key {{spaceKey}}.
- addAnonymousPermissionToSpace(String, String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Give anonymous users the permission {{permission}} on the space with the key {{spaceKey}}.
- addAttachment(long, Attachment, byte[]) - Method in class org.codehaus.swizzle.confluence.Confluence
-
add a new attachment to a content entity object.
- addAttchment(Confluence, Page, Attachment, URL) - Static method in class org.bsc.maven.plugin.confluence.ConfluenceUtils
-
- addAttchment(Confluence, Page, Attachment, File) - Static method in class org.bsc.maven.plugin.confluence.ConfluenceUtils
-
- addAttchment(Confluence, Page, Attachment, InputStream) - Static method in class org.bsc.maven.plugin.confluence.ConfluenceUtils
-
- addComment(Comment) - Method in class org.codehaus.swizzle.confluence.Confluence
-
adds a comment to the page.
- addGroup(String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
add a new group
- addLabelById(long, long) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Adds a label with the given ID to the object with the given ContentEntityObject ID.
- addLabelByName(String, long) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Adds a label to the object with the given ContentEntityObject ID.
- addLabelByNameToSpace(String, String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Adds a label to the object with the given ContentEntityObject ID.
- addLabelByObject(Label, long) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Adds the given label object to the object with the given ContentEntityObject ID.
- addPermissionsToSpace(List, String, String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Give the entity named {{remoteEntityName}} (either a group or a user) the permissions {{permissions}} on the space with the key {{spaceKey}}.
- addPermissionToSpace(String, String, String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Give the entity named {{remoteEntityName}} (either a group or a user) the permission {{permission}} on the space with the key {{spaceKey}}.
- addSpace(Space) - Method in class org.codehaus.swizzle.confluence.Confluence
-
create a new space, passing in name, key and description.
- addUser(User, String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
add a new user with the given password
- addUserToGroup(String, String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
add a user to a particular group
- Attachment - Class in org.codehaus.swizzle.confluence
-
- Attachment() - Constructor for class org.codehaus.swizzle.confluence.Attachment
-
- Attachment(Map) - Constructor for class org.codehaus.swizzle.confluence.Attachment
-
- getActiveUsers(boolean) - Method in class org.codehaus.swizzle.confluence.Confluence
-
returns all registered users as Strings
- getAncestors(String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
returns all the ancestors (as PageSummary instances) of this page (parent, parent's parent etc).
- getAttachment(String, String, String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
get information about an attachment.
- getAttachmentData(String, String, String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
get the contents of an attachment.
- getAttachments(String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
returns all the
Attachments for this page (useful to point users to download them with the full file download URL returned).
- getBlogEntries(String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
returns all the BlogEntrySummary instances in the space.
- getBlogEntry(String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
returns a single BlogEntry.
- getBlogEntryByDayAndTitle(String, int, String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Retrieves a blog post in the Space with the given spaceKey, with the title 'postTitle' and posted on the day 'dayOfMonth'.
- getBoolean(String) - Method in class org.codehaus.swizzle.confluence.MapObject
-
- getChildren(String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
returns all the direct children (as PageSummary instances) of this page.
- getComment() - Method in class org.codehaus.swizzle.confluence.Attachment
-
comment for the attachment {color:#cc3300}(Required){color}
- getComment(String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
returns an individual comment.
- getComments(String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
returns all the Comments for this page.
- getContentType() - Method in class org.codehaus.swizzle.confluence.Attachment
-
mime content type of the attachment {color:#cc0000}(Required){color}
- getCreated() - Method in class org.codehaus.swizzle.confluence.Attachment
-
creation date of the attachment
- getCreator() - Method in class org.codehaus.swizzle.confluence.Attachment
-
creator of the attachment
- getDate(String) - Method in class org.codehaus.swizzle.confluence.MapObject
-
- getDescendents(String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
returns all the descendents (as PageSummary instances) of this page (children, children's children etc).
- getFileName() - Method in class org.codehaus.swizzle.confluence.Attachment
-
file name of the attachment {color:#cc3300}(Required){color}
- getFileSize() - Method in class org.codehaus.swizzle.confluence.Attachment
-
numeric file size of the attachment in bytes
- getGroups() - Method in class org.codehaus.swizzle.confluence.Confluence
-
gets all groups as a list of
Strings
- getId() - Method in class org.codehaus.swizzle.confluence.Attachment
-
numeric id of the attachment
- getInt(String) - Method in class org.codehaus.swizzle.confluence.MapObject
-
- getLabelContentById(long) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Returns the content for a given label ID
- getLabelContentByName(String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Returns the content for a given label name.
- getLabelContentByObject(Label) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Returns the content for a given Label object.
- getLabelsByDetail(String, String, String, String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Retrieves the
Labels matching the given {{labelName}}, {{namespace}}, {{spaceKey}} or {{owner}}.
- getLabelsById(long) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Returns all
Labels for the given ContentEntityObject ID
- getList(String) - Method in class org.codehaus.swizzle.confluence.MapObject
-
- getMap(String) - Method in class org.codehaus.swizzle.confluence.MapObject
-
- getMostPopularLabels(int) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Returns the most popular
Labels for the Confluence instance, with a specified maximum number.
- getMostPopularLabelsInSpace(String, int) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Returns the most popular
Labels for the given {{spaceKey}}, with a specified maximum number of results.
- getOrCreatePage(Confluence, String, String, String) - Static method in class org.bsc.maven.plugin.confluence.ConfluenceUtils
-
- getOrCreatePage(Confluence, Page, String) - Static method in class org.bsc.maven.plugin.confluence.ConfluenceUtils
-
- getPage(PageSummary) - Method in class org.codehaus.swizzle.confluence.Confluence
-
returns a single Page
- getPage(String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
- getPage(String, String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
returns a single Page
- getPageHistory(String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
returns all the PageHistorySummary instances - useful for looking up the previous versions of a page, and who changed them.
- getPageId() - Method in class org.codehaus.swizzle.confluence.Attachment
-
page ID of the attachment
- getPagePermissions(String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Returns a List of
Permissions representing the permissions set on the given page.
- getPages(String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
returns all the PageSummary instances in the space.
- getPermissions(String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Returns a List of
Permissions representing the permissions the current user has for this space (a list of "view", "modify", "comment" and / or "admin").
- getPermissionsForUser(String, String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Returns a List of
Permissions representing the permissions the given user has for this space.
- getRecentlyUsedLabels(int) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Returns the recently used
Labels for the Confluence instance, with a specified maximum number of results.
- getRecentlyUsedLabelsInSpace(String, int) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Returns the recently used
Labels for the given {{spaceKey}}, with a specified maximum number of results.
- getRelatedLabels(String, int) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Returns the
Labels related to the given label name, with a specified maximum number of results.
- getRelatedLabelsInSpace(String, String, int) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Returns the
Labels related to the given label name for the given {{spaceKey}}, with a specified maximum number of results.
- getServerInfo() - Method in class org.codehaus.swizzle.confluence.Confluence
-
retrieve some basic information about the server being connected to.
- getServicePrefix() - Method in class org.codehaus.swizzle.confluence.Confluence
-
- getServicePrefix() - Method in class org.codehaus.swizzle.confluence.Confluence2
-
- getSpace(String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
returns a single Space.
- getSpaceLevelPermissions() - Method in class org.codehaus.swizzle.confluence.Confluence
-
returns List of the space level
Permissions which may be granted.
- getSpaces() - Method in class org.codehaus.swizzle.confluence.Confluence
-
returns all the SpaceSummary instances that the current user can see.
- getSpacesContainingContentWithLabel(String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Returns all Spaces that have content labelled with {{labelName}}.
- getSpacesWithLabel(String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Returns an array of Spaces that have been labelled with {{labelName}}.
- getString(String) - Method in class org.codehaus.swizzle.confluence.MapObject
-
- getTitle() - Method in class org.codehaus.swizzle.confluence.Attachment
-
title of the attachment
- getUrl() - Method in class org.codehaus.swizzle.confluence.Attachment
-
url to download the attachment online
- getUser(String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
get a single user
- getUserGroups(String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
get a user's current groups as a list of
Strings
- getUserInformation(String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Retrieves user information
- getVersion(Confluence) - Static method in class org.bsc.maven.plugin.confluence.ConfluenceUtils
-
- reactivateUser(String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
reactivates the specified user
- removeAllPermissionsForGroup(String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Remove all the global and space level permissions for {{groupname}}.
- removeAnonymousPermissionFromSpace(String, String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Remove the permission {{permission} from anonymous users on the space with the key {{spaceKey}}.
- removeAttachment(String, String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
remove an attachment from a content entity object.
- removeComment(String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
removes a comment from the page.
- removeGroup(String, String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
remove a group.
- removeLabelById(long, long) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Removes the label with the given ID from the object with the given ContentEntityObject ID.
- removeLabelByName(String, long) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Removes the given label from the object with the given ContentEntityObject ID.
- removeLabelByNameFromSpace(String, String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Removes the given label from the given {{spaceKey}}.
- removeLabelByObject(Label, long) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Removes the given label object from the object with the given ContentEntityObject ID.
- removePage(Confluence, String, String, String) - Static method in class org.bsc.maven.plugin.confluence.ConfluenceUtils
-
- removePage(Confluence, Page, String) - Static method in class org.bsc.maven.plugin.confluence.ConfluenceUtils
-
- removePage(String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
remove a page
- removePermissionFromSpace(String, String, String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Remove the permission {{permission} from the entity named {{remoteEntityName}} (either a group or a user) on the space with the key {{spaceKey}}.
- removeSpace(String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
remove a space completely.
- removeUser(String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
delete a user.
- removeUserFromGroup(String, String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
remove a user from a group.
- renderContent(String, String, String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
returns the HTML rendered content for this page.
- renderContent(String, String) - Method in class org.codehaus.swizzle.confluence.Confluence
-
- renderContent(PageSummary) - Method in class org.codehaus.swizzle.confluence.Confluence
-
- renderContent(String, String, String, Map) - Method in class org.codehaus.swizzle.confluence.Confluence
-
Like the above renderContent(), but you can supply an optional hash (map, dictionary, etc) containing additional instructions for the renderer.