Index (Confluence API 5.5-OD-26-009 API)

A B C D E F G H I J 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.
addCollapsedEntries(Set<K>) - Method in class com.atlassian.confluence.api.model.reference.ModelMapBuilder
addCollapsedEntry(K) - Method in class com.atlassian.confluence.api.model.reference.ModelMapBuilder
addError(String, Object...) - Method in class com.atlassian.confluence.api.model.validation.SimpleValidationResult.Builder
addError(ValidationError) - Method in class com.atlassian.confluence.api.model.validation.SimpleValidationResult.Builder
addFieldError(String, String, Object...) - Method in class com.atlassian.confluence.api.model.validation.SimpleValidationResult.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
addLabels(ContentId, Iterable<Label>) - Method in interface com.atlassian.confluence.api.service.content.ContentLabelService: Adds the given labels to the specified content
addLink(Link) - Method in class com.atlassian.confluence.api.model.content.Content.ContentBuilder
addLink(LinkType, String) - Method in class com.atlassian.confluence.api.model.content.Content.ContentBuilder
addMessage(Message) - Method in class com.atlassian.confluence.api.model.longtasks.LongTaskStatus.LongTaskBuilder
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
ApiEnum - Interface in com.atlassian.confluence.api.model: Flags API Model classes that represent enums, but are not Java enums.
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
asLong() - Method in class com.atlassian.confluence.api.model.content.id.JsonContentPropertyId
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.
AttachmentService - Interface in com.atlassian.confluence.api.service.content: Provides methods for creating, reading, updating and deleting Confluence Attachment Content objects.
AttachmentService.AttachmentFinder - Interface in com.atlassian.confluence.api.service.content: A finder for locating attachments.
AttachmentService.Validator - Interface in com.atlassian.confluence.api.service.content: Provides methods for validating the actions on the AttachmentService
AttachmentUpload - Class in com.atlassian.confluence.api.model.content: Represents a single attachment being uploaded.
AttachmentUpload(File, String, String, String, boolean) - Constructor for class com.atlassian.confluence.api.model.content.AttachmentUpload
authorized(boolean) - Method in class com.atlassian.confluence.api.model.validation.SimpleValidationResult.Builder

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.MacroInstance.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.JsonContentProperty.ContentPropertyBuilder
build() - Method in class com.atlassian.confluence.api.model.content.Label.LabelBuilder
build() - Method in class com.atlassian.confluence.api.model.content.MacroInstance.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.longtasks.LongTaskStatus.LongTaskBuilder
build() - Method in class com.atlassian.confluence.api.model.longtasks.LongTaskSubmission.LongTaskSubmissionBuilder
build() - Method in class com.atlassian.confluence.api.model.pagination.PageResponseImpl.Builder
build() - Method in class com.atlassian.confluence.api.model.reference.ModelMapBuilder: Build the map.
build() - Method in class com.atlassian.confluence.api.model.validation.SimpleValidationResult.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() - Static method in class com.atlassian.confluence.api.model.content.JsonContentProperty: Creates a builder.
builder(JsonContentProperty) - Static method in class com.atlassian.confluence.api.model.content.JsonContentProperty: Creates a builder, initialized from the given template.
builder(String) - Static method in class com.atlassian.confluence.api.model.content.Label
builder() - Static method in class com.atlassian.confluence.api.model.content.MacroInstance
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(Space) - Static method in class com.atlassian.confluence.api.model.content.Space
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.locator.ContentLocator
builder(LongTaskId) - Static method in class com.atlassian.confluence.api.model.longtasks.LongTaskStatus
builder() - Static method in class com.atlassian.confluence.api.model.longtasks.LongTaskSubmission
builder() - Static method in class com.atlassian.confluence.api.model.validation.SimpleValidationResult
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(JsonContentPropertyId) - Static method in class com.atlassian.confluence.api.model.content.JsonContentProperty: Creates a collapsed reference to a JsonContentProperty with the given id, or an empty reference, if none was given.
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(int) - Static method in class com.atlassian.confluence.api.model.content.Version
buildReference(Reference<Content>, int) - Static method in class com.atlassian.confluence.api.model.content.Version: Deprecated.
since 5.6 use Version.buildReference(int)
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
BUILT_IN - Static variable in class com.atlassian.confluence.api.model.link.LinkType
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.Validator: 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) - Static method in class com.atlassian.confluence.api.model.reference.Reference
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() - Static method in class com.atlassian.confluence.api.model.reference.BuilderUtils
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
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.link - package com.atlassian.confluence.api.model.link
com.atlassian.confluence.api.model.locator - package com.atlassian.confluence.api.model.locator
com.atlassian.confluence.api.model.longtasks - package com.atlassian.confluence.api.model.longtasks
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.datetime - package com.atlassian.confluence.api.service.datetime
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.finder - package com.atlassian.confluence.api.service.finder
com.atlassian.confluence.api.service.longtasks - package com.atlassian.confluence.api.service.longtasks
com.atlassian.confluence.api.service.pagination - package com.atlassian.confluence.api.service.pagination
com.atlassian.confluence.api.service.search - package com.atlassian.confluence.api.service.search
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.
compareTo(Object) - Method in class com.atlassian.confluence.api.model.content.id.AttachmentContentId
compareTo(Object) - Method in class com.atlassian.confluence.api.model.content.id.ContentId
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 class com.atlassian.confluence.api.model.content.JsonContentProperty.ContentPropertyBuilder
content(Reference<Content>) - Method in class com.atlassian.confluence.api.model.content.JsonContentProperty.ContentPropertyBuilder
CONTENT - Static variable in class com.atlassian.confluence.api.model.content.JsonContentProperty.Expansions
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(Content) - Method in interface com.atlassian.confluence.api.nav.Navigation.ExperimentalNav: create a content nav builder to reference a piece of content
content(Reference<Content>) - Method in interface com.atlassian.confluence.api.nav.Navigation.ExperimentalNav: create a content nav builder to reference a piece of content
content(ContentId) - Method in interface com.atlassian.confluence.api.nav.Navigation.ExperimentalNav: 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: Provides methods for validating actions on the ContentLabelService
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
ContentMacroService - Interface in com.atlassian.confluence.api.service.content: Provides methods for interacting with instances of macros on Content.
ContentMacroService.MacroInstanceFinder - Interface in com.atlassian.confluence.api.service.content: A finder for locating instances of macros on content
ContentPropertyService - Interface in com.atlassian.confluence.api.service.content: Provides methods for creating, reading, updating and deleting Confluence JsonContentProperty objects attached to Content objects.
ContentPropertyService.ContentPropertyFetcher - Interface in com.atlassian.confluence.api.service.content
ContentPropertyService.ContentPropertyFinder - Interface in com.atlassian.confluence.api.service.content
ContentPropertyService.ParameterContentPropertyFinder - Interface in com.atlassian.confluence.api.service.content
ContentPropertyService.SingleContentPropertyFetcher - Interface in com.atlassian.confluence.api.service.content
ContentPropertyService.Validator - Interface in com.atlassian.confluence.api.service.content: Provides methods for validating the create, update and delete methods.
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: A content fetcher that also allows fetching many, this exists as a separate interface to allow the type system to only offer fetchMany methods when appropriate.
ContentService.ContentFinder - Interface in com.atlassian.confluence.api.service.content: A finder for locating content
ContentService.ParameterContentFinder - Interface in com.atlassian.confluence.api.service.content: A content finder allowing various parameters to be set to restrict the fetched 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.
ContentTooLongException - Exception in com.atlassian.confluence.api.service.exceptions: TODO replace with httpcore exception of the same name when that's widely available to plugins
ContentTooLongException(String) - Constructor for exception com.atlassian.confluence.api.service.exceptions.ContentTooLongException
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
convertToServiceException(String) - Method in class com.atlassian.confluence.api.model.validation.SimpleValidationResult
copy(Map<K, V>) - Method in class com.atlassian.confluence.api.model.reference.ModelMapBuilder: Store CollapsedMap/NavMap but store values of other maps, including Enrichables.
copyOf(Message) - Static method in class com.atlassian.confluence.api.model.messages.SimpleMessage
CQLSearchService - Interface in com.atlassian.confluence.api.service.search: Entry point into CQL Search.
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(JsonContentProperty) - Method in interface com.atlassian.confluence.api.service.content.ContentPropertyService: Create a content property.
create(Content) - Method in interface com.atlassian.confluence.api.service.content.ContentService: Create a piece of content.
create(Space, boolean) - Method in interface com.atlassian.confluence.api.service.content.SpaceService: Create a new space.
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

DateFormatService - Interface in com.atlassian.confluence.api.service.datetime: A service to help format dates
delete(Content) - Method in interface com.atlassian.confluence.api.service.content.AttachmentService: Removes an Attachment from the system.
delete(JsonContentProperty) - Method in interface com.atlassian.confluence.api.service.content.ContentPropertyService: Removes a content property from the system.
delete(Content) - Method in interface com.atlassian.confluence.api.service.content.ContentService: Removes a piece of Content from the system.
delete(Space) - Method in interface com.atlassian.confluence.api.service.content.SpaceService: Delete the given space.
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(ContentRepresentation, String) - Method in class com.atlassian.confluence.api.model.content.Space.SpaceBuilder
description(ContentRepresentation, FormattedBody) - Method in class com.atlassian.confluence.api.model.content.Space.SpaceBuilder
description(Map<ContentRepresentation, FormattedBody>) - Method in class com.atlassian.confluence.api.model.content.Space.SpaceBuilder
description(ContentRepresentation, Reference<FormattedBody>) - Method in class com.atlassian.confluence.api.model.content.Space.SpaceBuilder: Deprecated.
5.6 use Space.SpaceBuilder.description(ContentRepresentation,FormattedBody)
deserialise(String) - Static method in class com.atlassian.confluence.api.model.content.id.ContentId
deserialise(String) - Static method in class com.atlassian.confluence.api.model.content.id.JsonContentPropertyId
deserialise(String) - Static method in class com.atlassian.confluence.api.model.longtasks.LongTaskId
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.
DOWNLOAD - Static variable in class com.atlassian.confluence.api.model.link.LinkType

E

EDITOR - Static variable in class com.atlassian.confluence.api.model.content.ContentRepresentation: Representation suitable for use in the rich text editor
elapsedTime(long) - Method in class com.atlassian.confluence.api.model.longtasks.LongTaskStatus.LongTaskBuilder
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(boolean, PageRequest) - Static method in class com.atlassian.confluence.api.model.pagination.PageResponseImpl
empty(boolean, LimitedRequest) - 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
EnrichableMap<K,V> - Class in com.atlassian.confluence.api.model.reference: A map with the RestEnrichable annotation, indicating that this map should be converted to a RestEntity and enriched by the REST stack.
entrySet() - Method in class com.atlassian.confluence.api.model.reference.EnrichableMap
equals(Object) - Method in class com.atlassian.confluence.api.model.content.Content
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
equals(Object) - Method in class com.atlassian.confluence.api.model.content.id.JsonContentPropertyId
equals(Object) - Method in class com.atlassian.confluence.api.model.content.JsonContentProperty
equals(Object) - Method in class com.atlassian.confluence.api.model.content.Version
equals(Object) - Method in class com.atlassian.confluence.api.model.Expansion
equals(Object) - Method in class com.atlassian.confluence.api.model.Expansions
equals(Object) - Method in class com.atlassian.confluence.api.model.JsonString
equals(Object) - Method in class com.atlassian.confluence.api.model.longtasks.LongTaskId
equals(Object) - Method in class com.atlassian.confluence.api.model.longtasks.LongTaskStatus
equals(Object) - Method in class com.atlassian.confluence.api.model.reference.Reference
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: Represents a property on a model object and the sub-properties of that property that should be filled in by the service when returning the model object.
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
experimental() - Method in interface com.atlassian.confluence.api.nav.Navigation
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(PageRequest) - Method in interface com.atlassian.confluence.api.service.content.AttachmentService.AttachmentFinder: Fetch the attachments from the datastore that match the restrictions applied with the withX methods.
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(PageRequest) - Method in interface com.atlassian.confluence.api.service.content.ContentPropertyService.ContentPropertyFetcher
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
fetchMany(PageRequest) - Method in interface com.atlassian.confluence.api.service.content.SpaceService.SpaceFinder
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.ContentPropertyService.SingleContentPropertyFetcher
fetchOne() - Method in interface com.atlassian.confluence.api.service.finder.SingleFetcher
fetchOneOrNull() - Method in interface com.atlassian.confluence.api.service.content.ContentPropertyService.SingleContentPropertyFetcher
fetchOneOrNull() - Method in interface com.atlassian.confluence.api.service.finder.SingleFetcher
FieldValidationError - Interface in com.atlassian.confluence.api.model.validation: Represents a ValidationError that is associated with a field of user input.
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.AttachmentService: Creates an attachment finder for locating attachments.
find(Expansion...) - Method in interface com.atlassian.confluence.api.service.content.ContentPropertyService: Create a ContentPropertyService.ContentPropertyFinder for locating content, the expansions will be applied to each property that matches the finder.
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.
find(Expansion...) - Method in interface com.atlassian.confluence.api.service.content.SpaceService: Create a space finder to locate spaces, the expansions will be applied to each Space matching the restrictions on the finder.
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
findInContent(ContentId, Expansion...) - Method in interface com.atlassian.confluence.api.service.content.ContentMacroService: Create a macro instance finder to locate macro instances in the given Content
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.
FormattedBody - Class in com.atlassian.confluence.api.model.content: A String with a ContentRepresentation.
FormattedBody(ContentRepresentation, String) - Constructor for class com.atlassian.confluence.api.model.content.FormattedBody
forName(String) - Static method in class com.atlassian.confluence.api.model.content.SpaceType
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.ExpandedReference
get() - Method in class com.atlassian.confluence.api.model.reference.Reference
get(LongTaskId, Expansion...) - Method in interface com.atlassian.confluence.api.service.longtasks.LongTaskService: Returns the status of a long-running task.
getAccessKey() - Method in class com.atlassian.confluence.api.model.web.WebItemView
getAll(PageRequest, Expansion...) - Method in interface com.atlassian.confluence.api.service.longtasks.LongTaskService: Returns the status of all tracked long-running tasks visible to the user.
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
getArgs() - Method in class com.atlassian.confluence.api.model.messages.SimpleMessage
getBody() - Method in class com.atlassian.confluence.api.model.content.Content
getBody() - Method in class com.atlassian.confluence.api.model.content.MacroInstance
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.
getCollapsedEntries() - Method in class com.atlassian.confluence.api.model.reference.EnrichableMap
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
getContent() - Method in class com.atlassian.confluence.api.model.content.JsonContentProperty
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
getContentRef() - Method in class com.atlassian.confluence.api.model.content.JsonContentProperty
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
getDateFormatPatternForUser() - Method in interface com.atlassian.confluence.api.service.datetime.DateFormatService
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
getDescriptionRefs() - Method in class com.atlassian.confluence.api.model.content.Space: Deprecated.
Since 5.5.1 Use Space.getDescription().
getDisplayName() - Method in class com.atlassian.confluence.api.model.people.KnownUser
getElapsedTime() - Method in class com.atlassian.confluence.api.model.longtasks.LongTaskStatus
getErrors() - Method in class com.atlassian.confluence.api.model.validation.SimpleValidationResult
getErrors() - Method in interface com.atlassian.confluence.api.model.validation.ValidationResult
getFieldName() - Method in interface com.atlassian.confluence.api.model.validation.FieldValidationError
getFieldName() - Method in class com.atlassian.confluence.api.model.validation.SimpleFieldValidationError
getFile() - Method in class com.atlassian.confluence.api.model.content.AttachmentUpload
getFormattedDateByUserLocale(LocalDateTime) - Method in interface com.atlassian.confluence.api.service.datetime.DateFormatService: Format the given date in an appropriate format according to the user's locale.
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
getHomepageRef() - Method in class com.atlassian.confluence.api.model.content.Space
getHtml() - Method in class com.atlassian.confluence.api.model.web.WebPanelView
getIcon() - Method in class com.atlassian.confluence.api.model.web.WebItemView
getIconRef() - Method in class com.atlassian.confluence.api.model.content.Space
getId() - Method in class com.atlassian.confluence.api.model.content.Content
getId() - Method in class com.atlassian.confluence.api.model.content.JsonContentProperty
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.longtasks.LongTaskStatus
getId() - Method in class com.atlassian.confluence.api.model.longtasks.LongTaskSubmission
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.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.JsonContentProperty
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.messages.SimpleMessage
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
getLink(String) - Method in class com.atlassian.confluence.api.model.longtasks.LongTaskSubmission
getLinks() - Method in class com.atlassian.confluence.api.model.content.Content
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
getMessage() - Method in class com.atlassian.confluence.api.model.content.Version
getMessage() - Method in class com.atlassian.confluence.api.model.validation.SimpleValidationError
getMessage() - Method in interface com.atlassian.confluence.api.model.validation.ValidationError
getMessages() - Method in class com.atlassian.confluence.api.model.longtasks.LongTaskStatus
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.MacroInstance
getName() - Method in class com.atlassian.confluence.api.model.content.Space
getName() - Method in class com.atlassian.confluence.api.model.longtasks.LongTaskStatus
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.link.Link
getPath() - Method in class com.atlassian.confluence.api.model.web.Icon
getPercentageComplete() - Method in class com.atlassian.confluence.api.model.longtasks.LongTaskStatus
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.ContentRepresentation
getRepresentation() - Method in class com.atlassian.confluence.api.model.content.FormattedBody
getResultPath() - Method in class com.atlassian.confluence.api.model.longtasks.LongTaskSubmission
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: Deprecated.
use find().withKey(String).fetchOne();
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
getStatusPath() - Method in class com.atlassian.confluence.api.model.longtasks.LongTaskSubmission
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
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
getTranslation() - Method in interface com.atlassian.confluence.api.model.messages.Message
getTranslation() - Method in class com.atlassian.confluence.api.model.messages.SimpleMessage
getType() - Method in class com.atlassian.confluence.api.model.content.Content
getType() - Method in class com.atlassian.confluence.api.model.content.ContentType
getType() - Method in class com.atlassian.confluence.api.model.content.Space
getType() - Method in class com.atlassian.confluence.api.model.content.SpaceType
getType() - Method in class com.atlassian.confluence.api.model.link.Link
getType() - Method in class com.atlassian.confluence.api.model.link.LinkType
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 interface com.atlassian.confluence.api.model.validation.WithValidationResult
getValidationResult() - Method in exception com.atlassian.confluence.api.service.exceptions.BadRequestException
getValue() - Method in class com.atlassian.confluence.api.model.content.FormattedBody
getValue() - Method in class com.atlassian.confluence.api.model.content.JsonContentProperty
getValue() - Method in class com.atlassian.confluence.api.model.JsonString
getVersion() - Method in class com.atlassian.confluence.api.model.content.Content
getVersion() - Method in class com.atlassian.confluence.api.model.content.JsonContentProperty
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.
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 - Static variable in class com.atlassian.confluence.api.model.content.SpaceType

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.Content
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
hashCode() - Method in class com.atlassian.confluence.api.model.content.id.JsonContentPropertyId
hashCode() - Method in class com.atlassian.confluence.api.model.content.JsonContentProperty
hashCode() - Method in class com.atlassian.confluence.api.model.content.Version
hashCode() - Method in class com.atlassian.confluence.api.model.JsonString
hashCode() - Method in class com.atlassian.confluence.api.model.reference.Reference
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.
HOMEPAGE - Static variable in class com.atlassian.confluence.api.model.content.Space.Expansions
homepage(Reference<Content>) - Method in class com.atlassian.confluence.api.model.content.Space.SpaceBuilder
homepage(Content) - Method in class com.atlassian.confluence.api.model.content.Space.SpaceBuilder

I

ICON - Static variable in class com.atlassian.confluence.api.model.content.Space.Expansions
icon(Icon) - Method in class com.atlassian.confluence.api.model.content.Space.SpaceBuilder
icon(Reference<Icon>) - Method in class com.atlassian.confluence.api.model.content.Space.SpaceBuilder
Icon - Class in com.atlassian.confluence.api.model.web: Represents an image with fixed dimensions, often for a Person or Space.
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(JsonContentPropertyId) - Method in class com.atlassian.confluence.api.model.content.JsonContentProperty.ContentPropertyBuilder
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
id(LongTaskId) - Method in class com.atlassian.confluence.api.model.longtasks.LongTaskStatus.LongTaskBuilder
id(LongTaskId) - Method in class com.atlassian.confluence.api.model.longtasks.LongTaskSubmission.LongTaskSubmissionBuilder
immutableListOrCollapsed(ImmutableList.Builder<T>) - 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 class com.atlassian.confluence.api.model.validation.SimpleValidationResult
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.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.AttachmentUpload
isMinorEdit() - Method in class com.atlassian.confluence.api.model.content.Version
isSet() - Method in class com.atlassian.confluence.api.model.content.id.ContentId
isSet() - Method in class com.atlassian.confluence.api.model.content.id.JsonContentPropertyId
isSuccessful() - Method in class com.atlassian.confluence.api.model.longtasks.LongTaskStatus
isValid() - Method in class com.atlassian.confluence.api.model.validation.SimpleValidationResult
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.ExpandedReference

J

JsonContentProperty - Class in com.atlassian.confluence.api.model.content: Container for arbitrary JSON data attached to some Content.
JsonContentProperty.ContentPropertyBuilder - Class in com.atlassian.confluence.api.model.content
JsonContentProperty.ContentPropertyBuilder() - Constructor for class com.atlassian.confluence.api.model.content.JsonContentProperty.ContentPropertyBuilder
JsonContentProperty.Expansions - Class in com.atlassian.confluence.api.model.content: Provides property names that can be used to expand JsonContentProperty objects.
JsonContentProperty.Expansions() - Constructor for class com.atlassian.confluence.api.model.content.JsonContentProperty.Expansions
JsonContentPropertyId - Class in com.atlassian.confluence.api.model.content.id: Identifies a JsonContentProperty instance.
JsonString - Class in com.atlassian.confluence.api.model: Holds a JSON formatted string.
JsonString(String) - Constructor for class com.atlassian.confluence.api.model.JsonString

K

key(String) - Method in class com.atlassian.confluence.api.model.content.JsonContentProperty.ContentPropertyBuilder
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.
Link - Class in com.atlassian.confluence.api.model.link: Represents a link with a type.
Link(LinkType, String) - Constructor for class com.atlassian.confluence.api.model.link.Link
LinkType - Class in com.atlassian.confluence.api.model.link: The type of a link.
LinkType(String) - Constructor for class com.atlassian.confluence.api.model.link.LinkType
longTask(LongTaskId) - Method in interface com.atlassian.confluence.api.nav.Navigation
LongTaskId - Class in com.atlassian.confluence.api.model.longtasks: Identifies a LongTaskStatus.
LongTaskService - Interface in com.atlassian.confluence.api.service.longtasks: Manages LongTaskStatuss.
LongTaskStatus - Class in com.atlassian.confluence.api.model.longtasks: Represents a long-running task in the system.
LongTaskStatus.LongTaskBuilder - Class in com.atlassian.confluence.api.model.longtasks
LongTaskStatus.LongTaskBuilder() - Constructor for class com.atlassian.confluence.api.model.longtasks.LongTaskStatus.LongTaskBuilder
LongTaskSubmission - Class in com.atlassian.confluence.api.model.longtasks: A pointer to a long-running task, the result of submitting a task for processing.
LongTaskSubmission.LongTaskSubmissionBuilder - Class in com.atlassian.confluence.api.model.longtasks
LongTaskSubmission.LongTaskSubmissionBuilder() - Constructor for class com.atlassian.confluence.api.model.longtasks.LongTaskSubmission.LongTaskSubmissionBuilder

M

MacroInstance - Class in com.atlassian.confluence.api.model.content: Represents an instance of a Macro in a piece of Content
MacroInstance.MacroBuilder - Class in com.atlassian.confluence.api.model.content: Creates History instances.
MAXIMUM_KEY_LENGTH - Static variable in interface com.atlassian.confluence.api.service.content.ContentPropertyService
MAXIMUM_PROPERTIES_PER_PAGE_REQUEST - Static variable in interface com.atlassian.confluence.api.service.content.ContentPropertyService
MAXIMUM_VALUE_LENGTH - Static variable in interface com.atlassian.confluence.api.service.content.ContentPropertyService
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.
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
modelMap(ModelMapBuilder<K, V>) - Static method in class com.atlassian.confluence.api.model.reference.BuilderUtils: All API Model maps must be Immutable and either: 1.
modelMap(ImmutableMap.Builder<K, V>) - Static method in class com.atlassian.confluence.api.model.reference.BuilderUtils: Deprecated.
since 5.6 use BuilderUtils.modelMap(ModelMapBuilder)
modelMap(Map<K, V>) - Static method in class com.atlassian.confluence.api.model.reference.BuilderUtils: All API Model maps must be Immutable and either: 1.
ModelMapBuilder<K,V> - Class in com.atlassian.confluence.api.model.reference: A Map builder for CollapsedMap and EnrichableMap instances.
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.MacroInstance.MacroBuilder
name(String) - Method in class com.atlassian.confluence.api.model.content.Space.SpaceBuilder
name(Message) - Method in class com.atlassian.confluence.api.model.longtasks.LongTaskStatus.LongTaskBuilder
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.ExperimentalContentNav - Interface in com.atlassian.confluence.api.nav: ExperimentalContentNav will change as new resources are added and promoted to production.
Navigation.ExperimentalNav - Interface in com.atlassian.confluence.api.nav: ExperimentalNav will change as new resources are added and promoted to production.
Navigation.LongTaskNav - 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.
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.
newInstance() - Static method in class com.atlassian.confluence.api.model.reference.ModelMapBuilder
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
NotImplementedServiceException(String, Exception) - 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
of(long) - Static method in class com.atlassian.confluence.api.model.content.id.JsonContentPropertyId
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
percentageComplete(int) - Method in class com.atlassian.confluence.api.model.longtasks.LongTaskStatus.LongTaskBuilder
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
PERSONAL - Static variable in class com.atlassian.confluence.api.model.content.SpaceType
PLAIN - Static variable in class com.atlassian.confluence.api.model.content.ContentRepresentation: Raw database format as plain text with no XHTML or WIKI markup.
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
property(JsonContentProperty) - Method in interface com.atlassian.confluence.api.nav.Navigation.ExperimentalContentNav
put(K, V) - Method in class com.atlassian.confluence.api.model.reference.ModelMapBuilder
putAll(Map<K, ? extends V>) - Method in class com.atlassian.confluence.api.model.reference.ModelMapBuilder

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: Deprecated.
since 5.6 use @{link Reference#Reference(boolean)}
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 interface com.atlassian.confluence.api.nav.NavigationAware
RESOURCE_BASE - Static variable in interface com.atlassian.confluence.api.nav.Navigation.LongTaskNav
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
result(String) - Method in class com.atlassian.confluence.api.model.longtasks.LongTaskSubmission.LongTaskSubmissionBuilder
ROOT - Static variable in class com.atlassian.confluence.api.model.Depth

S

safelyAddAllToBuilder(ImmutableList.Builder<T>, Iterable<T>) - Static method in class com.atlassian.confluence.api.model.reference.BuilderUtils
safelyPutAllToBuilder(ImmutableMap.Builder<K, V>, Map<K, V>) - Static method in class com.atlassian.confluence.api.model.reference.BuilderUtils: Deprecated.
since 5.5.1 Use a ModelMapBuilder.
safelyPutToBuilder(ImmutableMap.Builder<K, V>, K, V) - Static method in class com.atlassian.confluence.api.model.reference.BuilderUtils: Deprecated.
since 5.5.1 Use a ModelMapBuilder.
searchContent(String, PageRequest, Expansion...) - Method in interface com.atlassian.confluence.api.service.search.CQLSearchService: Execute a CQL search query and fetch a page results.
searchContent(String, Expansion...) - Method in interface com.atlassian.confluence.api.service.search.CQLSearchService: Execute a CQL search query and fetch a page results.
serialise() - Method in class com.atlassian.confluence.api.model.content.id.AttachmentContentId
serialise() - Method in class com.atlassian.confluence.api.model.content.id.ContentId
serialise() - Method in class com.atlassian.confluence.api.model.content.id.JsonContentPropertyId
serialise() - Method in class com.atlassian.confluence.api.model.longtasks.LongTaskId
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
SimpleFieldValidationError - Class in com.atlassian.confluence.api.model.validation: Represents the simplest kind of validation error on a particular field.
SimpleFieldValidationError(String, String, Object...) - Constructor for class com.atlassian.confluence.api.model.validation.SimpleFieldValidationError
SimpleMessage - Class in com.atlassian.confluence.api.model.messages: Simple immutable implementation of Message.
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
SimpleValidationError - Class in com.atlassian.confluence.api.model.validation: Represents the simplest kind of ValidationError.
SimpleValidationError(String, Object...) - Constructor for class com.atlassian.confluence.api.model.validation.SimpleValidationError
SimpleValidationResult - Class in com.atlassian.confluence.api.model.validation: Represents the simplest kind of ValidationResult.
SimpleValidationResult.Builder - Class in com.atlassian.confluence.api.model.validation
SimpleValidationResult.Builder() - Constructor for class com.atlassian.confluence.api.model.validation.SimpleValidationResult.Builder
SingleFetcher<T> - Interface in com.atlassian.confluence.api.service.finder: A fetcher that retrieves individual model objects from a datastore.
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.SingleSpaceFetcher - Interface in com.atlassian.confluence.api.service.content
SpaceService.SpaceContentFinder - Interface in com.atlassian.confluence.api.service.content: A finder interface to encapsulate finding content in a particular space
SpaceService.SpaceFinder - Interface in com.atlassian.confluence.api.service.content: A finder for locating spaces.
SpaceService.Validator - Interface in com.atlassian.confluence.api.service.content: Provides methods for validating the create, update and delete methods.
SpaceType - Class in com.atlassian.confluence.api.model.content: Represents a type of space, such as GLOBAL or PERSONAL.
status(String) - Method in class com.atlassian.confluence.api.model.longtasks.LongTaskSubmission.LongTaskSubmissionBuilder
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
successful(boolean) - Method in class com.atlassian.confluence.api.model.longtasks.LongTaskStatus.LongTaskBuilder

T

throwCollapsedException(String) - Static method in class com.atlassian.confluence.api.model.reference.Collapsed.Exceptions
throwIfInvalid(String) - Method in class com.atlassian.confluence.api.model.validation.SimpleValidationResult
throwIfInvalid(String) - Method in interface com.atlassian.confluence.api.model.validation.ValidationResult: converts this validation result into an Exception and throws it
TINY_UI - Static variable in class com.atlassian.confluence.api.model.link.LinkType
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.id.JsonContentPropertyId
toString() - Method in class com.atlassian.confluence.api.model.content.JsonContentProperty
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.content.SpaceType
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
toString() - Method in class com.atlassian.confluence.api.model.JsonString
toString() - Method in class com.atlassian.confluence.api.model.pagination.PageResponseImpl
toString() - Method in class com.atlassian.confluence.api.model.pagination.SimplePageRequest
toString() - Method in class com.atlassian.confluence.api.model.reference.ExpandedReference
type(ContentType) - Method in class com.atlassian.confluence.api.model.content.Content.ContentBuilder
type(SpaceType) - Method in class com.atlassian.confluence.api.model.content.Space.SpaceBuilder
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
UNSET - Static variable in class com.atlassian.confluence.api.model.content.id.JsonContentPropertyId
update(Content) - Method in interface com.atlassian.confluence.api.service.content.AttachmentService: Updates the non-data parts of an Attachment Content instance.
update(JsonContentProperty) - Method in interface com.atlassian.confluence.api.service.content.ContentPropertyService: Updates a content property.
update(Content) - Method in interface com.atlassian.confluence.api.service.content.ContentService: Updates a piece of content.
update(Space) - Method in interface com.atlassian.confluence.api.service.content.SpaceService: Updates a space.
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(JsonContentProperty) - Method in interface com.atlassian.confluence.api.service.content.ContentPropertyService.Validator: Validate that a content property can be created, including permission checks.
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.
validateCreate(Space, boolean) - Method in interface com.atlassian.confluence.api.service.content.SpaceService.Validator: Validate that a Space can be added, including permission checks.
validateDelete(Content) - Method in interface com.atlassian.confluence.api.service.content.AttachmentService.Validator: Validate that an Attachment can be deleted, including permission checks.
validateDelete(JsonContentProperty) - Method in interface com.atlassian.confluence.api.service.content.ContentPropertyService.Validator: Validate that a content property 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.
validateDelete(Space) - Method in interface com.atlassian.confluence.api.service.content.SpaceService.Validator: Validate that a Space can be deleted, including permission checks.
validateUpdate(JsonContentProperty) - Method in interface com.atlassian.confluence.api.service.content.ContentPropertyService.Validator: Validate that a content property can be updated, including permission checks.
validateUpdate(Space) - Method in interface com.atlassian.confluence.api.service.content.SpaceService.Validator: Validate that a Space can be updated, 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.AttachmentService: Provides a validator for validating actions on the AttachmentService and checking permissions related to attachments on Content
validator() - Method in interface com.atlassian.confluence.api.service.content.ContentLabelService: Provides a validator for validating actions on the ContentLabelService and checking permissions related to labels on Content
validator() - Method in interface com.atlassian.confluence.api.service.content.ContentPropertyService
validator() - Method in interface com.atlassian.confluence.api.service.content.ContentService: Get the validator view of the ContentService.
validator() - Method in interface com.atlassian.confluence.api.service.content.SpaceService: Get the validator view of the Space Service.
value(JsonString) - Method in class com.atlassian.confluence.api.model.content.JsonContentProperty.ContentPropertyBuilder
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: Don't use this method - it's just for Jersey QueryParam automatic conversion.
valueOf(String) - Static method in class com.atlassian.confluence.api.model.content.id.JsonContentPropertyId: Deprecated.
Don't use. Use JsonContentPropertyId.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
valueOf(String) - Static method in class com.atlassian.confluence.api.model.link.LinkType
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(Version) - Method in class com.atlassian.confluence.api.model.content.JsonContentProperty.ContentPropertyBuilder
version(Reference<Version>) - Method in class com.atlassian.confluence.api.model.content.JsonContentProperty.ContentPropertyBuilder
VERSION - Static variable in class com.atlassian.confluence.api.model.content.JsonContentProperty.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

WEB_UI - Static variable in class com.atlassian.confluence.api.model.link.LinkType
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
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
withContainer(Container) - Method in interface com.atlassian.confluence.api.service.content.ContentService.ParameterContentFinder: Restrict the fetched content to those with the given Container, this will by proxy restrict to certain types of content, as different types of content can have different types of containers.
withContainerId(ContentId) - Method in interface com.atlassian.confluence.api.service.content.AttachmentService.AttachmentFinder: Restrict the attachments returned to those with the given parent.
withContentId(ContentId) - Method in interface com.atlassian.confluence.api.service.content.ContentPropertyService.ParameterContentPropertyFinder
withContentVersion(int) - Method in interface com.atlassian.confluence.api.service.content.ContentMacroService.MacroInstanceFinder: Apply a filter for the content to search, if this is not specified the latest version of the content will be used.
withCreatedDate(LocalDate) - Method in interface com.atlassian.confluence.api.service.content.ContentService.ParameterContentFinder: Restrict the fetched content to those created / published on the given date
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
withFilename(String) - Method in interface com.atlassian.confluence.api.service.content.AttachmentService.AttachmentFinder: Restrict the attachments fetched to those with the given filename.
withHash(String) - Method in interface com.atlassian.confluence.api.service.content.ContentMacroService.MacroInstanceFinder: Apply a filter of the hash of the macro body, this is currently mandatory.
withId(ContentId) - Method in interface com.atlassian.confluence.api.service.content.AttachmentService.AttachmentFinder: Restrict the attachment returned by the fetch methods to those with the given attachmentId
withId(JsonContentPropertyId) - Method in interface com.atlassian.confluence.api.service.content.ContentPropertyService.ContentPropertyFinder
withId(ContentId) - Method in interface com.atlassian.confluence.api.service.content.ContentService.ContentFinder: Restrict the fetched content to that with the given ContentId
withKey(String) - Method in interface com.atlassian.confluence.api.service.content.ContentPropertyService.ParameterContentPropertyFinder
withKeyAndArgs(String, Object...) - Static method in class com.atlassian.confluence.api.model.messages.SimpleMessage: Creates a new SimpleMessage with the given key and arguments.
withKeys(String...) - Method in interface com.atlassian.confluence.api.service.content.SpaceService.SpaceFinder
withLocator(ContentLocator) - Method in interface com.atlassian.confluence.api.service.content.ContentService.ContentFinder: Restrict the fetched content to that matching the given ContentLocator, a ContentLocator identifies a single piece of content.
withMediaType(String) - Method in interface com.atlassian.confluence.api.service.content.AttachmentService.AttachmentFinder: Restrict the attachments fetched to those with the given file type, these file types should match the string representation of a type in javax.ws.rs.core.MediaType
withSpace(Space...) - Method in interface com.atlassian.confluence.api.service.content.ContentService.ParameterContentFinder: Restrict the fetched content to those in the given spaces.
withTitle(String) - Method in interface com.atlassian.confluence.api.service.content.ContentService.ParameterContentFinder: Restrict the fetched content to those with the given title
withTranslation(String) - Static method in class com.atlassian.confluence.api.model.messages.SimpleMessage: Used when a message only has a translated string at creation time, usually in English.
withType(ContentType...) - Method in interface com.atlassian.confluence.api.service.content.ContentService.ParameterContentFinder: Restrict the fetched content to those matching the given contentType
WithValidationResult - Interface in com.atlassian.confluence.api.model.validation: Represents an object that carries a validation result.

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