com.atlassian.confluence.rest.client.remoteservice.webfragment.graphql

Class GraphQLRemoteWebViewImpl

java.lang.Object

com.atlassian.confluence.rest.client.AbstractRemoteService<WebView>

com.atlassian.confluence.rest.client.remoteservice.webfragment.AbstractRemoteWebView

com.atlassian.confluence.rest.client.remoteservice.webfragment.graphql.GraphQLRemoteWebViewImpl

All Implemented Interfaces:

RemoteWebView

public final class GraphQLRemoteWebViewImpl
extends AbstractRemoteWebView
implements RemoteWebView

RemoteWebView implementation that communicates with Confluence remotely using the Confluence GraphQL API.

Since:

6.12.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GraphQLRemoteWebViewImpl.GraphQLWebItemsResponse
static class	GraphQLRemoteWebViewImpl.GraphQLWebPanelsResponse
static class	GraphQLRemoteWebViewImpl.GraphQLWebSectionsResponse

Field Summary

Fields inherited from class com.atlassian.confluence.rest.client.remoteservice.webfragment.AbstractRemoteWebView

contentId, spaceKey, version

Fields inherited from class com.atlassian.confluence.rest.client.AbstractRemoteService

provider

Method Summary

Modifier and Type	Method and Description
com.atlassian.util.concurrent.Promise<Iterable<WebItemView>>	getItemsForSection(String section, Map<String,Object> additionalContext) Fetch web items for a section from the REST API
com.atlassian.util.concurrent.Promise<Iterable<WebPanelView>>	getPanelsForLocation(String location, Map<String,Object> additionalContext) Fetch web panels for a given location from the REST API
com.atlassian.util.concurrent.Promise<Iterable<WebPanelView>>	getPanelsForLocations(Collection<String> locations, Map<String,Object> additionalContext) Fetch web panels for given locations from the REST API
com.atlassian.util.concurrent.Promise<Iterable<WebSectionView>>	getSectionsForLocation(String location, Map<String,Object> additionalContext) Fetch web sections for a given location from the REST API
com.atlassian.util.concurrent.Promise<Iterable<WebSectionView>>	getSectionsForLocations(Collection<String> locations, Map<String,Object> additionalContext) Fetch web sections for given locations from the REST API

Methods inherited from class com.atlassian.confluence.rest.client.AbstractRemoteService

addExpansions, addPageRequest, addPageRequestParams, deleteFuture, deleteFuture, getFuture, getFutureGenericCollection, getFutureMap, getFutureMapOfPageResponses, getFutureOption, getFuturePageResponseList, newExperimentalRestWebResource, newRestWebResource, postFuture, postFuture, postFuture, postFutureToPageResponse, putFuture

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getItemsForSection

public com.atlassian.util.concurrent.Promise<Iterable<WebItemView>> getItemsForSection(String section,
                                                                                       Map<String,Object> additionalContext)

Description copied from interface: RemoteWebView

Fetch web items for a section from the REST API

Specified by:

getItemsForSection in interface RemoteWebView

Parameters:

section - the section to fetch web items for

additionalContext - additional context to add to the request to satisfy web item conditions

Returns:

a promise of an iterable of webItemViews for the given section

getSectionsForLocation

public com.atlassian.util.concurrent.Promise<Iterable<WebSectionView>> getSectionsForLocation(String location,
                                                                                              Map<String,Object> additionalContext)

Description copied from interface: RemoteWebView

Fetch web sections for a given location from the REST API

Specified by:

getSectionsForLocation in interface RemoteWebView

Parameters:

location - the section to fetch web items for

additionalContext - additional context to add to the request to satisfy web item conditions

Returns:

a promise of an iterable of WebSectionViews for the given location

getSectionsForLocations

public com.atlassian.util.concurrent.Promise<Iterable<WebSectionView>> getSectionsForLocations(Collection<String> locations,
                                                                                               Map<String,Object> additionalContext)

Description copied from interface: RemoteWebView

Fetch web sections for given locations from the REST API

Specified by:

getSectionsForLocations in interface RemoteWebView

Parameters:

locations - the locations to fetch web items for

additionalContext - additional context to add to the request to satisfy web item conditions

Returns:

a promise of an iterable of WebSectionViews for the given location

getPanelsForLocation

public com.atlassian.util.concurrent.Promise<Iterable<WebPanelView>> getPanelsForLocation(String location,
                                                                                          Map<String,Object> additionalContext)

Description copied from interface: RemoteWebView

Fetch web panels for a given location from the REST API

Specified by:

getPanelsForLocation in interface RemoteWebView

Parameters:

location - the location to fetch web items for

additionalContext - additional context to add to the request to satisfy web item conditions

Returns:

a promise of an iterable of WebPanelViews for the given location

getPanelsForLocations

public com.atlassian.util.concurrent.Promise<Iterable<WebPanelView>> getPanelsForLocations(Collection<String> locations,
                                                                                           Map<String,Object> additionalContext)

Description copied from interface: RemoteWebView

Fetch web panels for given locations from the REST API

Specified by:

getPanelsForLocations in interface RemoteWebView

Parameters:

locations - the locations to fetch web items for

additionalContext - additional context to add to the request to satisfy web item conditions

Returns:

a promise of an iterable of WebPanelViews for the given location