- 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.journal - package com.atlassian.confluence.api.model.journal
-
- 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.permissions - package com.atlassian.confluence.api.model.permissions
-
- 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.journal - package com.atlassian.confluence.api.service.journal
-
- com.atlassian.confluence.api.service.longtasks - package com.atlassian.confluence.api.service.longtasks
-
- com.atlassian.confluence.api.service.network - package com.atlassian.confluence.api.service.network
-
- com.atlassian.confluence.api.service.pagination - package com.atlassian.confluence.api.service.pagination
-
- com.atlassian.confluence.api.service.people - package com.atlassian.confluence.api.service.people
-
- com.atlassian.confluence.api.service.permissions - package com.atlassian.confluence.api.service.permissions
-
- 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() - Static method in class com.atlassian.confluence.api.model.validation.ServiceExceptionSupplier
-
- 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(Reference<Content>) - Method in class com.atlassian.confluence.api.model.permissions.ContentRestriction.ContentRestrictionBuilder
-
- CONTENT - Static variable in class com.atlassian.confluence.api.model.permissions.ContentRestriction.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
-
- Content.ContentBuilder(ContentType) - Constructor for class com.atlassian.confluence.api.model.content.Content.ContentBuilder
-
- Content.ContentBuilder(ContentType, long) - Constructor for class com.atlassian.confluence.api.model.content.Content.ContentBuilder
-
- 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
-
- ContentId - Class in com.atlassian.confluence.api.model.content.id
-
- 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
-
- 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.
- ContentRestriction - Class in com.atlassian.confluence.api.model.permissions
-
- ContentRestriction.ContentRestrictionBuilder - Class in com.atlassian.confluence.api.model.permissions
-
- ContentRestriction.Expansions - Class in com.atlassian.confluence.api.model.permissions
-
- ContentRestriction.Expansions() - Constructor for class com.atlassian.confluence.api.model.permissions.ContentRestriction.Expansions
-
- ContentRestrictionService - Interface in com.atlassian.confluence.api.service.permissions
-
- 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.
- ContentStatus - Class in com.atlassian.confluence.api.model.content
-
The state of a piece of content.
- 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
-
- ContentTrashService - Interface in com.atlassian.confluence.api.service.content
-
Controls trashing, restoring and purging
Content from the instance.
- ContentTrashService.Validator - Interface in com.atlassian.confluence.api.service.content
-
Provides methods for validating the trash, restore and purge methods.
- ContentType - Class in com.atlassian.confluence.api.model.content
-
Represents a type of content.
- ContentTypeBinding - Interface in com.atlassian.confluence.api.extension.typebinding
-
- contextPath() - Method in interface com.atlassian.confluence.api.nav.Navigation
-
- 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 - Static variable in class com.atlassian.confluence.api.model.permissions.OperationKey
-
- 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
-
- countContent(String) - Method in interface com.atlassian.confluence.api.service.search.CQLSearchService
-
Execute a CQL search query and fetch the number of results found.
- countEntries(JournalIdentifier) - Method in interface com.atlassian.confluence.api.service.journal.JournalService
-
Counts the number of entries in a journal.
- CQLSearchService - Interface in com.atlassian.confluence.api.service.search
-
Entry point into CQL Search.
- create(PageRequest, int) - Static method in class com.atlassian.confluence.api.model.pagination.LimitedRequestImpl
-
- create(int) - Static method in class com.atlassian.confluence.api.model.pagination.LimitedRequestImpl
-
- create(int, int, int) - Static method in class com.atlassian.confluence.api.model.pagination.LimitedRequestImpl
-
- CREATE - Static variable in class com.atlassian.confluence.api.model.permissions.OperationKey
-
- 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
-
- CURRENT - Static variable in class com.atlassian.confluence.api.model.content.ContentStatus
-
The default state of content ready to be viewed and edited.
- failure(V, long) - Static method in class com.atlassian.confluence.api.service.journal.EntryProcessorResult
-
Create a result after a processing failure.
- 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
-
- 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.
- find(Expansion...) - Method in interface com.atlassian.confluence.api.service.people.PersonService
-
Create a person finder to locate persons
Restrictions can be applied to the finder using the appropriate withFoo() method
For example:
- 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
- FORBIDDEN - Static variable in class com.atlassian.confluence.api.model.validation.SimpleValidationResult
-
A singleton unauthorized result.
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- getContent() - Method in class com.atlassian.confluence.api.model.permissions.ContentRestriction
-
- 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
-
- getCreationDate() - Method in class com.atlassian.confluence.api.model.journal.JournalEntry
-
- 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
-
- getDisplayName() - Method in class com.atlassian.confluence.api.model.people.Group
-
- getDisplayName() - Method in class com.atlassian.confluence.api.model.people.Person
-
- getDisplayName() - Method in interface com.atlassian.confluence.api.model.people.Subject
-
Returns a name that is suitable for display to identify the user / group.
- 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
-
- getFailedEntryId() - Method in class com.atlassian.confluence.api.service.journal.EntryProcessorResult
-
- 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
-
- getFollowers(UserKey, PageRequest) - Method in interface com.atlassian.confluence.api.service.network.NetworkService
-
Gets the users who are following the given user.
- getFollowing(UserKey, PageRequest) - Method in interface com.atlassian.confluence.api.service.network.NetworkService
-
Gets the users that the given user is following.
- 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.journal.JournalEntry
-
- 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
-
- getJournalId() - Method in class com.atlassian.confluence.api.model.journal.JournalEntry
-
- getJournalName() - Method in class com.atlassian.confluence.api.model.journal.JournalIdentifier
-
- 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
- getLastSuccessfulId() - Method in class com.atlassian.confluence.api.service.journal.EntryProcessorResult
-
- 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 class com.atlassian.confluence.api.model.pagination.LimitedRequestImpl
-
- 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
-
- getMaxLimit() - Method in class com.atlassian.confluence.api.model.pagination.LimitedRequestImpl
-
- 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.journal.JournalEntry
-
- 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
-
- getName() - Method in class com.atlassian.confluence.api.model.people.Group
-
- getName() - Method in class com.atlassian.confluence.api.model.permissions.OperationKey
-
- getNeeded() - Method in interface com.atlassian.confluence.api.model.pagination.LimitedRequest
-
- getNeeded() - Method in class com.atlassian.confluence.api.model.pagination.LimitedRequestImpl
-
- getNextVersionRef() - Method in class com.atlassian.confluence.api.model.content.History
-
- getNumber() - Method in class com.atlassian.confluence.api.model.content.Version
-
- getOperation() - Method in class com.atlassian.confluence.api.model.permissions.ContentRestriction
-
- getOptionalUsername() - Method in class com.atlassian.confluence.api.model.people.Anonymous
-
- getOptionalUsername() - Method in class com.atlassian.confluence.api.model.people.Person
-
- getOptionalUsername() - Method in class com.atlassian.confluence.api.model.people.User
-
- 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
-
- getRestrictions() - Method in class com.atlassian.confluence.api.model.permissions.ContentRestriction
-
- getRestrictionsGroupByOperation(ContentId, Expansion...) - Method in interface com.atlassian.confluence.api.service.permissions.ContentRestrictionService
-
List all restrictions that exist directly on the given content.
- getResult() - Method in class com.atlassian.confluence.api.service.journal.EntryProcessorResult
-
- 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 class com.atlassian.confluence.api.model.pagination.LimitedRequestImpl
-
- getStart() - Method in interface com.atlassian.confluence.api.model.pagination.PageRequest
-
- getStart() - Method in class com.atlassian.confluence.api.model.pagination.SimplePageRequest
-
- getStatus() - Method in class com.atlassian.confluence.api.model.content.Content
-
- 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.journal.JournalEntry
-
- 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
-
- getUserKey() - Method in class com.atlassian.confluence.api.model.people.Anonymous
-
- getUserKey() - Method in class com.atlassian.confluence.api.model.people.Person
-
- getUserKey() - Method in class com.atlassian.confluence.api.model.people.User
-
- 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.BaseApiEnum
-
- 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
-
- Group - Class in com.atlassian.confluence.api.model.people
-
Represents a group that may contain zero or more users.
- Group(String) - Constructor for class com.atlassian.confluence.api.model.people.Group
-
- GROUP - Static variable in class com.atlassian.confluence.api.model.people.SubjectType
-
- GROUPS - Static variable in class com.atlassian.confluence.api.model.people.SubjectType.Expansions
-
- 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
- partial(V, long) - Static method in class com.atlassian.confluence.api.service.journal.EntryProcessorResult
-
Create a result after having successfully processed some of the entries.
- peek(JournalIdentifier, int) - Method in interface com.atlassian.confluence.api.service.journal.JournalService
-
Return a copy of journal entries that are waiting to be processed.
- 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, String) - Constructor for class com.atlassian.confluence.api.model.people.Person
-
- Person(Icon) - Constructor for class com.atlassian.confluence.api.model.people.Person
-
Deprecated.
5.6 use other constructor
- PERSONAL - Static variable in class com.atlassian.confluence.api.model.content.SpaceType
-
- PersonService - Interface in com.atlassian.confluence.api.service.people
-
Provides READ operation on Persons.
- PersonService.PersonFinder - Interface in com.atlassian.confluence.api.service.people
-
A finder for locating persons.
- PersonService.SinglePersonFetcher - Interface in com.atlassian.confluence.api.service.people
-
only here so that the remote person service can proxy it.
- PersonService.Validator - Interface in com.atlassian.confluence.api.service.people
-
Provides methods for validating the view method.
- 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
-
- processEntries(JournalIdentifier, int, Function<Iterable<JournalEntry>, EntryProcessorResult<V>>) - Method in interface com.atlassian.confluence.api.service.journal.JournalService
-
Processes journal entries that were added since the last time this
method was called for this journal on this cluster node.
- property(JsonContentProperty) - Method in interface com.atlassian.confluence.api.nav.Navigation.ContentNav
-
- PURGE - Static variable in class com.atlassian.confluence.api.model.permissions.OperationKey
-
- purge(Content) - Method in interface com.atlassian.confluence.api.service.content.ContentTrashService
-
Permanently delete a piece of content.
- PURGE_VERSION - Static variable in class com.atlassian.confluence.api.model.permissions.OperationKey
-
- 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
-
- 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
-
- safelyPutToBuilder(ImmutableMap.Builder<K, V>, K, V) - Static method in class com.atlassian.confluence.api.model.reference.BuilderUtils
-
- 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 interface com.atlassian.confluence.api.model.ApiEnum
-
- serialise() - Method in class com.atlassian.confluence.api.model.BaseApiEnum
-
- 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
-
- serialise() - Method in class com.atlassian.confluence.api.model.people.SubjectType
-
- serialise() - Method in class com.atlassian.confluence.api.model.permissions.OperationKey
-
- 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
-
- ServiceExceptionSupplier - Class in com.atlassian.confluence.api.model.validation
-
- ServiceExceptionSupplier() - Constructor for class com.atlassian.confluence.api.model.validation.ServiceExceptionSupplier
-
- 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
-
- SimpleValidationError(Message) - 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
-
- 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(ContentStatus) - Method in class com.atlassian.confluence.api.model.content.Content.ContentBuilder
-
- STATUS - Static variable in class com.atlassian.confluence.api.model.content.Content.Expansions
-
- 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
- Subject - Interface in com.atlassian.confluence.api.model.people
-
Serves as a common ancestor between
Group and
Person so that we may use a type that denotes either of them.
- SubjectType - Class in com.atlassian.confluence.api.model.people
-
Though SubjectType.USER and SubjectType.GROUP are singleton, do NOT assume you can compare an arbitrary SubjectType
with one of those via an equality (==) check.
- SubjectType.Expansions - Class in com.atlassian.confluence.api.model.people
-
Represents the available Expansions when dealing with a Map>
- SubjectType.Expansions() - Constructor for class com.atlassian.confluence.api.model.people.SubjectType.Expansions
-
- success(V) - Static method in class com.atlassian.confluence.api.service.journal.EntryProcessorResult
-
Create result after having successfully processed all entries.
- successful(boolean) - Method in class com.atlassian.confluence.api.model.longtasks.LongTaskStatus.LongTaskBuilder
-
- VALID - Static variable in class com.atlassian.confluence.api.model.validation.SimpleValidationResult
-
A singleton valid result.
- 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.
- validatePurge(Content) - Method in interface com.atlassian.confluence.api.service.content.ContentTrashService.Validator
-
Validate that a piece of content can be purged, including permission checks.
- validateRestore(Content) - Method in interface com.atlassian.confluence.api.service.content.ContentTrashService.Validator
-
Validate that a piece of content can be restored, including permission checks.
- validateTrash(Content) - Method in interface com.atlassian.confluence.api.service.content.ContentTrashService.Validator
-
Validate that a piece of content can be trashed, 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.
- validateView() - Method in interface com.atlassian.confluence.api.service.people.PersonService.Validator
-
Validate that current user can view user profiles
- ValidationError - Interface in com.atlassian.confluence.api.model.validation
-
- 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.ContentTrashService
-
Get the validator view of this service.
- validator() - Method in interface com.atlassian.confluence.api.service.content.SpaceService
-
Get the validator view of the Space Service.
- validator() - Method in interface com.atlassian.confluence.api.service.people.PersonService
-
Get the validator of the Person Service.
- value - Variable in class com.atlassian.confluence.api.model.BaseApiEnum
-
- 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.ContentStatus
-
- valueOf(String) - Static method in class com.atlassian.confluence.api.model.content.ContentType
-
- 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
-
- 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
-
- valueOf(String) - Static method in class com.atlassian.confluence.api.model.people.SubjectType
-
- valueOf(String) - Static method in class com.atlassian.confluence.api.model.permissions.OperationKey
-
- values() - Static method in enum com.atlassian.confluence.api.model.content.Label.Prefix
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- VALUES - Static variable in class com.atlassian.confluence.api.model.people.SubjectType
-
- values() - Static method in class com.atlassian.confluence.api.model.people.SubjectType
-
- 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
-
- VIEW - Static variable in class com.atlassian.confluence.api.model.content.ContentRepresentation
-
HTML representation for viewing in a web page
- waitForRecentEntriesToBecomeVisible() - Method in interface com.atlassian.confluence.api.service.journal.JournalService
-
- 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
- withAnyStatus() - Method in interface com.atlassian.confluence.api.service.content.ContentService.ParameterContentFinder
-
Don't restrict the fetched content on status.
- 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.
- withStatus(ContentStatus...) - Method in interface com.atlassian.confluence.api.service.content.ContentService.ParameterContentFinder
-
Restrict the fetched content to that matching the given statuses.
- withStatus(Iterable<ContentStatus>) - Method in interface com.atlassian.confluence.api.service.content.ContentService.ParameterContentFinder
-
Restrict the fetched content to that matching the given statuses.
- 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
- withUserKey(UserKey) - Method in interface com.atlassian.confluence.api.service.people.PersonService.PersonFinder
-
- WithValidationResult - Interface in com.atlassian.confluence.api.model.validation
-
Represents an object that carries a validation result.