Uses of Class
com.atlassian.confluence.api.model.Expansions
Packages that use Expansions
Package
Description
This package contains the code which communicates with Confluence via REST API.
-
Uses of Expansions in com.atlassian.confluence.api.extension
Methods in com.atlassian.confluence.api.extension with parameters of type ExpansionsModifier and TypeMethodDescriptionModelMetadataProvider.getMetadata
(Object entity, Expansions expansions) Deprecated.since 5.10 Consider bulk evaluating meta-data by implementing getMetadataForAll.ModelMetadataProvider.getMetadataForAll
(Iterable<Object> entities, Expansions expansions) Fetches metadata for a list of entities, returning a map of maps of metadata. -
Uses of Expansions in com.atlassian.confluence.api.impl
Methods in com.atlassian.confluence.api.impl with parameters of type ExpansionsModifier and TypeMethodDescriptionDefaultApiRestEntityFactory.buildRestEntityFrom
(ContentEntityObject entity, Expansions expansions) DefaultApiRestEntityFactory.buildRestEntityFrom
(Space space, Expansions expansions) DefaultApiRestEntityFactory.buildRestEntityFromContent
(Iterable<? extends ContentEntityObject> entities, Expansions expansions) DefaultApiRestEntityFactory.buildRestEntityFromSpaces
(Iterable<Space> spaces, Expansions expansions) -
Uses of Expansions in com.atlassian.confluence.api.impl.service.content
Methods in com.atlassian.confluence.api.impl.service.content with parameters of type ExpansionsModifier and TypeMethodDescriptionAttachmentServiceImpl.addAttachments
(ContentId containerId, ContentStatus containerStatus, Collection<AttachmentUpload> uploads, boolean allowDuplicated, Expansions expansions) @NonNull PageResponse<Content>
CustomContentServiceImpl.getChildrenOfTypeAndFilter
(@NonNull ContentId parentId, String contentModuleKey, LimitedRequest limitedRequest, Expansions expansions, Depth depth, Predicate<Content> predicate) -
Uses of Expansions in com.atlassian.confluence.api.impl.service.content.factory
Methods in com.atlassian.confluence.api.impl.service.content.factory that return ExpansionsMethods in com.atlassian.confluence.api.impl.service.content.factory with parameters of type ExpansionsModifier and TypeMethodDescriptionVersionFactory.build
(ContentEntityObject entity, Expansions subExpansions, ContentFactory contentFactory) WebResourceDependenciesFactory.build
(WebResourceDependenciesRecorder.RecordedResources recorded, Expansions wrExpansion) Builds aWebResourceDependencies
object from the given expansion and the recorded resource.ContentFactory.builderFrom
(ContentEntityObject entity, ContentType contentType, Expansions expansions) Exposes the content builder that this factory uses to produce content objects, generally don't use this method, it exists as an interim measure whilst legacy drafts are being migrated to shared drafts and we need to be able to attach files to legacy drafts using the rest api.ContentExtensionsFactory.buildExtensions
(ContentConvertible entity, Expansions expansions) ContentFactory.buildFrom
(ContentEntityObject entity, Expansions expansions) ContentFactory.buildFrom
(Iterable<? extends ContentEntityObject> entities, Expansions expansions) ContentTemplateFactory.buildFrom
(PageTemplate hibernateObject, Expansions expansions) Deprecated.ContributorsFactory.buildFrom
(List<ConfluenceUser> editContributors, Expansions expansions) DefaultContentTemplateFactory.buildFrom
(PageTemplate hibernateObject, Expansions expansions) Convert from db entity object into model object.LabelFactory.buildFrom
(Label hibernateObject, Expansions expansions) PersonFactory.buildFrom
(ConfluenceUser hibernateObject, Expansions expansions) SpaceFactory.buildFrom
(long spaceId, Expansions expansions) SpaceFactory.buildFrom
(Space space, Expansions expansions) SpaceFactory.buildFrom
(String spaceKey, Expansions expansions) ContentExtensionsFactory.containerEntity
(ContentConvertible entity, Expansions expansions) static Fauxpansions
Fauxpansions.fauxpansions
(Expansions expansions, String propertyName) @NonNull Person
PersonFactory.forCurrentUser
(Expansions expansions) Construct the person object for the current user.PersonFactory.forUser
(ConfluenceUser user, Expansions expansions) Construct the person object for a particular user.PersonFactory.forUser
(ConfluenceUser user, Expansions expansions, boolean profilePictureIncludedByDefault) Construct the person object for a particular user.PersonFactory.forUserKey
(String userKey, Expansions expansions) Construct the person object for a particular userKey.PersonFactory.forUserKeyWithoutProfile
(String userKey, Expansions expansions) Find a person by user keyPersonFactory.forUserWithLoginInfo
(ConfluenceUser user, Expansions expansions) PersonFactory.fromUser
(@NonNull ConfluenceUser user, Expansions expansions) Constructs a User object for a particular user.ChildSupport.getChildrenList
(ContentConvertible parent, ContentType childType, LimitedRequest limitedRequest, Expansions expansions, Depth depth, Collection<String> location) ChildSupport.getChildrenMap
(ContentSelector parentSelector, LimitedRequest limitedRequest, Expansions childExpansions, Depth depth) ChildSupport.getChildrenMap
(ContentSelector parentSelector, LimitedRequest limitedRequest, Expansions childExpansions, Depth depth, Collection<String> location) ChildSupport.getChildrenMap
(ContentConvertible parent, LimitedRequest limitedRequest, Expansions childExpansions, Depth depth, Collection<String> location) Called from theContentFactory
when expanding "children" on a Content item being built.ContentBodyFactory.makeContentBodies
(ContentEntityObject ceo, BodyContent bodyContent, Expansions expansions, ContentFactory contentFactory) -
Uses of Expansions in com.atlassian.confluence.api.impl.service.content.finder
Methods in com.atlassian.confluence.api.impl.service.content.finder that return Expansions -
Uses of Expansions in com.atlassian.confluence.api.impl.service.content.typebinding
Methods in com.atlassian.confluence.api.impl.service.content.typebinding with parameters of type ExpansionsModifier and TypeMethodDescriptionAttachmentContentTypeApiSupport.getAttachments
(ContentId containerId, LimitedRequest limitedRequest, com.google.common.base.Predicate<? super Attachment> predicate, Expansions contentExpansions) AttachmentContentTypeApiSupport.getById
(ContentId attachmentId, List<ContentStatus> statuses, Expansions expansions) protected PageResponse<Content>
AttachmentContentTypeApiSupport.getChildrenForThisType
(Attachment content, LimitedRequest limitedRequest, Expansions expansions, Depth depth) protected PageResponse<Content>
BlogPostContentTypeApiSupport.getChildrenForThisType
(BlogPost content, LimitedRequest limitedRequest, Expansions expansions, Depth depth) protected PageResponse<Content>
CommentContentTypeApiSupport.getChildrenForThisType
(Comment content, LimitedRequest limitedRequest, Expansions expansions, Depth depth) protected PageResponse<Content>
PageContentTypeApiSupport.getChildrenForThisType
(Page content, LimitedRequest limitedRequest, Expansions expansions, Depth depth) AttachmentContentTypeApiSupport.getChildrenOfThisTypeForOtherType
(ContentConvertible parent, LimitedRequest limitedRequest, Expansions expansions, Depth depth) protected PageResponse<Content>
BlogPostContentTypeApiSupport.getChildrenOfThisTypeForOtherType
(ContentConvertible otherTypeParent, LimitedRequest limitedRequest, Expansions expansions, Depth depth) protected PageResponse<Content>
CommentContentTypeApiSupport.getChildrenOfThisTypeForOtherType
(ContentConvertible otherTypeParent, LimitedRequest limitedRequest, Expansions expansions, Depth depth) protected PageResponse<Content>
PageContentTypeApiSupport.getChildrenOfThisTypeForOtherType
(ContentConvertible otherTypeParent, LimitedRequest limitedRequest, Expansions expansions, Depth depth) AttachmentContentTypeApiSupport.getExtensions
(Iterable<Attachment> attachments, Expansions expansions) CommentContentTypeApiSupport.getExtensions
(Iterable<Comment> contentEntities, Expansions expansions) PageContentTypeApiSupport.getExtensions
(Iterable<Page> pages, Expansions expansions) protected PageResponse<Content>
CommentContentTypeApiSupport.getFilteredChildrenForThisType
(Comment content, LimitedRequest limitedRequest, Expansions expansions, Depth depth, Predicate<? super ContentEntityObject> predicate) protected PageResponse<Content>
CommentContentTypeApiSupport.getFilteredChildrenOfThisTypeForOtherType
(ContentConvertible otherTypeParent, LimitedRequest limitedRequest, Expansions expansions, Depth depth, Predicate<? super ContentEntityObject> predicate) -
Uses of Expansions in com.atlassian.confluence.api.impl.service.people
Methods in com.atlassian.confluence.api.impl.service.people with parameters of type ExpansionsModifier and TypeMethodDescriptionGroupFactory.buildFrom
(com.atlassian.user.Group hibernateObject, Expansions expansions) -
Uses of Expansions in com.atlassian.confluence.api.impl.service.permissions
Methods in com.atlassian.confluence.api.impl.service.permissions with parameters of type ExpansionsModifier and TypeMethodDescriptionContentRestrictionFactory.buildFrom
(@NonNull ContentPermissionSet set, LimitedRequest limitedRequest, Expansions expansions) Produces aContentRestriction
from aContentPermissionSet
sContentRestrictionFactory.buildFrom
(ContentPermissionSet hibernateObject, Expansions expansions) ContentRestrictionServiceImpl.getRelevantViewRestrictionsForContent
(LimitedRequest limitedReq, Map<Long, Long> contentIdToParentIdMap, Expansions expansions) ContentRestrictionServiceImpl.getRelevantViewRestrictionsForSingleContent
(LimitedRequest pageRequest, ContentId contentId, Expansions expansions) -
Uses of Expansions in com.atlassian.confluence.api.impl.service.relation
Methods in com.atlassian.confluence.api.impl.service.relation with parameters of type ExpansionsModifier and TypeMethodDescriptionRelatableFactory.buildFrom
(S hibernateEntity, Expansions expansions) RelationInstanceFactory.buildFrom
(RelationEntity hibernateObject, Expansions expansions) RelationInstanceFactory.buildFrom
(RelatableEntity sourceEntity, String relationName, RelatableEntity targetEntity, Expansions expansions) -
Uses of Expansions in com.atlassian.confluence.api.model
Fields in com.atlassian.confluence.api.model declared as ExpansionsMethods in com.atlassian.confluence.api.model that return ExpansionsModifier and TypeMethodDescriptionExpansion.getSubExpansions()
Expansions.getSubExpansions
(String propertyName) GraphQLQueryExpansion.getSubExpansions()
Expansions.merge
(Expansions expansions) static Expansions
Create a new Expansions that prepends the propertyName to the path of all expansions represented in this Expansions object.Methods in com.atlassian.confluence.api.model with parameters of type ExpansionsModifier and TypeMethodDescriptionModelFactory.buildFrom
(I model, Expansions expansions) ModelFactory.buildFrom
(Iterable<? extends I> models, Expansions expansions) Expansions.merge
(Expansions expansions) Constructors in com.atlassian.confluence.api.model with parameters of type Expansions -
Uses of Expansions in com.atlassian.confluence.api.service.content
Methods in com.atlassian.confluence.api.service.content with parameters of type ExpansionsModifier and TypeMethodDescriptionAttachmentService.addAttachments
(ContentId containerId, ContentStatus containerStatus, Collection<AttachmentUpload> uploads, boolean allowDuplicated, Expansions expansions) Add one or more attachments to a piece ofContent
.@NonNull PageResponse<Content>
CustomContentService.getChildrenOfTypeAndFilter
(ContentId parentId, String contentModuleKey, LimitedRequest limitedRequest, Expansions expansions, Depth depth, Predicate<Content> predicate) Returns the children of a CustomContentEntityObject, limited to the pagination requested. -
Uses of Expansions in com.atlassian.confluence.api.service.permissions
Methods in com.atlassian.confluence.api.service.permissions with parameters of type ExpansionsModifier and TypeMethodDescriptionContentRestrictionService.getRelevantViewRestrictionsForContent
(LimitedRequest pageRequest, Map<Long, Long> contentIdToParentIdMap, Expansions expansions) Return RelevantViewRestrictions per content where it will contain direct and inherited permission set required to access a contentContentRestrictionService.getRelevantViewRestrictionsForSingleContent
(LimitedRequest pageRequest, ContentId contentId, Expansions expansions) Return RelevantViewRestrictions per content where it will contain direct and inherited permission set required to access a content -
Uses of Expansions in com.atlassian.confluence.content
Methods in com.atlassian.confluence.content with parameters of type ExpansionsModifier and TypeMethodDescription@NonNull PageResponse<CustomContentEntityObject>
CustomContentManager.getChildrenOfTypeAndFilter
(ContentEntityObject entity, String contentModuleKey, LimitedRequest limitedRequest, Expansions expansions, Depth depth, Predicate<? super CustomContentEntityObject> predicate) Returns the children of a CustomContentEntityObject, limited to the pagination requested. -
Uses of Expansions in com.atlassian.confluence.content.apisupport
Methods in com.atlassian.confluence.content.apisupport with parameters of type ExpansionsModifier and TypeMethodDescriptionBaseContentTypeApiSupport.container
(T contentEntity, Expansions expansions) The return type of this method is intentionly broad.ContentTypeApiSupport.container
(T contentEntity, Expansions expansions) The return type of this method is intentionally broad.protected abstract PageResponse<Content>
BaseContentTypeApiSupport.getChildrenForThisType
(T content, LimitedRequest limitedRequest, Expansions expansions, Depth depth) protected abstract PageResponse<Content>
BaseContentTypeApiSupport.getChildrenOfThisTypeForOtherType
(ContentConvertible otherTypeParent, LimitedRequest limitedRequest, Expansions expansions, Depth depth) protected PageResponse<Content>
CustomContentTypeApiSupport.getChildrenOfThisTypeForOtherType
(ContentConvertible otherTypeParent, LimitedRequest limitedRequest, Expansions expansions, Depth depth) BaseContentTypeApiSupport.getExtensions
(Iterable<T> contentEntities, Expansions expansions) Get the set of extension properties for the collection of contentEntity Ids.CommentExtensionsSupport.getExtensions
(Iterable<Comment> comments, Expansions expansions) Get the map of extension properties for each of the comment entitiesContentTypeApiSupport.getExtensions
(Iterable<T> contentEntities, Expansions expansions) Get the set of extension properties for the collection of contentEntity Ids.NullCommentExtensionsSupport.getExtensions
(Iterable<Comment> comments, Expansions expansions) final PageResponse<Content>
BaseContentTypeApiSupport.getFilteredChildren
(ContentConvertible content, LimitedRequest limitedRequest, Expansions expansions, Depth depth, Predicate<? super ContentEntityObject> predicate) Retrieve the children of an item of Content.ContentTypeApiSupport.getFilteredChildren
(ContentConvertible content, LimitedRequest limitedRequest, Expansions expansions, Depth depth, Predicate<? super ContentEntityObject> predicate) Retrieve the children of an item of Content filtered by a predicate.protected PageResponse<Content>
BaseContentTypeApiSupport.getFilteredChildrenForThisType
(T content, LimitedRequest limitedRequest, Expansions expansions, Depth depth, Predicate<? super ContentEntityObject> predicate) This method includes an additional parameter "location", it will call the default one if not overriddenprotected PageResponse<Content>
BaseContentTypeApiSupport.getFilteredChildrenOfThisTypeForOtherType
(ContentConvertible otherTypeParent, LimitedRequest limitedRequest, Expansions expansions, Depth depth, Predicate<? super ContentEntityObject> predicate) This method includes an additional parameter "location", it will call the default one if not overriddenprotected PageResponse<Content>
CustomContentTypeApiSupport.getFilteredChildrenOfThisTypeForOtherType
(ContentConvertible otherTypeParent, LimitedRequest limitedRequest, Expansions expansions, Depth depth, Predicate<? super ContentEntityObject> predicate) -
Uses of Expansions in com.atlassian.confluence.core
Methods in com.atlassian.confluence.core with parameters of type ExpansionsModifier and TypeMethodDescriptionApiRestEntityFactory.buildRestEntityFrom
(ContentEntityObject entity, Expansions expansions) Build a REST API entity from a ContentEntityObject.ApiRestEntityFactory.buildRestEntityFrom
(Space space, Expansions expansions) Build a REST API entity from a hibernate Space object.ApiRestEntityFactory.buildRestEntityFromContent
(Iterable<? extends ContentEntityObject> entities, Expansions expansions) Build a list of REST API entity objects from ContentEntityObject objects.ApiRestEntityFactory.buildRestEntityFromSpaces
(Iterable<Space> spaces, Expansions expansions) Build a list of REST API entity objects from hibernate Space objects. -
Uses of Expansions in com.atlassian.confluence.impl.content
Methods in com.atlassian.confluence.impl.content with parameters of type ExpansionsModifier and TypeMethodDescription@NonNull PageResponse<CustomContentEntityObject>
DefaultCustomContentManager.getChildrenOfTypeAndFilter
(ContentEntityObject entity, String contentModuleKey, LimitedRequest limitedRequest, Expansions expansions, Depth depth, Predicate<? super CustomContentEntityObject> predicate) This method is used by the Content API to retrieve children of a specific type and filter them by a predicate. -
Uses of Expansions in com.atlassian.confluence.pages.templates
Methods in com.atlassian.confluence.pages.templates with parameters of type ExpansionsModifier and TypeMethodDescriptionContentTemplateFactory.buildFrom
(PageTemplate hibernateObject, Expansions expansions) -
Uses of Expansions in com.atlassian.confluence.plugins.contentproperty
Methods in com.atlassian.confluence.plugins.contentproperty with parameters of type ExpansionsModifier and TypeMethodDescriptionJsonPropertyFactory.buildContentPropertyFrom
(CustomContentEntityObject storageContentProperty, Expansions expansions) Convert the given CustomContentEntityObject into a corresponding ContentProperty.com.google.common.base.Function<CustomContentEntityObject,
JsonContentProperty> JsonPropertyFactory.buildContentPropertyFromFunction
(Content content, Expansions expansions) JsonPropertyFactory.buildFrom
(Content content, CustomContentEntityObject storageContentProperty, Expansions expansions) Convert the given CustomContentEntityObject into a corresponding ContentProperty with the given container.JsonPropertyFactory.buildFrom
(Space space, CustomContentEntityObject storageContentProperty, Expansions expansions) JsonPropertyFactory.buildSpacePropertyFrom
(CustomContentEntityObject property, Expansions expansions) Convert the given CustomContentEntityObject into a corresponding SpaceProperty.com.google.common.base.Function<CustomContentEntityObject,
JsonSpaceProperty> JsonPropertyFactory.buildSpacePropertyFromFunction
(Space space, Expansions expansions) -
Uses of Expansions in com.atlassian.confluence.plugins.contentproperty.spaceproperty
Constructors in com.atlassian.confluence.plugins.contentproperty.spaceproperty with parameters of type ExpansionsModifierConstructorDescriptionSpacePropertyFinderImpl
(CustomContentManager customContentManager, PermissionManager permissionManager, JsonPropertyFactory jsonPropertyFactory, SpaceService spaceService, PaginationService paginationService, Expansions expansions) -
Uses of Expansions in com.atlassian.confluence.plugins.like.providers
Methods in com.atlassian.confluence.plugins.like.providers with parameters of type ExpansionsModifier and TypeMethodDescriptionContentLikesMetadataProvider.getMetadataForAll
(Iterable<Object> entities, Expansions expansions) -
Uses of Expansions in com.atlassian.confluence.plugins.restapi.metadata.content
Methods in com.atlassian.confluence.plugins.restapi.metadata.content with parameters of type ExpansionsModifier and TypeMethodDescriptionLabelsModelMetadataProvider.getMetadataForAll
(Iterable<Object> entities, Expansions expansions) PropertiesModelMetadataProvider.getMetadataForAll
(Iterable<Object> entities, Expansions expansions) -
Uses of Expansions in com.atlassian.confluence.rest.client
Methods in com.atlassian.confluence.rest.client with parameters of type ExpansionsModifier and TypeMethodDescriptionRemoteAttachmentService.addAttachmentsCompletionStage
(ContentId containerId, ContentStatus containerStatus, Collection<AttachmentUpload> uploads, boolean allowDuplicated, Expansions expansions) RemoteAttachmentServiceImpl.addAttachmentsCompletionStage
(ContentId containerId, ContentStatus containerStatus, Collection<AttachmentUpload> uploads, boolean allowDuplicated, Expansions expansions) -
Uses of Expansions in com.atlassian.confluence.rest.v2.api.model
Methods in com.atlassian.confluence.rest.v2.api.model that return ExpansionsModifier and TypeMethodDescriptionstatic Expansions
static Expansions
ExpansionsParser.parseAsExpansions
(String expand) Converts a string representation of a collection ofExpansions
into an Expansions instance.static Expansions
ExpansionsParser.parseExperimental
(String... individualExpansions) static Expansions
ExpansionsParser.parseExperimentalAsExpansions
(String expand) Same as callingExpansionsParser.parseAsExpansions(String)
, but allows for experimental expansions.static Expansions
ExpansionsParser.parseExperimentalWithPrefix
(String prefix, String expansions) static Expansions
ExpansionsParser.parseWithPrefix
(String prefix, String expansions) Methods in com.atlassian.confluence.rest.v2.api.model with parameters of type ExpansionsModifier and TypeMethodDescriptionstatic String
ExpansionsParser.asString
(Expansions expansions) Converts aExpansions
collection into a single string. -
Uses of Expansions in com.atlassian.confluence.rest.v2.api.model.pagination
Methods in com.atlassian.confluence.rest.v2.api.model.pagination with parameters of type ExpansionsModifier and TypeMethodDescriptionstatic int
PaginationLimits.childMap
(Expansions expansions) Maximum number of child content objects to return at a time in the children map, depending on which fields are expanded.static int
PaginationLimits.content
(Expansions contentExpansion) Maximum number of content objects to return at a time, depending on which fields are expanded.static int
PaginationLimits.draftChildren
(Expansions expansions) static int
PaginationLimits.spaces
(Expansions expansions) Maximum number of spaces to return at a time, depending on which fields are expanded.static int
PaginationLimits.version
(Expansions expansions)