A B C D E F G H I K L M N O P R S T U V W

A

AbstractModelMetadataProvider - Class in com.atlassian.confluence.api.extension

Metadata provider with common code for supplying expand stubs.

AbstractModelMetadataProvider() - Constructor for class com.atlassian.confluence.api.extension.AbstractModelMetadataProvider

add(T) - Method in class com.atlassian.confluence.api.model.pagination.PageResponseImpl.Builder

addAll(Iterable<T>) - Method in class com.atlassian.confluence.api.model.pagination.PageResponseImpl.Builder

addItems(WebItemView...) - Method in class com.atlassian.confluence.api.model.web.WebSectionView.Builder

addItems(Iterable<WebItemView>) - Method in class com.atlassian.confluence.api.model.web.WebSectionView.Builder

ancestors(Iterable<ContentLink>) - Method in class com.atlassian.confluence.api.model.content.Content.ContentBuilder

Anonymous - Class in com.atlassian.confluence.api.model.people

Anonymous(Icon) - Constructor for class com.atlassian.confluence.api.model.people.Anonymous

ApiSerializerModuleFactory - Class in com.atlassian.confluence.api.serialization

Create a serializer module factory to allow api model objects to be serialized.

ApiSerializerModuleFactory() - Constructor for class com.atlassian.confluence.api.serialization.ApiSerializerModuleFactory

B

BadRequestException - Exception in com.atlassian.confluence.api.service.exceptions

Thrown when the data in the incoming request is incomplete or otherwise invalid.

BadRequestException() - Constructor for exception com.atlassian.confluence.api.service.exceptions.BadRequestException

BadRequestException(String) - Constructor for exception com.atlassian.confluence.api.service.exceptions.BadRequestException

BadRequestException(Throwable) - Constructor for exception com.atlassian.confluence.api.service.exceptions.BadRequestException

BadRequestException(String, Throwable) - Constructor for exception com.atlassian.confluence.api.service.exceptions.BadRequestException

BadRequestException(String, ValidationResult) - Constructor for exception com.atlassian.confluence.api.service.exceptions.BadRequestException

BLOG_POST - Static variable in class com.atlassian.confluence.api.model.content.ContentType

body(String, ContentRepresentation) - Method in class com.atlassian.confluence.api.model.content.Content.ContentBuilder

body(Map<ContentRepresentation, ContentBody>) - Method in class com.atlassian.confluence.api.model.content.Content.ContentBuilder

body(String) - Method in class com.atlassian.confluence.api.model.content.Macro.MacroBuilder

build() - Method in class com.atlassian.confluence.api.model.content.Content.ContentBuilder

build() - Method in class com.atlassian.confluence.api.model.content.History.HistoryBuilder

build() - Method in class com.atlassian.confluence.api.model.content.Macro.MacroBuilder

build() - Method in class com.atlassian.confluence.api.model.content.Space.SpaceBuilder

build() - Method in class com.atlassian.confluence.api.model.content.Version.VersionBuilder

build() - Method in class com.atlassian.confluence.api.model.pagination.PageResponseImpl.Builder

builder() - Static method in class com.atlassian.confluence.api.model.content.Content

Returns a Content.ContentBuilder instance that can be used to create a new Content object.

builder(ContentType) - Static method in class com.atlassian.confluence.api.model.content.Content

Returns a Content.ContentBuilder instance that can be used to create a new Content object.

builder(Content) - Static method in class com.atlassian.confluence.api.model.content.Content

Returns a Content.ContentBuilder instance that clones an existing Content object.

builder() - Static method in class com.atlassian.confluence.api.model.content.History

builder() - Static method in class com.atlassian.confluence.api.model.content.Macro

builder() - Static method in class com.atlassian.confluence.api.model.content.Space

Returns a Space.SpaceBuilder instance that can be used to create a new Space object.

builder() - Static method in class com.atlassian.confluence.api.model.content.Version

Returns a Version.VersionBuilder instance that can be used to create a new Version object.

builder() - Static method in class com.atlassian.confluence.api.model.locator.ContentLocator

BuilderUtils - Class in com.atlassian.confluence.api.model.reference

A wrapper around ImmutableList builder that produces immutable lists if elements are added to the builder or a collapsed list otherwise.

BuilderUtils() - Constructor for class com.atlassian.confluence.api.model.reference.BuilderUtils

buildReference(String) - Static method in class com.atlassian.confluence.api.model.content.Content

buildReference(Reference<Content>) - Static method in class com.atlassian.confluence.api.model.content.History

buildReference(String) - Static method in class com.atlassian.confluence.api.model.content.Space

builds a collapsed reference to the space with the given spaceKey

buildReference(Reference<Content>, int) - Static method in class com.atlassian.confluence.api.model.content.Version

by(Person) - Method in class com.atlassian.confluence.api.model.content.Version.VersionBuilder

bySpaceKeyAndTitle(String, String) - Method in class com.atlassian.confluence.api.model.locator.ContentLocatorBuilder.PageLocatorBuilder

bySpaceKeyTitleAndPostingDay(String, String, LocalDate) - Method in class com.atlassian.confluence.api.model.locator.ContentLocatorBuilder.BlogLocatorBuilder

C

canExpand(String) - Method in class com.atlassian.confluence.api.model.Expansions

Collapsed - Interface in com.atlassian.confluence.api.model.reference

A marker interface indicating an object is a placeholder for properties in our model that have not been expanded.

collapsed(T) - Static method in class com.atlassian.confluence.api.model.reference.Reference

create a collapse reference to the given object

collapsed(Class, Map) - Static method in class com.atlassian.confluence.api.model.reference.Reference

Collapsed.Exceptions - Class in com.atlassian.confluence.api.model.reference

Attempting to access a property of a collapsed object should throw an exception, indicating that it was not in the original request.

Collapsed.Exceptions() - Constructor for class com.atlassian.confluence.api.model.reference.Collapsed.Exceptions

CollapsedReference<T> - Class in com.atlassian.confluence.api.model.reference

A collapsed reference is a property that potentially has a value, but the property's value has not been expanded at the time fo the request.

com.atlassian.confluence.api.extension - package com.atlassian.confluence.api.extension

com.atlassian.confluence.api.model - package com.atlassian.confluence.api.model

com.atlassian.confluence.api.model.content - package com.atlassian.confluence.api.model.content

com.atlassian.confluence.api.model.locator - package com.atlassian.confluence.api.model.locator

com.atlassian.confluence.api.model.messages - package com.atlassian.confluence.api.model.messages

com.atlassian.confluence.api.model.pagination - package com.atlassian.confluence.api.model.pagination

com.atlassian.confluence.api.model.people - package com.atlassian.confluence.api.model.people

com.atlassian.confluence.api.model.reference - package com.atlassian.confluence.api.model.reference

com.atlassian.confluence.api.model.validation - package com.atlassian.confluence.api.model.validation

com.atlassian.confluence.api.model.web - package com.atlassian.confluence.api.model.web

com.atlassian.confluence.api.serialization - package com.atlassian.confluence.api.serialization

com.atlassian.confluence.api.service.content - package com.atlassian.confluence.api.service.content

com.atlassian.confluence.api.service.exceptions - package com.atlassian.confluence.api.service.exceptions

com.atlassian.confluence.api.service.pagination - package com.atlassian.confluence.api.service.pagination

com.atlassian.confluence.api.service.web - package com.atlassian.confluence.api.service.web

COMMENT - Static variable in class com.atlassian.confluence.api.model.content.ContentType

ConflictException - Exception in com.atlassian.confluence.api.service.exceptions

Thrown when an UPDATE request is made with a stale version number.

ConflictException() - Constructor for exception com.atlassian.confluence.api.service.exceptions.ConflictException

ConflictException(String) - Constructor for exception com.atlassian.confluence.api.service.exceptions.ConflictException

ConflictException(String, Throwable) - Constructor for exception com.atlassian.confluence.api.service.exceptions.ConflictException

Container - Interface in com.atlassian.confluence.api.model.content

A Model object that can hold one or more other objects.

container(Container) - Method in class com.atlassian.confluence.api.model.content.Content.ContentBuilder

Content - Class in com.atlassian.confluence.api.model.content

Represents all the different kinds of content that can be housed in Confluence: pages, blog posts, comments and so on.

content(Reference<Content>) - Method in class com.atlassian.confluence.api.model.content.History.HistoryBuilder

Content.ContentBuilder - Class in com.atlassian.confluence.api.model.content

Builds Content objects.

Content.ContentBuilder(ContentType) - Constructor for class com.atlassian.confluence.api.model.content.Content.ContentBuilder

Create new builders with Content.builder(ContentType).

ContentBody - Class in com.atlassian.confluence.api.model.content

ContentBody(ContentRepresentation, String, Reference<Content>) - Constructor for class com.atlassian.confluence.api.model.content.ContentBody

ContentBody(ContentRepresentation, String, String) - Constructor for class com.atlassian.confluence.api.model.content.ContentBody

ContentBody(ContentRepresentation, String) - Constructor for class com.atlassian.confluence.api.model.content.ContentBody

ContentBodyConversionService - Interface in com.atlassian.confluence.api.service.content

Provides methods for converting ContentBody instances to other ContentRepresentations.

ContentLink - Class in com.atlassian.confluence.api.model.content

Enough information to link to a piece of content.

ContentLink(String, Reference<Space>, ContentType, String, String) - Constructor for class com.atlassian.confluence.api.model.content.ContentLink

ContentLocator - Class in com.atlassian.confluence.api.model.locator

Criteria for looking up a piece of content.

ContentLocatorBuilder - Class in com.atlassian.confluence.api.model.locator

Builder that ensures ContentLocator instances are only constructed in ways that allow the ContentService to find the content in question.

ContentLocatorBuilder.BlogLocatorBuilder - Class in com.atlassian.confluence.api.model.locator

ContentLocatorBuilder.PageLocatorBuilder - Class in com.atlassian.confluence.api.model.locator

ContentRepresentation - Enum in com.atlassian.confluence.api.model.content

Enumeration of the different built-in ways that Confluence content bodies can be represented.

ContentService - Interface in com.atlassian.confluence.api.service.content

Provides methods for creating, reading, updating and deleting Confluence Content objects such as Pages, BlogPosts and Comments.

ContentType - Class in com.atlassian.confluence.api.model.content

Represents a type of content.

convert(ContentBody, ContentRepresentation) - Method in interface com.atlassian.confluence.api.service.content.ContentBodyConversionService

Convert a ContentBody value into another format, performing validation during the conversion.

convertBody(Content, ContentRepresentation) - Method in interface com.atlassian.confluence.api.service.content.ContentBodyConversionService

Convert the single ContentBody value in a Content body map into another format, performing validation during the conversion.

convertsFromStorage() - Method in enum com.atlassian.confluence.api.model.content.ContentRepresentation

convertsToStorage() - Method in enum com.atlassian.confluence.api.model.content.ContentRepresentation

create(String, String, String, int) - Method in class com.atlassian.confluence.api.model.web.WebItemView.Builder

create(String) - Method in class com.atlassian.confluence.api.model.web.WebPanelView.Builder

create(String, String) - Method in class com.atlassian.confluence.api.model.web.WebSectionView.Builder

create() - Static method in class com.atlassian.confluence.api.serialization.ApiSerializerModuleFactory

create(Content) - Method in interface com.atlassian.confluence.api.service.content.ContentService

Create a piece of content.

createdBy(Person) - Method in class com.atlassian.confluence.api.model.content.History.HistoryBuilder

createdDate(Date) - Method in class com.atlassian.confluence.api.model.content.History.HistoryBuilder

D

delete(Content) - Method in interface com.atlassian.confluence.api.service.content.ContentService

Removes an item of Content from the system.

description(String) - Method in class com.atlassian.confluence.api.model.content.Space.SpaceBuilder

description(Option<String>) - Method in class com.atlassian.confluence.api.model.content.Space.SpaceBuilder

doPaginationRequest(LimitedRequest, PaginationBatch<H>, Function<? super H, M>) - Method in interface com.atlassian.confluence.api.service.pagination.PaginationService

Perform a pagination request, this will execute the fetchBatch function as many times as necessary to retrieve the page of results.

E

EMPTY - Static variable in class com.atlassian.confluence.api.model.Expansions

empty(boolean) - Static method in class com.atlassian.confluence.api.model.pagination.PageResponseImpl

empty(Class<T>) - Static method in class com.atlassian.confluence.api.model.reference.Reference

create an empty reference to the given class

emptyBody(ContentRepresentation, Reference<Content>) - Static method in class com.atlassian.confluence.api.model.content.ContentBody

EmptyReference<T> - Class in com.atlassian.confluence.api.model.reference

A null object reference, indicates that the referenced property is empty.

exists() - Method in class com.atlassian.confluence.api.model.reference.CollapsedReference

exists() - Method in class com.atlassian.confluence.api.model.reference.EmptyReference

An empty references value does not exist

exists() - Method in class com.atlassian.confluence.api.model.reference.ExpandedReference

exists() - Method in class com.atlassian.confluence.api.model.reference.Reference

ExpandedReference<T> - Class in com.atlassian.confluence.api.model.reference

An expanded reference has a value, call get() will return that referent value.

Expansion - Class in com.atlassian.confluence.api.model

Expansion(String) - Constructor for class com.atlassian.confluence.api.model.Expansion

Expansion(String, Expansions) - Constructor for class com.atlassian.confluence.api.model.Expansion

Expansions - Class in com.atlassian.confluence.api.model

Expansions(Expansion...) - Constructor for class com.atlassian.confluence.api.model.Expansions

Expansions(Iterable<Expansion>) - Constructor for class com.atlassian.confluence.api.model.Expansions

F

FieldValidationError - Interface in com.atlassian.confluence.api.model.validation

Represents a ValidationError that is associated with a field of user input.

find(ContentLocator, Expansion...) - Method in interface com.atlassian.confluence.api.service.content.ContentService

Retrieve a piece of content by some more complex criteria (defined by the ContentLocator).

findById(String, Expansion...) - Method in interface com.atlassian.confluence.api.service.content.ContentService

Retrieve a piece of content by its id.

findMacro(String, String, String, Expansion...) - Method in interface com.atlassian.confluence.api.service.content.ContentService

Retrieve details about a macro matching the page, version and macro hash.

forBlog() - Method in class com.atlassian.confluence.api.model.locator.ContentLocatorBuilder

Build a content locator for a Blog post.

forContent(String) - Method in interface com.atlassian.confluence.api.service.web.WebViewService

Provides a new WebView.

forName(String) - Static method in class com.atlassian.confluence.api.model.content.ContentType

forPage() - Method in class com.atlassian.confluence.api.model.locator.ContentLocatorBuilder

Build a content locator for a Page.

forSpace(String) - Method in interface com.atlassian.confluence.api.service.web.WebViewService

from(Iterable<T>, boolean) - Static method in class com.atlassian.confluence.api.model.pagination.PageResponseImpl

G

get() - Method in class com.atlassian.confluence.api.model.reference.CollapsedReference

get() - Method in class com.atlassian.confluence.api.model.reference.EmptyReference

Always returns null, the referent object is never defined for an EmptyReference

get() - Method in class com.atlassian.confluence.api.model.reference.ExpandedReference

get() - Method in class com.atlassian.confluence.api.model.reference.Reference

getAccessKey() - Method in class com.atlassian.confluence.api.model.web.WebItemView

getAncestors() - Method in class com.atlassian.confluence.api.model.content.Content

getApiDeserializers() - Static method in class com.atlassian.confluence.api.serialization.ApiSerializerModuleFactory

getApiSerializers() - Static method in class com.atlassian.confluence.api.serialization.ApiSerializerModuleFactory

getArgs() - Method in interface com.atlassian.confluence.api.model.messages.Message

getBody() - Method in class com.atlassian.confluence.api.model.content.Content

getBody() - Method in class com.atlassian.confluence.api.model.content.Macro

getBodyToConvert(Content, ContentRepresentation) - Method in interface com.atlassian.confluence.api.service.content.ContentBodyConversionService

Given a Content object for which the body could be converted to a given ContentRepresentation, returns the ContentBody that would be used for the conversion.

getBy() - Method in class com.atlassian.confluence.api.model.content.Version

getContainer() - Method in class com.atlassian.confluence.api.model.content.Content

Returns the container for this Content, which for Pages and Blog Posts will be the Space, and for Comments the Page or BlogPost.

getContainerType() - Method in class com.atlassian.confluence.api.model.content.Content

getContent(Space, PageRequest, Expansion...) - Method in interface com.atlassian.confluence.api.service.content.SpaceService

Retrieve the top level content contained in this space.

getContentId(Reference<Content>) - Static method in class com.atlassian.confluence.api.model.content.Content

get the content id from the Reference to a piece of content

getContentParentRef() - Method in class com.atlassian.confluence.api.model.content.History

getContentRef() - Method in class com.atlassian.confluence.api.model.content.ContentBody

getContentTypes() - Method in class com.atlassian.confluence.api.model.locator.ContentLocator

getCreatedBy() - Method in class com.atlassian.confluence.api.model.content.History

getCreatedDate() - Method in class com.atlassian.confluence.api.model.content.History

getDescription() - Method in class com.atlassian.confluence.api.model.content.Space

getDisplayName() - Method in class com.atlassian.confluence.api.model.people.KnownUser

getErrors() - Method in interface com.atlassian.confluence.api.model.validation.ValidationResult

getFieldName() - Method in interface com.atlassian.confluence.api.model.validation.FieldValidationError

getHeight() - Method in class com.atlassian.confluence.api.model.web.Icon

getHistory() - Method in class com.atlassian.confluence.api.model.content.Content

getHistoryRef() - Method in class com.atlassian.confluence.api.model.content.Content

getHtml() - Method in class com.atlassian.confluence.api.model.web.WebPanelView

getIcon() - Method in class com.atlassian.confluence.api.model.content.Space

getIcon() - Method in class com.atlassian.confluence.api.model.web.WebItemView

getId() - Method in class com.atlassian.confluence.api.model.content.Content

getId() - Method in class com.atlassian.confluence.api.model.content.ContentLink

getId() - Method in class com.atlassian.confluence.api.model.content.Label

getId() - Method in class com.atlassian.confluence.api.model.content.Space

getId() - Method in class com.atlassian.confluence.api.model.web.WebItemView

getId() - Method in class com.atlassian.confluence.api.model.web.WebSectionView

getIdProperties() - Method in class com.atlassian.confluence.api.model.reference.CollapsedReference

getIdProperties() - Method in class com.atlassian.confluence.api.model.reference.EmptyReference

getIdProperties() - Method in class com.atlassian.confluence.api.model.reference.ExpandedReference

getIdProperties() - Method in class com.atlassian.confluence.api.model.reference.Reference

A map of properties key by the idProperty enum in the model class for the referent object.

getIdProperty(Enum) - Method in class com.atlassian.confluence.api.model.reference.Reference

getIsDefault() - Method in class com.atlassian.confluence.api.model.web.Icon

getItemsForSection(String, Map<String, Object>) - Method in interface com.atlassian.confluence.api.service.web.WebView

getKey() - Method in class com.atlassian.confluence.api.model.content.Space

getKey() - Method in interface com.atlassian.confluence.api.model.messages.Message

getKey() - Method in class com.atlassian.confluence.api.model.web.WebItemView

getLabel() - Method in class com.atlassian.confluence.api.model.content.Label

getLabel() - Method in class com.atlassian.confluence.api.model.web.WebItemView

getLabel() - Method in class com.atlassian.confluence.api.model.web.WebSectionView

getLastUpdated() - Method in class com.atlassian.confluence.api.model.content.History

getLimit() - Method in interface com.atlassian.confluence.api.model.pagination.LimitedRequest

getLimit() - Method in interface com.atlassian.confluence.api.model.pagination.PageRequest

getLimit() - Method in class com.atlassian.confluence.api.model.pagination.SimplePageRequest

getLinks() - Method in class com.atlassian.confluence.api.model.web.WebSectionView

getLinkUrl() - Method in class com.atlassian.confluence.api.model.web.WebItemView

getMaxLimit() - Method in interface com.atlassian.confluence.api.model.pagination.LimitedRequest

getMessage() - Method in class com.atlassian.confluence.api.model.content.Version

getMessage() - Method in interface com.atlassian.confluence.api.model.validation.ValidationError

getMetadata(Object, Expansions) - Method in class com.atlassian.confluence.api.extension.AbstractModelMetadataProvider

getMetadata(Object, Expansions) - Method in interface com.atlassian.confluence.api.extension.ModelMetadataProvider

Returns keyed metadata based on the passed entity and the expansions.

getMetadata() - Method in class com.atlassian.confluence.api.model.content.Content

getName() - Method in class com.atlassian.confluence.api.model.content.Macro

getName() - Method in class com.atlassian.confluence.api.model.content.Space

getNeeded() - Method in interface com.atlassian.confluence.api.model.pagination.LimitedRequest

getNextVersion() - Method in class com.atlassian.confluence.api.model.content.History

getNumber() - Method in class com.atlassian.confluence.api.model.content.Version

getPanelsForLocation(String, Map<String, Object>) - Method in interface com.atlassian.confluence.api.service.web.WebView

getParams() - Method in class com.atlassian.confluence.api.model.web.WebItemView

getParentReference(Reference<History>) - Static method in class com.atlassian.confluence.api.model.content.History

getPath() - Method in class com.atlassian.confluence.api.model.web.Icon

getPermissions() - Method in class com.atlassian.confluence.api.model.content.Content

getPermissions() - Method in class com.atlassian.confluence.api.model.people.KnownUser

getPermittedRepresentations() - Method in exception com.atlassian.confluence.api.service.exceptions.InvalidRepresentationException

getPostingDay() - Method in class com.atlassian.confluence.api.model.locator.ContentLocator

getPrefix() - Method in class com.atlassian.confluence.api.model.content.Label

getPreviousVersion() - Method in class com.atlassian.confluence.api.model.content.History

getPrivateModelDeserializers() - Static method in class com.atlassian.confluence.api.model.content.InternalDeserializers

getProfilePicture() - Method in class com.atlassian.confluence.api.model.people.Person

getPropertyName() - Method in class com.atlassian.confluence.api.model.Expansion

getRepresentation() - Method in class com.atlassian.confluence.api.model.content.ContentBody

getResults() - Method in interface com.atlassian.confluence.api.model.pagination.PageResponse

getResults() - Method in class com.atlassian.confluence.api.model.pagination.PageResponseImpl

getSectionsForLocation(String, Map<String, Object>) - Method in interface com.atlassian.confluence.api.service.web.WebView

getSpace() - Method in class com.atlassian.confluence.api.model.content.ContentLink

getSpace(String, Expansion...) - Method in interface com.atlassian.confluence.api.service.content.SpaceService

Retrieve a space with the given spacekey.

getSpaceKey(Reference<Space>) - Static method in class com.atlassian.confluence.api.model.content.Space

getSpaceKey() - Method in class com.atlassian.confluence.api.model.locator.ContentLocator

getSpaceRef() - Method in class com.atlassian.confluence.api.model.content.Content

getStart() - Method in interface com.atlassian.confluence.api.model.pagination.LimitedRequest

start index for the page of results

getStart() - Method in interface com.atlassian.confluence.api.model.pagination.PageRequest

getStart() - Method in class com.atlassian.confluence.api.model.pagination.SimplePageRequest

getStyleClass() - Method in class com.atlassian.confluence.api.model.web.WebItemView

getStyleClass() - Method in class com.atlassian.confluence.api.model.web.WebSectionView

getSubExpansions() - Method in class com.atlassian.confluence.api.model.Expansion

getSubExpansions(String) - Method in class com.atlassian.confluence.api.model.Expansions

getTinyUrlPath() - Method in class com.atlassian.confluence.api.model.content.Content

getTitle() - Method in class com.atlassian.confluence.api.model.content.Content

getTitle() - Method in class com.atlassian.confluence.api.model.content.ContentLink

getTitle() - Method in class com.atlassian.confluence.api.model.locator.ContentLocator

getTooltip() - Method in class com.atlassian.confluence.api.model.web.WebItemView

getType() - Method in class com.atlassian.confluence.api.model.content.Content

getType() - Method in class com.atlassian.confluence.api.model.content.ContentLink

getType() - Method in class com.atlassian.confluence.api.model.content.ContentType

getUrlWithoutContextPath() - Method in class com.atlassian.confluence.api.model.web.WebItemView

getUsername() - Method in class com.atlassian.confluence.api.model.people.User

getValidationResult() - Method in exception com.atlassian.confluence.api.service.exceptions.BadRequestException

getValue() - Method in class com.atlassian.confluence.api.model.content.ContentBody

getVersion() - Method in class com.atlassian.confluence.api.model.content.Content

getWebPanelVelocityContext() - Method in interface com.atlassian.confluence.api.service.web.WebView

This is a hack so we can use templates that have not yet been converted to Soy in the new web interface.

getWebUrlPath() - Method in class com.atlassian.confluence.api.model.content.Content

getWebUrlPath() - Method in class com.atlassian.confluence.api.model.content.ContentLink

getWeight() - Method in class com.atlassian.confluence.api.model.web.WebItemView

getWhen() - Method in class com.atlassian.confluence.api.model.content.Version

getWidth() - Method in class com.atlassian.confluence.api.model.web.Icon

GLOBAL_DESCRIPTION - Static variable in class com.atlassian.confluence.api.model.content.ContentType

H

hasMore() - Method in interface com.atlassian.confluence.api.model.pagination.PageResponse

Indicates whether the source has more results after this page.

hasMore() - Method in class com.atlassian.confluence.api.model.pagination.PageResponseImpl

history(Reference<History>) - Method in class com.atlassian.confluence.api.model.content.Content.ContentBuilder

history(History) - Method in class com.atlassian.confluence.api.model.content.Content.ContentBuilder

History - Class in com.atlassian.confluence.api.model.content

Contains the history of a piece of Content.

History.HistoryBuilder - Class in com.atlassian.confluence.api.model.content

Creates History instances.

I

icon(Icon) - Method in class com.atlassian.confluence.api.model.content.Space.SpaceBuilder

icon(Option<Icon>) - Method in class com.atlassian.confluence.api.model.content.Space.SpaceBuilder

Icon - Class in com.atlassian.confluence.api.model.web

TODO: Document this class / interface here

Icon(String, int, int, boolean) - Constructor for class com.atlassian.confluence.api.model.web.Icon

id(long) - Method in class com.atlassian.confluence.api.model.content.Content.ContentBuilder

id(String) - Method in class com.atlassian.confluence.api.model.content.Content.ContentBuilder

id(long) - Method in class com.atlassian.confluence.api.model.content.Space.SpaceBuilder

immutableListOrCollapsed(ImmutableList.Builder<T>) - Static method in class com.atlassian.confluence.api.model.reference.BuilderUtils

immutableMapOrCollapsed(ImmutableMap.Builder<K, V>) - Static method in class com.atlassian.confluence.api.model.reference.BuilderUtils

INPUT_CONVERSION_TO_STORAGE_ORDER - Static variable in enum com.atlassian.confluence.api.model.content.ContentRepresentation

An ordered enumeration of ContentRepresentations that can be converted to STORAGE format.

InternalDeserializers - Class in com.atlassian.confluence.api.model.content

This class contains deserializers for the package protected classes in the content model.

InternalDeserializers() - Constructor for class com.atlassian.confluence.api.model.content.InternalDeserializers

InternalServerException - Exception in com.atlassian.confluence.api.service.exceptions

A ServiceException wrapper for a general runtime exception.

InternalServerException(Throwable) - Constructor for exception com.atlassian.confluence.api.service.exceptions.InternalServerException

InternalServerException(String, Throwable) - Constructor for exception com.atlassian.confluence.api.service.exceptions.InternalServerException

InvalidRepresentationException - Exception in com.atlassian.confluence.api.service.exceptions

Thrown when an operation is attempted that is not valid for the kind of ContentBody you are providing.

InvalidRepresentationException(ContentRepresentation, ContentRepresentation[]) - Constructor for exception com.atlassian.confluence.api.service.exceptions.InvalidRepresentationException

InvalidRepresentationException(ContentRepresentation, Iterable<ContentRepresentation>) - Constructor for exception com.atlassian.confluence.api.service.exceptions.InvalidRepresentationException

isAnnotationOnClass(Object) - Static method in class com.atlassian.confluence.api.serialization.RestEnrichable.Helper

isAuthorized() - Method in interface com.atlassian.confluence.api.model.validation.ValidationResult

isEmpty() - Method in class com.atlassian.confluence.api.model.Expansions

isExpanded() - Method in class com.atlassian.confluence.api.model.reference.CollapsedReference

isExpanded() - Method in class com.atlassian.confluence.api.model.reference.EmptyReference

An empty reference is expanded, but calling get will return null.

isExpanded() - Method in class com.atlassian.confluence.api.model.reference.ExpandedReference

isExpanded() - Method in class com.atlassian.confluence.api.model.reference.Reference

indicates a reference is expanded and can be resolved to an object by calling get, or whether the reference is collapsed and calling get will throw an exception.

isForContent(ContentType) - Method in class com.atlassian.confluence.api.model.locator.ContentLocator

isLatest() - Method in class com.atlassian.confluence.api.model.content.History

isMinorEdit() - Method in class com.atlassian.confluence.api.model.content.Version

isValid() - Method in interface com.atlassian.confluence.api.model.validation.ValidationResult

iterator() - Method in class com.atlassian.confluence.api.model.pagination.PageResponseImpl

iterator() - Method in class com.atlassian.confluence.api.model.reference.CollapsedReference

iterator() - Method in class com.atlassian.confluence.api.model.reference.EmptyReference

iterator() - Method in class com.atlassian.confluence.api.model.reference.ExpandedReference

K

key(String) - Method in class com.atlassian.confluence.api.model.content.Space.SpaceBuilder

KnownUser - Class in com.atlassian.confluence.api.model.people

KnownUser(Icon, String, String, Map<Permission, Boolean>) - Constructor for class com.atlassian.confluence.api.model.people.KnownUser

L

Label - Class in com.atlassian.confluence.api.model.content

Label(String, String, String) - Constructor for class com.atlassian.confluence.api.model.content.Label

Label.Prefix - Enum in com.atlassian.confluence.api.model.content

lastUpdated(Version) - Method in class com.atlassian.confluence.api.model.content.History.HistoryBuilder

latest(boolean) - Method in class com.atlassian.confluence.api.model.content.History.HistoryBuilder

LimitedRequest - Interface in com.atlassian.confluence.api.model.pagination

A PageRequest guaranteed to have a limit capped to a developer provided value rather than a user provided value.

M

Macro - Class in com.atlassian.confluence.api.model.content

Contains information about a macro.

Macro.MacroBuilder - Class in com.atlassian.confluence.api.model.content

Creates History instances.

merge(Expansions) - Method in class com.atlassian.confluence.api.model.Expansions

message(String) - Method in class com.atlassian.confluence.api.model.content.Version.VersionBuilder

Message - Interface in com.atlassian.confluence.api.model.messages

Contains an key and array of arguments for conversion to an internationalised string.

metadata(Map<String, Object>) - Method in class com.atlassian.confluence.api.model.content.Content.ContentBuilder

minorEdit(boolean) - Method in class com.atlassian.confluence.api.model.content.Version.VersionBuilder

ModelMetadataProvider - Interface in com.atlassian.confluence.api.extension

Provides additional metadata such as Likes and Watches to API Model objects.

N

name(String) - Method in class com.atlassian.confluence.api.model.content.Macro.MacroBuilder

name(String) - Method in class com.atlassian.confluence.api.model.content.Space.SpaceBuilder

nextVersion(Version) - Method in class com.atlassian.confluence.api.model.content.History.HistoryBuilder

NotFoundException - Exception in com.atlassian.confluence.api.service.exceptions

Thrown when things that are expected to be found are NOT found.

NotFoundException() - Constructor for exception com.atlassian.confluence.api.service.exceptions.NotFoundException

NotFoundException(String) - Constructor for exception com.atlassian.confluence.api.service.exceptions.NotFoundException

NotFoundException(String, Throwable) - Constructor for exception com.atlassian.confluence.api.service.exceptions.NotFoundException

number(int) - Method in class com.atlassian.confluence.api.model.content.Version.VersionBuilder

O

option() - Method in class com.atlassian.confluence.api.model.reference.ExpandedReference

orEmpty(Reference<T>, Class<T>) - Static method in class com.atlassian.confluence.api.model.reference.Reference

orEmpty(T, Class<T>) - Static method in class com.atlassian.confluence.api.model.reference.Reference

P

PAGE - Static variable in class com.atlassian.confluence.api.model.content.ContentType

PageRequest - Interface in com.atlassian.confluence.api.model.pagination

Specifies the pagination requirements of a request.

pageRequest(PageRequest) - Method in class com.atlassian.confluence.api.model.pagination.PageResponseImpl.Builder

pageRequest(LimitedRequest) - Method in class com.atlassian.confluence.api.model.pagination.PageResponseImpl.Builder

PageResponse<T> - Interface in com.atlassian.confluence.api.model.pagination

A response to a page request, used in pagination.

PageResponseImpl<T> - Class in com.atlassian.confluence.api.model.pagination

A wrapper around a list of content.

PageResponseImpl.Builder<T> - Class in com.atlassian.confluence.api.model.pagination

PageResponseImpl.Builder() - Constructor for class com.atlassian.confluence.api.model.pagination.PageResponseImpl.Builder

PaginationBatch<T> - Interface in com.atlassian.confluence.api.model.pagination

A pagination batch is responsible for supplying a pageResponse for a given pageRequest.

PaginationService - Interface in com.atlassian.confluence.api.service.pagination

Provided paginated access to Model data.

parent(long, ContentType) - Method in class com.atlassian.confluence.api.model.content.Content.ContentBuilder

Shortcut method for creating ancestors with a single item of the given type

parent(String, ContentType) - Method in class com.atlassian.confluence.api.model.content.Content.ContentBuilder

Shortcut method for creating ancestors with a single item of the given type

Permission - Enum in com.atlassian.confluence.api.model.content

PermissionException - Exception in com.atlassian.confluence.api.service.exceptions

Raised when a user attempts to perform an action they do not have permission for.

PermissionException() - Constructor for exception com.atlassian.confluence.api.service.exceptions.PermissionException

PermissionException(String) - Constructor for exception com.atlassian.confluence.api.service.exceptions.PermissionException

PermissionException(Throwable) - Constructor for exception com.atlassian.confluence.api.service.exceptions.PermissionException

PermissionException(String, Throwable) - Constructor for exception com.atlassian.confluence.api.service.exceptions.PermissionException

permissions(Map<Permission, Boolean>) - Method in class com.atlassian.confluence.api.model.content.Content.ContentBuilder

Person - Class in com.atlassian.confluence.api.model.people

Person(Icon) - Constructor for class com.atlassian.confluence.api.model.people.Person

PERSONAL_INFORMATION - Static variable in class com.atlassian.confluence.api.model.content.ContentType

prepend(String) - Method in class com.atlassian.confluence.api.model.Expansions

Create a new Expansions that prepends the propertyName to the path of all expansions represented in this Expansions object.

previousVersion(Version) - Method in class com.atlassian.confluence.api.model.content.History.HistoryBuilder

R

Reference<T> - Class in com.atlassian.confluence.api.model.reference

A reference to a model object.

Reference() - Constructor for class com.atlassian.confluence.api.model.reference.Reference

referentClass() - Method in class com.atlassian.confluence.api.model.reference.CollapsedReference

referentClass() - Method in class com.atlassian.confluence.api.model.reference.EmptyReference

referentClass() - Method in class com.atlassian.confluence.api.model.reference.ExpandedReference

referentClass() - Method in class com.atlassian.confluence.api.model.reference.Reference

RestEnrichable - Annotation Type in com.atlassian.confluence.api.serialization

An annotation indicating that this model object should be enriched when being serialized.

RestEnrichable.Helper - Class in com.atlassian.confluence.api.serialization

RestEnrichable.Helper() - Constructor for class com.atlassian.confluence.api.serialization.RestEnrichable.Helper

S

safelyAddAllToBuilder(ImmutableList.Builder<T>, Iterable<T>) - Static method in class com.atlassian.confluence.api.model.reference.BuilderUtils

safelyPutAllToBuilder(ImmutableMap.Builder<K, V>, Map) - Static method in class com.atlassian.confluence.api.model.reference.BuilderUtils

safelyPutToBuilder(ImmutableMap.Builder<K, V>, K, V) - Static method in class com.atlassian.confluence.api.model.reference.BuilderUtils

ServiceException - Exception in com.atlassian.confluence.api.service.exceptions

All thrown API Service-level exceptions should extend this exception.

ServiceException() - Constructor for exception com.atlassian.confluence.api.service.exceptions.ServiceException

ServiceException(String) - Constructor for exception com.atlassian.confluence.api.service.exceptions.ServiceException

ServiceException(Throwable) - Constructor for exception com.atlassian.confluence.api.service.exceptions.ServiceException

ServiceException(String, Throwable) - Constructor for exception com.atlassian.confluence.api.service.exceptions.ServiceException

setAccessKey(String) - Method in class com.atlassian.confluence.api.model.web.WebItemView.Builder

setHtml(String) - Method in class com.atlassian.confluence.api.model.web.WebPanelView.Builder

setIcon(Icon) - Method in class com.atlassian.confluence.api.model.web.WebItemView.Builder

setId(String) - Method in class com.atlassian.confluence.api.model.web.WebItemView.Builder

setParams(Map<String, String>) - Method in class com.atlassian.confluence.api.model.web.WebItemView.Builder

setStyleClass(String) - Method in class com.atlassian.confluence.api.model.web.WebItemView.Builder

setStyleClass(String) - Method in class com.atlassian.confluence.api.model.web.WebSectionView.Builder

setTooltip(String) - Method in class com.atlassian.confluence.api.model.web.WebItemView.Builder

setUrlWithoutContextPath(String) - Method in class com.atlassian.confluence.api.model.web.WebItemView.Builder

SimplePageRequest - Class in com.atlassian.confluence.api.model.pagination

A simple immutable implementation of PageRequest

SimplePageRequest(LimitedRequest) - Constructor for class com.atlassian.confluence.api.model.pagination.SimplePageRequest

SimplePageRequest(int, int) - Constructor for class com.atlassian.confluence.api.model.pagination.SimplePageRequest

size() - Method in interface com.atlassian.confluence.api.model.pagination.PageResponse

size() - Method in class com.atlassian.confluence.api.model.pagination.PageResponseImpl

space(String) - Method in class com.atlassian.confluence.api.model.content.Content.ContentBuilder

space(Space) - Method in class com.atlassian.confluence.api.model.content.Content.ContentBuilder

space(Reference<Space>) - Method in class com.atlassian.confluence.api.model.content.Content.ContentBuilder

Space - Class in com.atlassian.confluence.api.model.content

Representation of a Confluence Space.

Space.SpaceBuilder - Class in com.atlassian.confluence.api.model.content

Builds Space objects.

SPACE_DESCRIPTION - Static variable in class com.atlassian.confluence.api.model.content.ContentType

SpaceService - Interface in com.atlassian.confluence.api.service.content

Provides CRUD operations on Spaces.

STATUS_UPDATE - Static variable in class com.atlassian.confluence.api.model.content.ContentType

T

throwCollapsedException(String) - Static method in class com.atlassian.confluence.api.model.reference.Collapsed.Exceptions

tinyUrlPath(Option<String>) - Method in class com.atlassian.confluence.api.model.content.Content.ContentBuilder

title(String) - Method in class com.atlassian.confluence.api.model.content.Content.ContentBuilder

to(T) - Static method in class com.atlassian.confluence.api.model.reference.Reference

create an exanded reference to the referent object

toArray() - Method in class com.atlassian.confluence.api.model.Expansions

toString() - Method in class com.atlassian.confluence.api.model.content.ContentType

toString() - Method in class com.atlassian.confluence.api.model.Expansion

toString() - Method in class com.atlassian.confluence.api.model.Expansions

type(ContentType) - Method in class com.atlassian.confluence.api.model.content.Content.ContentBuilder

U

UnknownUser - Class in com.atlassian.confluence.api.model.people

UnknownUser(Icon, String) - Constructor for class com.atlassian.confluence.api.model.people.UnknownUser

update(Content) - Method in interface com.atlassian.confluence.api.service.content.ContentService

Updates a piece of content.

User - Class in com.atlassian.confluence.api.model.people

User(Icon, String) - Constructor for class com.atlassian.confluence.api.model.people.User

username - Variable in class com.atlassian.confluence.api.model.people.User

V

validateCreate(Content) - Method in interface com.atlassian.confluence.api.service.content.ContentService

Validate that a piece of content can be included, including permission checks.

validateDelete(Content) - Method in interface com.atlassian.confluence.api.service.content.ContentService

Validate that a piece of content can be deleted, including permission checks.

ValidationError - Interface in com.atlassian.confluence.api.model.validation

Represents a single validation error within a ValidationResult.

ValidationResult - Interface in com.atlassian.confluence.api.model.validation

Stores the results after an API Service validateX() method is called.

valueOf(String) - Static method in enum com.atlassian.confluence.api.model.content.ContentRepresentation

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.atlassian.confluence.api.model.content.Label.Prefix

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.atlassian.confluence.api.model.content.Permission

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.atlassian.confluence.api.model.content.ContentRepresentation

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.atlassian.confluence.api.model.content.Label.Prefix

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.atlassian.confluence.api.model.content.Permission

Returns an array containing the constants of this enum type, in the order they are declared.

version(Version) - Method in class com.atlassian.confluence.api.model.content.Content.ContentBuilder

version(Reference<Version>) - Method in class com.atlassian.confluence.api.model.content.Content.ContentBuilder

Version - Class in com.atlassian.confluence.api.model.content

Represents the version of a piece of Content.

Version.VersionBuilder - Class in com.atlassian.confluence.api.model.content

Creates Version instances.

W

WebItemView - Class in com.atlassian.confluence.api.model.web

WebItemView.Builder - Class in com.atlassian.confluence.api.model.web

WebItemView.Builder() - Constructor for class com.atlassian.confluence.api.model.web.WebItemView.Builder

WebPanelView - Class in com.atlassian.confluence.api.model.web

WebPanelView.Builder - Class in com.atlassian.confluence.api.model.web

WebPanelView.Builder() - Constructor for class com.atlassian.confluence.api.model.web.WebPanelView.Builder

WebSectionView - Class in com.atlassian.confluence.api.model.web

WebSectionView.Builder - Class in com.atlassian.confluence.api.model.web

WebSectionView.Builder() - Constructor for class com.atlassian.confluence.api.model.web.WebSectionView.Builder

webUrlPath(String) - Method in class com.atlassian.confluence.api.model.content.Content.ContentBuilder

WebView - Interface in com.atlassian.confluence.api.service.web

WebViewService - Interface in com.atlassian.confluence.api.service.web

when(Date) - Method in class com.atlassian.confluence.api.model.content.Version.VersionBuilder

A B C D E F G H I K L M N O P R S T U V W