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

Interface RemoteWebView

All Known Implementing Classes:

AbstractRemoteWebView, GraphQLRemoteWebViewImpl, RemoteWebViewImpl

public interface RemoteWebView

Remote helper class for fetching WebView from the REST API, This gets its data from /rest/experimental/webfragment

Method Summary

Modifier and Type	Method	Description
com.atlassian.util.concurrent.Promise<Iterable<WebItemView>>	getItemsForSection(String section, Map<String,Object> additionalContext)	Deprecated. since 7.0.1.
CompletionStage<Iterable<WebItemView>>	getItemsForSectionCompletionStage(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)	Deprecated. since 7.0.1.
CompletionStage<Iterable<WebPanelView>>	getPanelsForLocationCompletionStage(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)	Deprecated. since 7.0.1.
CompletionStage<Iterable<WebPanelView>>	getPanelsForLocationsCompletionStage(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)	Deprecated. since 7.0.1.
CompletionStage<Iterable<WebSectionView>>	getSectionsForLocationCompletionStage(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)	Deprecated. since 7.0.1.
CompletionStage<Iterable<WebSectionView>>	getSectionsForLocationsCompletionStage(Collection<String> locations, Map<String,Object> additionalContext)	Fetch web sections for given locations from the REST API

Method Detail

getItemsForSection

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

Deprecated.

since 7.0.1. Use getItemsForSectionCompletionStage(String, Map) instead.

getSectionsForLocation

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

Deprecated.

since 7.0.1. Use getSectionsForLocationCompletionStage(String, Map) instead.

Fetch web sections for a given location from the REST API

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

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

Deprecated.

since 7.0.1. Use getSectionsForLocationsCompletionStage(Collection, Map) instead.

Fetch web sections for given locations from the REST API

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

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

Deprecated.

since 7.0.1. Use getPanelsForLocationCompletionStage(String, Map) instead.

Fetch web panels for a given location from the REST API

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

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

Deprecated.

since 7.0.1. Use getPanelsForLocationsCompletionStage(Collection, Map) instead.

Fetch web panels for given locations from the REST API

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

getItemsForSectionCompletionStage

CompletionStage<Iterable<WebItemView>> getItemsForSectionCompletionStage(String section,
                                                                         Map<String,Object> additionalContext)

Fetch web items for a section from the REST API

Parameters:

section - the section to fetch web items for

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

Returns:

a CompletionStage of an iterable of webItemViews for the given section

Since:

7.0.1

getSectionsForLocationCompletionStage

CompletionStage<Iterable<WebSectionView>> getSectionsForLocationCompletionStage(String location,
                                                                                Map<String,Object> additionalContext)

Fetch web sections for a given location from the REST API

Parameters:

location - the section to fetch web items for

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

Returns:

a CompletionStage of an iterable of WebSectionViews for the given location

Since:

7.0.1

getSectionsForLocationsCompletionStage

CompletionStage<Iterable<WebSectionView>> getSectionsForLocationsCompletionStage(Collection<String> locations,
                                                                                 Map<String,Object> additionalContext)

Fetch web sections for given locations from the REST API

Parameters:

locations - the locations to fetch web items for

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

Returns:

a CompletionStage of an iterable of WebSectionViews for the given location

Since:

7.0.1

getPanelsForLocationCompletionStage

CompletionStage<Iterable<WebPanelView>> getPanelsForLocationCompletionStage(String location,
                                                                            Map<String,Object> additionalContext)

Fetch web panels for a given location from the REST API

Parameters:

location - the location to fetch web items for

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

Returns:

a CompletionStage of an iterable of WebPanelViews for the given location

Since:

7.0.1

getPanelsForLocationsCompletionStage

CompletionStage<Iterable<WebPanelView>> getPanelsForLocationsCompletionStage(Collection<String> locations,
                                                                             Map<String,Object> additionalContext)

Fetch web panels for given locations from the REST API

Parameters:

locations - the locations to fetch web items for

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

Returns:

a CompletionStage of an iterable of WebPanelViews for the given location

Since:

7.0.1