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

A

AbstractContentTypeBinding - Class in com.atlassian.confluence.api.extension.typebinding

Abstract ContentTypeBinding impl with some common helper methods.

AbstractContentTypeBinding(ContentType, Set<ContentType>) - Constructor for class com.atlassian.confluence.api.extension.typebinding.AbstractContentTypeBinding

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

addAttachments(ContentId, Collection<AttachmentUpload>) - Method in interface com.atlassian.confluence.api.service.content.AttachmentService

Add one or more attachments to a piece of Content.

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

addLabels(ContentId, Iterable<Label>) - Method in interface com.atlassian.confluence.api.service.content.ContentLabelService

Adds the given labels to the specified content

ALL - Static variable in class com.atlassian.confluence.api.model.Depth

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

ANCESTORS - Static variable in class com.atlassian.confluence.api.model.content.Content.Expansions

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

asLong() - Method in class com.atlassian.confluence.api.model.content.id.ContentId

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

AttachmentContentId - Class in com.atlassian.confluence.api.model.content.id

Represents the id of an Attachment.

AttachmentFilter - Class in com.atlassian.confluence.api.model.filter

Provides matching parameters for filtering Attachments.

AttachmentFilter.Builder - Class in com.atlassian.confluence.api.model.filter

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

Provides methods for creating, reading, updating and deleting Confluence Attachment Content objects.

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

Represents a single attachment being uploaded.

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

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

baseApiPath() - Method in interface com.atlassian.confluence.api.nav.Navigation

baseUrl() - Method in interface com.atlassian.confluence.api.nav.Navigation

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 - Static variable in class com.atlassian.confluence.api.model.content.Content.Expansions

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.Label.LabelBuilder

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.filter.AttachmentFilter.Builder

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

buildAbsolute() - Method in interface com.atlassian.confluence.api.nav.Navigation.Builder

build an absolute URL http://localhost:8080/confluence/rest/of/url

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(ContentType, long) - 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(String) - Static method in class com.atlassian.confluence.api.model.content.Label

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(Version) - Static method in class com.atlassian.confluence.api.model.content.Version

builder() - Static method in class com.atlassian.confluence.api.model.filter.AttachmentFilter

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(ContentId) - 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

buildRelative() - Method in interface com.atlassian.confluence.api.nav.Navigation.Builder

build a relative URL without webapp context, i.e.

buildRelativeWithContext() - Method in interface com.atlassian.confluence.api.nav.Navigation.Builder

build a relative URL with webapp context, i.e.

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

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

canCreateAttachments(ContentId) - Method in interface com.atlassian.confluence.api.service.content.AttachmentService

Checks if the user is permitted to add attachments to the given content

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

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

Checks to see if the passed in expansion string is expanded again somewhere in the expansions map.

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

Interacts with Content children, providing methods to both get collections of children for various ContentTypes at various depths.

ChildContentService.ChildContentFinder - Interface in com.atlassian.confluence.api.service.content

A finder interface to encapsulate finding content under a particular parent

children(Map<ContentType, PageResponse<Content>>) - Method in class com.atlassian.confluence.api.model.content.Content.ContentBuilder

CHILDREN - Static variable in class com.atlassian.confluence.api.model.content.Content.Expansions

children(Depth) - Method in interface com.atlassian.confluence.api.nav.Navigation.ContentNav

children(ContentType, Depth) - Method in interface com.atlassian.confluence.api.nav.Navigation.ContentNav

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

collapsedMap(Navigation.Builder) - Static method in class com.atlassian.confluence.api.model.reference.BuilderUtils

collapsedPageResponse(Navigation.Builder) - Static method in class com.atlassian.confluence.api.model.reference.BuilderUtils

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.

collection(Content) - Method in interface com.atlassian.confluence.api.nav.Navigation

a builder to produce a URL to the collection that the content belongs to.

collection(Space) - Method in interface com.atlassian.confluence.api.nav.Navigation

a builder to produce a URL to the collection that the space belongs to.

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

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

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.content.id - package com.atlassian.confluence.api.model.content.id

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

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.nav - package com.atlassian.confluence.api.nav

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.exceptions.unchecked - package com.atlassian.confluence.api.service.exceptions.unchecked

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

COMMENT_METADATA_KEY - Static variable in interface com.atlassian.confluence.api.service.content.AttachmentService

Attachment Comments are stored in the Content metadata as the "comment" entry.

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

CONTAINER - Static variable in class com.atlassian.confluence.api.model.content.Content.Expansions

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(Content) - Method in interface com.atlassian.confluence.api.nav.Navigation

create a content nav builder to reference a piece of content

content(Reference<Content>) - Method in interface com.atlassian.confluence.api.nav.Navigation

create a content nav builder to reference a piece of content

content(ContentId) - Method in interface com.atlassian.confluence.api.nav.Navigation

create a content nav builder to reference a piece of content

content() - Method in interface com.atlassian.confluence.api.nav.Navigation.SpaceNav

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).

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

Create new builders with Content.builder(ContentType) and a ContentId generated from the ContentType and the Long id.

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

Provides property names that can be used to expand Content objects.

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

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, ContentId) - Constructor for class com.atlassian.confluence.api.model.content.ContentBody

ContentBody(ContentRepresentation, String, Content) - 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.

ContentId - Class in com.atlassian.confluence.api.model.content.id

Identifies a Content instance.

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

API Service for interacting with labels on Content

ContentLabelService.Validator - Interface in com.atlassian.confluence.api.service.content

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 - Class 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.

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

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

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

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

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

Provides methods for validating the create, update and delete methods.

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

Represents a type of content.

ContentTypeBinding - Interface in com.atlassian.confluence.api.extension.typebinding

Provides Content items for certain ContentTypes.

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 class com.atlassian.confluence.api.model.content.ContentRepresentation

convertsToStorage() - Method in class 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

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

createNavigation() - Method in interface com.atlassian.confluence.api.nav.NavigationService

D

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

Removes an Attachment from the system.

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

Removes an item of Content from the system.

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

The depth to which sub-content should be returned.

descendants(Map<ContentType, PageResponse<Content>>) - Method in class com.atlassian.confluence.api.model.content.Content.ContentBuilder

DESCENDANTS - Static variable in class com.atlassian.confluence.api.model.content.Content.Expansions

DESCRIPTION - Static variable in class com.atlassian.confluence.api.model.content.Space.Expansions

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

deserialise(String) - Static method in class com.atlassian.confluence.api.model.content.id.ContentId

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

EDITOR - Static variable in class com.atlassian.confluence.api.model.content.ContentRepresentation

Representation suitable for use in the rich text editor

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

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

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.

entrySet() - Method in class com.atlassian.confluence.api.nav.NavigationAwareMap

equals(Object) - Method in class com.atlassian.confluence.api.model.content.ContentRepresentation

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

equals(Object) - Method in class com.atlassian.confluence.api.model.content.id.AttachmentContentId

equals(Object) - Method in class com.atlassian.confluence.api.model.content.id.ContentId

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

EXPORT_VIEW - Static variable in class com.atlassian.confluence.api.model.content.ContentRepresentation

HTML representation for viewing, but with absolute urls, instead of relative urls in the markup.

F

fetchMany(ContentType, PageRequest) - Method in interface com.atlassian.confluence.api.service.content.ChildContentService.ChildContentFinder

Retrieve all content of the particular type contained in this parent.

fetchMany(ContentType, PageRequest) - Method in interface com.atlassian.confluence.api.service.content.ContentService.ContentFetcher

fetchMany(ContentType, PageRequest) - Method in interface com.atlassian.confluence.api.service.content.SpaceService.SpaceContentFinder

Retrieve all content contained in this space of the particular type

fetchMappedByContentType(PageRequest) - Method in interface com.atlassian.confluence.api.service.content.ContentService.ContentFetcher

fetchMappedByType(PageRequest) - Method in interface com.atlassian.confluence.api.service.content.ChildContentService.ChildContentFinder

Retrieve all content contained in this parent mapped by ContentType.

fetchMappedByType(PageRequest) - Method in interface com.atlassian.confluence.api.service.content.SpaceService.SpaceContentFinder

Retrieve all content contained in this space mapped by ContentType

fetchOne() - Method in interface com.atlassian.confluence.api.service.content.ContentService.SingleContentFetcher

fetchOneOrNull() - Method in interface com.atlassian.confluence.api.service.content.ContentService.SingleContentFetcher

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

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

filename(String) - Method in class com.atlassian.confluence.api.model.filter.AttachmentFilter.Builder

filteredPageResponse(LimitedRequest, List<T>, Predicate<? super T>) - Static method in class com.atlassian.confluence.api.model.pagination.PageResponseImpl

Reduces a list of items for a limited request by the predicate provided.

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

Create a ContentFinder for locating content, the expansions will be applied to each piece of content that matches the finder.

findByContainerAndFilename(ContentId, String, Expansion...) - Method in interface com.atlassian.confluence.api.service.content.AttachmentService

Locates a single Attachment given the id of its container Content and its file name.

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

Locates a single Attachment given its id.

findContent(ContentId, Expansion...) - Method in interface com.atlassian.confluence.api.service.content.ChildContentService

A finder to locate Content under a parent.

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

A finder to locate content in the space

findMacroByHash(ContentId, 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

Deprecated. Since 5.5. Use WebViewService.forContent(ContentId).

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

Provides a new WebView.

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

fromReference(Reference<?>) - Method in interface com.atlassian.confluence.api.nav.Navigation

fromSingle(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

getAttachments(ContentId, PageRequest, AttachmentFilter, Expansion...) - Method in interface com.atlassian.confluence.api.service.content.AttachmentService

Get a page of attachments under the Content with the specified id.

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

getChildren(Content, LimitedRequest, Expansions, Depth) - Method in interface com.atlassian.confluence.api.extension.typebinding.ContentTypeBinding

Retrieve the children of an item of Content.

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

Returns a map of the immediate sub-content of this Content, split by ContentType.

getComment() - Method in class com.atlassian.confluence.api.model.content.AttachmentUpload

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

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

Get the ContentId from a Content Reference.

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

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

Returns a map of all sub-content of this Content, at any depth, split by ContentType.

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

getFile() - Method in class com.atlassian.confluence.api.model.content.AttachmentUpload

getFilename() - Method in class com.atlassian.confluence.api.model.filter.AttachmentFilter

getHandledType() - Method in class com.atlassian.confluence.api.extension.typebinding.AbstractContentTypeBinding

getHandledType() - Method in interface com.atlassian.confluence.api.extension.typebinding.ContentTypeBinding

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.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

getLabels(ContentId, Collection<Label.Prefix>, PageRequest) - Method in interface com.atlassian.confluence.api.service.content.ContentLabelService

Get the labels attached to a given piece of content in the given namespaces

getLastUpdatedRef() - 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

getMediaType() - Method in class com.atlassian.confluence.api.model.content.AttachmentUpload

getMediaType() - Method in class com.atlassian.confluence.api.model.filter.AttachmentFilter

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 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

getMetadataForAll(Iterable<Object>, Expansions) - Method in interface com.atlassian.confluence.api.extension.ModelMetadataProvider

Fetches metadata for a list of entities, returning a map of maps of metadata.

getMetadataProperties() - Method in interface com.atlassian.confluence.api.extension.ModelMetadataProvider

get the list of properties that the MetadataProvider provides metadata for

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

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

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

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

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

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

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

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

getPreviousVersionRef() - 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

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

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.Content

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.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.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

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

H

handlesParentType(ContentType) - Method in class com.atlassian.confluence.api.extension.typebinding.AbstractContentTypeBinding

handlesParentType(ContentType) - Method in interface com.atlassian.confluence.api.extension.typebinding.ContentTypeBinding

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

hashCode() - Method in class com.atlassian.confluence.api.model.content.ContentRepresentation

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

hashCode() - Method in class com.atlassian.confluence.api.model.content.id.AttachmentContentId

hashCode() - Method in class com.atlassian.confluence.api.model.content.id.ContentId

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 - Static variable in class com.atlassian.confluence.api.model.content.Content.Expansions

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

Contains the history of a piece of Content.

history() - Method in interface com.atlassian.confluence.api.nav.Navigation.ContentNav

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

Provides property names that can be used to expand History objects.

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

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(ContentId) - Method in class com.atlassian.confluence.api.model.content.Content.ContentBuilder

id(String) - Method in class com.atlassian.confluence.api.model.content.Label.LabelBuilder

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

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

INPUT_CONVERSION_TO_STORAGE_ORDER - Static variable in class 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

isSet() - Method in class com.atlassian.confluence.api.model.content.id.ContentId

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) - 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(Label.LabelBuilder) - Constructor for class com.atlassian.confluence.api.model.content.Label

label() - Method in interface com.atlassian.confluence.api.nav.Navigation.ContentNav

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

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

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

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

LATEST - Static variable in class com.atlassian.confluence.api.model.content.History.Expansions

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.

MEDIA_TYPE_METADATA_KEY - Static variable in interface com.atlassian.confluence.api.service.content.AttachmentService

Attachment Media Type is stored in the Content metadata as the "mediaType" entry.

mediaType(String) - Method in class com.atlassian.confluence.api.model.filter.AttachmentFilter.Builder

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

merge(Expansion[]) - 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

METADATA - Static variable in class com.atlassian.confluence.api.model.content.Content.Expansions

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.Label.LabelBuilder

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

Navigation - Interface in com.atlassian.confluence.api.nav

NavBuilder facilitates building URLs from our model objects.

Navigation.Builder - Interface in com.atlassian.confluence.api.nav

Navigation.ContentNav - Interface in com.atlassian.confluence.api.nav

Navigation.SpaceContentNav - Interface in com.atlassian.confluence.api.nav

Navigation.SpaceNav - Interface in com.atlassian.confluence.api.nav

NavigationAware - Interface in com.atlassian.confluence.api.nav

Provides methods to create Navigation.Builder instances.

NavigationAwareMap<K,V> - Class in com.atlassian.confluence.api.nav

An immutable map that is NavigationAware.

NavigationAwareMap(Map<K, V>, Navigation.Builder) - Constructor for class com.atlassian.confluence.api.nav.NavigationAwareMap

NavigationService - Interface in com.atlassian.confluence.api.nav

An injectable service that provides a nav builder which can be used to generate URLs from confluence api model objects.

NEXT - Static variable in class com.atlassian.confluence.api.model.content.History.Expansions

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

NONE - Static variable in interface com.atlassian.confluence.api.nav.Navigation.Builder

Some Model classes need to provide a builder, but don't need to provide any navigation.

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

NotImplementedServiceException - Exception in com.atlassian.confluence.api.service.exceptions.unchecked

Indicates that a particular service is not yet implemented, maps to a 501 error

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

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

O

of(ContentType, long) - Static method in class com.atlassian.confluence.api.model.content.id.ContentId

ONE - Static variable in class com.atlassian.confluence.api.model.pagination.SimplePageRequest

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(Content) - Method in class com.atlassian.confluence.api.model.content.Content.ContentBuilder

Shortcut method for creating ancestors with a single item of 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 - Static variable in class com.atlassian.confluence.api.model.content.Content.Expansions

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

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

prefix(String) - Method in class com.atlassian.confluence.api.model.content.Label.LabelBuilder

prefix(Label.Prefix) - Method in class com.atlassian.confluence.api.model.content.Label.LabelBuilder

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.

PREVIOUS - Static variable in class com.atlassian.confluence.api.model.content.History.Expansions

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

R

RAW - Static variable in class com.atlassian.confluence.api.model.content.ContentRepresentation

Raw "database" format.

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

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

resolveNavigation(NavigationService) - Method in interface com.atlassian.confluence.api.nav.NavigationAware

resolveNavigation(NavigationService) - Method in class com.atlassian.confluence.api.nav.NavigationAwareMap

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

ROOT - Static variable in class com.atlassian.confluence.api.model.Depth

RuntimeServiceException - Exception in com.atlassian.confluence.api.service.exceptions.unchecked

RuntimeServiceException are used to represent server side errors that map to specific 500 error codes in ExceptionConverter

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

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

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

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

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

serialise() - Method in class com.atlassian.confluence.api.model.content.id.AttachmentContentId

serialise() - Method in class com.atlassian.confluence.api.model.content.id.ContentId

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 - Static variable in class com.atlassian.confluence.api.model.content.Content.Expansions

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

Representation of a Confluence Space.

space(Reference<Space>) - Method in interface com.atlassian.confluence.api.nav.Navigation

create a space nav builder to reference the given space

space(Space) - Method in interface com.atlassian.confluence.api.nav.Navigation

create a space nav builder to reference the given space

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

Provides property names that can be used to expand Space objects.

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

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

Builds Space objects.

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

Provides CRUD operations on Spaces.

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

A finder interface to encapsulate finding content in a particular space

STORAGE - Static variable in class com.atlassian.confluence.api.model.content.ContentRepresentation

Raw database format, for content that stores data in our XML storage format

T

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

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

converts this validation result into an Exception and throws it

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.AttachmentUpload

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

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

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

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

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

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

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

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

type(ContentType) - Method in interface com.atlassian.confluence.api.nav.Navigation.SpaceContentNav

U

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

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

UNSET - Static variable in class com.atlassian.confluence.api.model.content.id.ContentId

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

Updates the non-data parts of an Attachment Content instance.

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

Updates a piece of content.

updateData(ContentId, AttachmentUpload) - Method in interface com.atlassian.confluence.api.service.content.AttachmentService

Updates the data part of an Attachment Content instance.

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

validateAddLabels(ContentId, Label...) - Method in interface com.atlassian.confluence.api.service.content.ContentLabelService.Validator

Validates that the list of labels can be added to the given content

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

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

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

Validate that an Attachment can be deleted, including permission checks.

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

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.

validator() - Method in interface com.atlassian.confluence.api.service.content.ContentLabelService

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

get the validator view of the ContentService.

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

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

Return the ContentType for the given type string.

valueOf(String) - Static method in class com.atlassian.confluence.api.model.content.id.ContentId

Deprecated. Don't use. Use ContentId.deserialise(String) instead.

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 class com.atlassian.confluence.api.model.Depth

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.

valuesOf(Iterable<String>) - Static method in class com.atlassian.confluence.api.model.content.ContentType

Return the ContentTypes for the given set of type strings.

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 - Static variable in class com.atlassian.confluence.api.model.content.Content.Expansions

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.

VIEW - Static variable in class com.atlassian.confluence.api.model.content.ContentRepresentation

HTML representation for viewing in a web page

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

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

WIKI - Static variable in class com.atlassian.confluence.api.model.content.ContentRepresentation

Legacy WIKI representation

withCreatedDate(LocalDate) - Method in interface com.atlassian.confluence.api.service.content.ContentService.ParameterContentFinder

withDepth(Depth) - Method in interface com.atlassian.confluence.api.service.content.ChildContentService.ChildContentFinder

Applies a depth filter to the content found under this parent and retrieved by the finder.

withDepth(Depth) - Method in interface com.atlassian.confluence.api.service.content.SpaceService.SpaceContentFinder

Applies a depth filter the content in this space retrieved by the finder, presently only pages participate in the space content hierarchy, the depth filter has no effect on other content type

withId(ContentId) - Method in interface com.atlassian.confluence.api.service.content.ContentService.ContentFinder

withLocator(ContentLocator) - Method in interface com.atlassian.confluence.api.service.content.ContentService.ContentFinder

withSpace(Space...) - Method in interface com.atlassian.confluence.api.service.content.ContentService.ParameterContentFinder

withTitle(String) - Method in interface com.atlassian.confluence.api.service.content.ContentService.ParameterContentFinder

withType(ContentType...) - Method in interface com.atlassian.confluence.api.service.content.ContentService.ParameterContentFinder

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

Wraps the given map with another map that has the the RestEnrichable annotation, the returned map is immutable

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