Uses of Class
com.atlassian.confluence.api.model.Expansion
Package
Description
This package contains the code which communicates with Confluence via REST API.
-
Uses of Expansion in com.atlassian.confluence.api.impl.service.content
Modifier and TypeMethodDescriptionContentServiceImpl.buildContent
(ContentEntityObject entity, List<ContentStatus> statuses, Expansion... expansions) ContentBodyConversionManagerImpl.convert
(ContentRepresentation fromFormat, String value, ContentRepresentation toFormat, ContentEntityObject ceo, Expansion... expansions) ContentBodyConversionServiceImpl.convert
(ContentBody contentBody, ContentRepresentation toFormat, Expansion... expansions) ContentBodyConversionServiceImpl.convertBody
(Content content, ContentRepresentation toFormat, Expansion... expansions) ChildContentServiceImpl.findContent
(ContentId parentId, Expansion... expansions) SpaceServiceImpl.findContent
(Space space, Expansion... expansions) ContentMacroServiceImpl.findInContent
(ContentId contentId, Expansion... expansion) ContentTrashServiceImpl.getTrashContents
(Space space, LimitedRequest request, Expansion... expansions) ContentVersionServiceImpl.restore
(ContentId contentId, VersionRestoreParameters versionRestoreParameters, Expansion... expansions) -
Uses of Expansion in com.atlassian.confluence.api.impl.service.content.draft
Modifier and TypeMethodDescriptionContentDraftServiceImpl.publishNewDraft
(Content content, Expansion... expansions) LegacyContentDraftServiceImpl.publishNewDraft
(Content content, Expansion... expansions) SharedContentDraftServiceImpl.publishNewDraft
(Content content, Expansion... expansions) Deprecated.since 5.9 - we use the same method for publishing drafts for new pages and for page edits -
Uses of Expansion in com.atlassian.confluence.api.impl.service.content.factory
Modifier and TypeMethodDescriptionContentBlueprintInstanceFactory.convertToInstance
(ContentEntityObject ceo, ContentBlueprintInstance contentBlueprintInstance, Expansion... expansions) Deprecated.DefaultContentBlueprintInstanceFactory.convertToInstance
(ContentEntityObject ceo, ContentBlueprintInstance contentBlueprintInstance, Expansion... expansions) -
Uses of Expansion in com.atlassian.confluence.api.impl.service.content.finder
Modifier and TypeMethodDescriptionContentFinderFactory.createContentFinder
(ContentServiceImpl contentService, Expansion... expansions) VersionFinderFactory.createVersionFinder
(ContentVersionServiceImpl contentVersionService, Expansion... expansions) -
Uses of Expansion in com.atlassian.confluence.api.impl.service.longtasks
Modifier and TypeMethodDescriptionLongTaskServiceImpl.getAll
(PageRequest request, Expansion... expansions) LongTaskServiceImpl.getStatus
(LongTaskId id, Expansion... expansions) -
Uses of Expansion in com.atlassian.confluence.api.impl.service.people
Modifier and TypeMethodDescriptionPersonServiceImpl.getCurrentUser
(Expansion... expansions) ReadOnlyPersonService.getCurrentUser
(Expansion... expansions) ModifierConstructorDescriptionGroupFinderImpl
(Expansion[] expansions) PersonFinderImpl
(Expansion... expansions) -
Uses of Expansion in com.atlassian.confluence.api.impl.service.permissions
Modifier and TypeMethodDescriptionContentRestrictionServiceImpl.addRestrictions
(ContentId target, Collection<? extends ContentRestriction> contentRestrictions, Expansion... expansions) ContentRestrictionServiceImpl.deleteAllDirectRestrictions
(ContentId target, Expansion... expansions) ContentRestrictionServiceImpl.getRestrictions
(ContentId target, PageRequest pageRequest, Expansion... allExpansions) ContentRestrictionServiceImpl.getRestrictionsForOperation
(ContentId target, OperationKey operationKey, PageRequest pageRequest, Expansion... allExpansions) ContentRestrictionServiceImpl.getRestrictionsGroupByOperation
(ContentId target, Expansion... allExpansions) ContentRestrictionServiceImpl.updateRestrictions
(ContentId target, Collection<? extends ContentRestriction> contentRestrictions, Expansion... expansions) -
Uses of Expansion in com.atlassian.confluence.api.model
Modifier and TypeClassDescriptionclass
A subclass ofExpansion
that provides a graphql query instead of a field expansion list. -
Uses of Expansion in com.atlassian.confluence.api.service.content
Modifier and TypeMethodDescriptionContentBodyConversionService.convert
(ContentBody body, ContentRepresentation representation, Expansion... expansions) Convert a ContentBody value into another format, performing validation during the conversion.ContentBodyConversionService.convertBody
(Content content, ContentRepresentation representation, Expansion... expansions) Convert the single ContentBody value in aContent
body map into another format, performing validation during the conversion.Create a piece of content.ContentBlueprintService.createInstance
(ContentBlueprintInstance blueprintInstance, Expansion... expansions) Creates an attachment finder for locating attachments.Create aContentPropertyService.ContentPropertyFinder
for locating content, the expansions will be applied to each property that matches the finder.Create a ContentFinder for locating content, the expansions will be applied to each piece of content that matches the finder.Returns a finder interface for setting search criterion for versions or content.Create aSpacePropertyService.SpacePropertyFinder
for locating properties, the expansions will be applied to each property that matches the finder.Create a space finder to locate spaces, the expansions will be applied to each Space matching the restrictions on the finder.ChildContentService.findContent
(ContentId parentId, Expansion... expansion) A finder to locateContent
under a parent.SpaceService.findContent
(Space space, Expansion... expansion) A finder to locate content in the spaceContentMacroService.findInContent
(ContentId contentId, Expansion... expansion) Create a macro instance finder to locate macro instances in the given ContentContentTrashService.getTrashContents
(Space space, LimitedRequest request, Expansion... expansions) Retrieve a subset of the contents of the trash for a particular space.ContentBlueprintService.publishInstance
(Content content, Expansion... expansions) ContentDraftService.publishNewDraft
(Content content, Expansion... expansions) Publishes the draft.ContentVersionService.restore
(ContentId contentId, VersionRestoreParameters versionRestoreParameters, Expansion... expansions) Restore on version of content, update current content with that version then increment version number of current version. -
Uses of Expansion in com.atlassian.confluence.api.service.content.template
Modifier and TypeMethodDescriptionContentTemplateService.create
(ContentTemplate contentTemplate, Expansion... expand) Create Template.default ContentBlueprintInstance
ContentTemplateService.createInstance
(ContentBlueprintInstance blueprintInstance, Expansion... expansions) Create a page/draft content from a template.Creates an Template finder for locating Templates.ContentTemplateService.getTemplate
(ContentTemplateId contentTemplateId, Expansion... expansions) Return an individual template.ContentTemplateService.getTemplates
(ContentTemplateType contentTemplateType, Optional<Space> space, PageRequest pageRequest, Expansion... expansions) Returns templates of the current space, or returns global templates if no space specified.ContentTemplateService.update
(ContentTemplate contentTemplate, Expansion... expansions) Update an existing template -
Uses of Expansion in com.atlassian.confluence.api.service.longtasks
Modifier and TypeMethodDescriptionLongTaskService.getAll
(PageRequest request, Expansion... expansions) Returns the status of all tracked long-running tasks visible to the user.LongTaskService.getStatus
(LongTaskId id, Expansion... expansions) Returns the status of a long-running task. -
Uses of Expansion in com.atlassian.confluence.api.service.people
Modifier and TypeMethodDescriptionCreate a GroupFinder for locating groups, the expansions will be applied to each group that matches the finder.Create a person finder to locate persons Restrictions can be applied to the finder using the appropriate withFoo() methodPersonService.getCurrentUser
(Expansion... expansions) Get the currently logged in user -
Uses of Expansion in com.atlassian.confluence.api.service.permissions
Modifier and TypeMethodDescriptionContentRestrictionService.addRestrictions
(ContentId target, Collection<? extends ContentRestriction> contentRestrictions, Expansion... expansions) Attempts to add all the restrictions specified to a piece of content identified bycontentId
.ContentRestrictionService.deleteAllDirectRestrictions
(ContentId target, Expansion... expansions) Attempts to delete all the restrictions specified directly on a piece of content identified bycontentId
.ContentRestrictionService.getRestrictions
(ContentId target, PageRequest pageRequest, Expansion... expansions) Retrieves all the restrictions for all the operations on a given Content.ContentRestrictionService.getRestrictionsForOperation
(ContentId target, OperationKey operationKey, PageRequest pageRequest, Expansion... expansions) Retrieves all restrictions for given operation key on given content.ContentRestrictionService.getRestrictionsGroupByOperation
(ContentId target, Expansion... expansions) List all restrictions that exist directly on the given content.ContentRestrictionService.updateRestrictions
(ContentId target, Collection<? extends ContentRestriction> contentRestrictions, Expansion... expansions) Sets all the restrictions specified to a piece of content identified bycontentId
, replacing any existing permissions. -
Uses of Expansion in com.atlassian.confluence.api.service.relations
Modifier and TypeMethodDescriptionRelationService.RelatableFinder.fetchMany
(PageRequest pageRequest, Expansion... expansions) -
Uses of Expansion in com.atlassian.confluence.api.service.search
Modifier and TypeMethodDescriptionCQLSearchService.search
(String cqlInput, SearchOptions searchOptions, PageRequest pageRequest, Expansion... expansions) Execute a CQL search query and fetch a page of results.CQLSearchService.searchContent
(String cqlInput, Expansion... expansions) Execute a CQL search query and fetch a page results.CQLSearchService.searchContent
(String cqlInput, PageRequest pageRequest, Expansion... expansions) Execute a CQL search query and fetch a page results.CQLSearchService.searchContent
(String cqlInput, SearchContext searchContext, PageRequest pageRequest, Expansion... expansions) Execute a CQL search query and fetch a page results. -
Uses of Expansion in com.atlassian.confluence.dmz.service.content
Modifier and TypeMethodDescriptionContentBodyConversionManager.convert
(ContentRepresentation from, String value, ContentRepresentation to, ContentEntityObject ceo, Expansion... expansions) Computes the converted value of the ContentBody and the required web resources that may be needed to render the converted value. -
Uses of Expansion in com.atlassian.confluence.it.rpc.delegates
-
Uses of Expansion in com.atlassian.confluence.pages.templates
Modifier and TypeMethodDescriptionContentBlueprintInstanceFactory.convertToInstance
(ContentEntityObject ceo, ContentBlueprintInstance contentBlueprintInstance, Expansion... expansions) -
Uses of Expansion in com.atlassian.confluence.plugins.contentproperty
Modifier and TypeMethodDescriptionContentPropertyFinderFactory.createContentPropertyFinder
(Expansion... expansions) ContentPropertyFinderFactory.createContentPropertyFinder
(ContentPropertyFinderPermissionCheck permissionCheck, Expansion... expansions) -
Uses of Expansion in com.atlassian.confluence.plugins.contentproperty.spaceproperty
Modifier and TypeMethodDescriptionSpacePropertyFinderFactory.createSpacePropertyFinder
(Expansion... expansions) -
Uses of Expansion in com.atlassian.confluence.plugins.like.notifications
Modifier and TypeMethodDescriptionprotected abstract Expansion[]
AbstractLikeEventRenderContextProvider.getMediumSpecificExpansions()
protected Expansion[]
LikeEventEmailRenderContextProvider.getMediumSpecificExpansions()
-
Uses of Expansion in com.atlassian.confluence.rest.api.model
Modifier and TypeMethodDescriptionstatic Expansion[]
Converts a string representation of a collection of Expansions back into anExpansion
array.static Expansion[]
ExpansionsParser.parseExperimental
(@Nullable String expand) Converts a string representation of a collection of Expansions back into anExpansion
array.static Expansion
ExpansionsParser.parseExperimentalSingle
(String expand) Same as callingExpansionsParser.parseSingle(java.lang.String)
, but allows for experimental expansions.static Expansion
ExpansionsParser.parseSingle
(String expand) Converts a string representation of a single Expansion back into an Expansion. -
Uses of Expansion in com.atlassian.confluence.rest.client
Modifier and TypeFieldDescriptionprotected final Expansion[]
AbstractRemoteContentService.AbstractRemoteContentFinder.expansions
Modifier and TypeMethodDescriptionprotected com.sun.jersey.api.client.WebResource
AbstractRemoteService.addExpansions
(com.sun.jersey.api.client.WebResource resource, @Nullable Expansion[] expansions) add the expansions to the WebResource as a query param, this specifies which properties on the results to expandRemoteContentRestrictionService.addRestrictionsCompletionStage
(ContentId target, Collection<? extends ContentRestriction> contentRestrictions, Expansion... expansions) Attempts to add all the restrictions specified to a piece of content identified bycontentId
.RemoteContentRestrictionServiceImpl.addRestrictionsCompletionStage
(ContentId target, Collection<? extends ContentRestriction> contentRestrictions, Expansion... expansions) protected boolean
AbstractRemoteContentService.containsExperimentalExpansion
(Expansion[] expansions) RemoteContentBodyConversionService.convertCompletionStage
(ContentBody body, ContentRepresentation representation, Expansion... expansions) Convert a ContentBody value into another format, performing validation during the conversion.RemoteContentBodyConversionServiceImpl.convertCompletionStage
(ContentBody body, ContentRepresentation representation, Expansion... expansions) AbstractRemoteContentService.createCompletionStage
(Content newContent, Expansion... expansions) RemoteContentService.createCompletionStage
(Content newContent, Expansion... expansions) Create a piece of content.RemoteContentTemplateService.createCompletionStage
(ContentTemplate contentTemplate, Expansion... expansions) RemoteContentTemplateService.createInstanceCompletionStage
(ContentBlueprintInstance contentBlueprintInstance, Expansion... expansions) RemoteContentRestrictionService.deleteAllDirectRestrictionsCompletionStage
(ContentId target, Expansion... expansions) Attempts to delete all the restrictions specified directly on a piece of content identified bycontentId
.RemoteContentRestrictionServiceImpl.deleteAllDirectRestrictionsCompletionStage
(ContentId target, Expansion... expansions) Create a content finder to retrieve content from the remote serverReturns a finder interface for setting search criterion for versions or content.RemoteChildContentService.findContent
(ContentId parentId, Expansion... expansions) Create a finder to find content in the given parent.RemoteChildContentServiceImpl.findContent
(ContentId parentId, Expansion... expansion) RemoteSpaceService.findContent
(Space space, Expansion... expansion) Create a finder to find content in the given space.RemoteSpaceServiceImpl.findContent
(Space space, Expansion... expansion) RemoteContentMacroService.findInContent
(ContentId contentId, Expansion... expansions) Retrieve details about a macro matching the page, version and macro hash.AbstractRemoteContentService.getChildrenCompletionStage
(Content parent, PageRequest pageRequest, Expansion... expansions) RemoteContentService.getChildrenCompletionStage
(Content parent, PageRequest pageRequest, Expansion... expansion) Retrieve the children of an item of Content.RemotePersonService.getCurrentUserCompletionStage
(Expansion... expansions) RemotePersonServiceImpl.getCurrentUserCompletionStage
(Expansion... expansions) RemoteContentRestrictionService.getRestrictionsCompletionStage
(ContentId target, PageRequest pageRequest, Expansion... expansions) Retrieves all the restrictions for all the operations on a given Content.RemoteContentRestrictionServiceImpl.getRestrictionsCompletionStage
(ContentId target, PageRequest pageRequest, Expansion... expansions) RemoteContentRestrictionService.getRestrictionsForOperationCompletionStage
(ContentId target, OperationKey operationKey, PageRequest pageRequest, Expansion... expansions) Retrieves all restrictions for given operation key on given content.RemoteContentRestrictionServiceImpl.getRestrictionsForOperationCompletionStage
(ContentId target, OperationKey operationKey, PageRequest pageRequest, Expansion... expansions) RemoteContentRestrictionService.getRestrictionsGroupByOperationCompletionStage
(ContentId target, Expansion... expansions) List all restrictions that exist directly on the given content.RemoteContentRestrictionServiceImpl.getRestrictionsGroupByOperationCompletionStage
(ContentId target, Expansion... expansions) RemoteLongTaskService.getStatusCompletionStage
(LongTaskId id, Expansion... expansions) Returns the status of a long-running task.RemoteContentTemplateService.getTemplateCompletionStage
(ContentTemplateId contentTemplateId, Expansion... expansions) RemoteContentTemplateService.getTemplatesCompletionStage
(ContentTemplateType contentTemplateType, Optional<Space> space, PageRequest pageRequest, Expansion... expansions) RemoteContentTrashService.getTrashContentsCompletionStage
(Space space, LimitedRequest limitedRequest, Expansion... expansions) RemoteContentBlueprintService.publishInstanceCompletionStage
(Content content, Expansion... expansions) Publishes the draft from blueprints.RemoteContentBlueprintServiceImpl.publishInstanceCompletionStage
(Content content, Expansion... expansions) RemoteContentDraftService.publishNewDraftCompletionStage
(Content content, Expansion... expansions) Publishes the draft.RemoteContentDraftServiceImpl.publishNewDraftCompletionStage
(Content content, Expansion... expansions) RemoteContentVersionService.restoreCompletionStage
(ContentId contentId, VersionRestoreParameters versionRestoreParameters, Expansion... expansions) Restore on version of content, update current content with that version then increment version number of current version.RemoteCQLSearchService.searchCompletionStage
(String cql, SearchOptions searchOptions, PageRequest pageRequest, Expansion... expansions) RemoteCQLSearchServiceImpl.searchCompletionStage
(String cql, SearchOptions searchOptions, PageRequest pageRequest, Expansion... expansions) RemoteCQLSearchService.searchContentCompletionStage
(String cql, Expansion... expansions) RemoteCQLSearchService.searchContentCompletionStage
(String cql, PageRequest request, Expansion... expansions) RemoteCQLSearchService.searchContentCompletionStage
(String cqlInput, SearchContext searchContext, PageRequest pageRequest, Expansion... expansions) RemoteCQLSearchServiceImpl.searchContentCompletionStage
(String cql, Expansion... expansions) RemoteCQLSearchServiceImpl.searchContentCompletionStage
(String cql, PageRequest request, Expansion... expansions) RemoteCQLSearchServiceImpl.searchContentCompletionStage
(String cqlInput, SearchContext searchContext, PageRequest pageRequest, Expansion... expansions) RemoteContentTemplateService.updateCompletionStage
(ContentTemplate contentTemplate, Expansion... expansions) RemoteContentRestrictionService.updateRestrictionsCompletionStage
(ContentId target, Collection<? extends ContentRestriction> contentRestrictions, Expansion... expansions) Sets all the restrictions specified to a piece of content identified bycontentId
, replacing any existing permissions.RemoteContentRestrictionServiceImpl.updateRestrictionsCompletionStage
(ContentId target, Collection<? extends ContentRestriction> contentRestrictions, Expansion... expansions) ModifierConstructorDescriptionprotected
AbstractRemoteContentFinder
(AbstractRemoteContentService otherService, Expansion... expansions) RemoteChildContentFinderImpl
(AbstractRemoteService other, ContentId parentId, Expansion[] expansion) RemoteContentPropertyFinderImpl
(AbstractRemoteService<ContentPropertyService> other, Expansion... expansions) protected
RemotePersonFinderImpl
(AbstractRemoteService other, Expansion... expansions) RemoteSpaceContentFinderImpl
(AbstractRemoteService other, Space space, Expansion[] expansion) protected
RemoteSpaceFinderImpl
(AbstractRemoteService other, Expansion... expansions) protected
RemoteSpacePropertyFinderImpl
(AbstractRemoteService other, Expansion... expansions) -
Uses of Expansion in com.atlassian.confluence.rest.client.graphql
Modifier and TypeMethodDescriptionGraphQLRemoteChildContentServiceImpl.findContent
(ContentId parentId, Expansion... expansion) ModifierConstructorDescriptionRemoteChildContentFinderImpl
(AbstractRemoteService other, ContentId parentId, Expansion[] expansions) -
Uses of Expansion in com.atlassian.confluence.rest.client.impl
Modifier and TypeMethodDescriptionRemoteContentTemplateServiceImpl.createCompletionStage
(ContentTemplate contentTemplate, Expansion... expansions) RemoteContentTemplateServiceImpl.createInstanceCompletionStage
(ContentBlueprintInstance contentBlueprintInstance, Expansion... expansions) RemoteContentMacroServiceImpl.findInContent
(ContentId content, Expansion... expansions) RemoteLongTaskServiceImpl.getStatusCompletionStage
(LongTaskId id, Expansion... expansions) RemoteContentTemplateServiceImpl.getTemplateCompletionStage
(ContentTemplateId contentTemplateId, Expansion... expansions) RemoteContentTemplateServiceImpl.getTemplatesCompletionStage
(ContentTemplateType contentTemplateType, Optional<Space> space, PageRequest pageRequest, Expansion... expansions) RemoteContentTrashServiceImpl.getTrashContentsCompletionStage
(Space space, LimitedRequest limitedRequest, Expansion... expansions) RemoteContentVersionServiceImpl.restoreCompletionStage
(ContentId contentId, VersionRestoreParameters versionRestoreParameters, Expansion... expansions) RemoteContentTemplateServiceImpl.updateCompletionStage
(ContentTemplate contentTemplate, Expansion... expansions) -
Uses of Expansion in com.atlassian.confluence.rest.client.remoteservice.people
Modifier and TypeMethodDescription -
Uses of Expansion in com.atlassian.confluence.rest.v2.api.model
Modifier and TypeMethodDescriptionstatic Expansion[]
Converts a string representation of a collection of Expansions back into anExpansion
array.static Expansion[]
ExpansionsParser.parseExperimental
(@Nullable String expand) Converts a string representation of a collection of Expansions back into anExpansion
array.static Expansion
ExpansionsParser.parseExperimentalSingle
(String expand) Same as callingExpansionsParser.parseSingle(String)
, but allows for experimental expansions.static Expansion
ExpansionsParser.parseSingle
(String expand) Converts a string representation of a single Expansion back into an Expansion.