com.atlassian.confluence.spaces.SpaceManager |
Known Indirect Subclasses |
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | GLOBAL_LOGO |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates a personal space.
| |||||||||||
If the given Space does not have a description, creates one for it, and saves it.
| |||||||||||
Get the number of pages in a space.
| |||||||||||
Finds all spaces in Confluence, of any type, sorted alphabetically by space name.
| |||||||||||
Get a list of spaces specified by the
SpacesQuery . | |||||||||||
This method is deprecated.
since 3.1 Use
getSpaces(SpacesQuery) instead
| |||||||||||
Get the number of blog posts in a space.
| |||||||||||
Get the number of archived emails in a space.
| |||||||||||
This method is deprecated.
since 3.1 Use
getSpaces(SpacesQuery) instead
| |||||||||||
This method is deprecated.
since 3.1 Use
getSpaces(SpacesQuery) instead
| |||||||||||
This method is deprecated.
since 3.1 Use
getSpaces(SpacesQuery) instead
| |||||||||||
Get the personal space of the given user.
| |||||||||||
Get the personal space for the user with the given username
| |||||||||||
Retrieve a space by its key.
| |||||||||||
Retrieve a space by its ID.
| |||||||||||
Get the key for a space from its pageId in a single db call
| |||||||||||
Get a list of spaces specified by the
SpacesQuery limited by the offset and maxResults. | |||||||||||
This method is deprecated.
since 3.1 Use
getSpaces(SpacesQuery) instead
| |||||||||||
Returns
Page s that are either created or edited by the specified user | |||||||||||
This method is deprecated.
since 3.1 Use
getSpaces(SpacesQuery) instead
| |||||||||||
This method is deprecated.
since 3.1 Use
getSpaces(SpacesQuery) instead
| |||||||||||
Removes a space with a given spaceKey (case sensitive).
| |||||||||||
Creates a personal space. The difference to a normal space are that this space will have a type "personal" and the user passed to this space should not be the creator, but is the owner of the space.
If the given Space does not have a description, creates one for it, and saves it.
This is required for CONF-4080, because labels on a Space are attached to a Space Description.
space | an existing space. Not null. |
---|
Get the number of pages in a space. This counts all pages, including non-current versions, and including pages that are in the trash. As such, it probably doesn't do what you think it does.
space | the space to count pages in |
---|
Finds all spaces in Confluence, of any type, sorted alphabetically by space name.
Get a list of spaces specified by the SpacesQuery
. Any code that calls this method is a potential
performance problem. The method may be deprecated and removed in a future version of Confluence. Use
getSpaces(SpacesQuery)
to retrieve pages of results instead.
This method is deprecated.
since 3.1 Use getSpaces(SpacesQuery)
instead
Return all spaces of a given type in which the user can create or edit pages
user | the user to check permissions against, or null for the anonymous user |
---|---|
type | the type of space to return |
Get the number of blog posts in a space. This counts all news, including non-current versions, and including news that is in the trash. As such, it probably doesn't do what you think it does.
space | the space to count pages in |
---|
Get the number of archived emails in a space. This counts all mail, including mail that is in the trash. As such, it probably doesn't do what you think it does.
space | the space to count mail in |
---|
This method is deprecated.
since 3.1 Use getSpaces(SpacesQuery)
instead
Return all spaces for which the the user has VIEW permission.
user | the user to check permissions against, or null for the anonymous user |
---|
This method is deprecated.
since 3.1 Use getSpaces(SpacesQuery)
instead
Return all spaces of a given type for which the user has VIEW permission.
user | the user to check permissions against, or null for the anonymous user |
---|---|
type | the type of space to return |
This method is deprecated.
since 3.1 Use getSpaces(SpacesQuery)
instead
Return all spaces within a given spaceGroup for which the user has VIEW permission
user | the user to check permissions against, or null for the anonymous user |
---|---|
spaceGroup | the spaceGroup from which we query the spaces |
Get the personal space of the given user. This method may be more convenient than
getPersonalSpace(String)
, as it behaves gracefully when the user is anonymous
(i.e. null). Where the user is not null, this method is the equivalent of
getPersonalSpace(user.getName())
.
user | the user to get the space for. If user is null, the method will return null |
---|
Get the personal space for the user with the given username
username | the username of the user to get the personal space of |
---|
Retrieve a space by its key. The space can be of any type.
spaceKey | the space key of the space to retrieve |
---|
Retrieve a space by its ID. The space can be of any type.
id | the ID of the space |
---|
Get the key for a space from its pageId in a single db call
pageId | the id of the page to look for |
---|
Get a list of spaces specified by the SpacesQuery
limited by the offset and maxResults.
This method is deprecated.
since 3.1 Use getSpaces(SpacesQuery)
instead
Return all spaces in which the user can create or edit pages.
user | the user to check permissions against, or null for the anonymous user |
---|
Removes a space with a given spaceKey (case sensitive). This must be passed a progress monitor which will be updated with internationalised status while the space is being removed. Ideally this should be done from a long running task, since it can be very slow.
spaceKey | the key of the space to remove |
---|---|
progressMeter | will be updated with status messages and percentage completed. Not Null. |