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 Details

    • 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:
      9.0

    • 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:
      9.0

    • 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:
      9.0

    • 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:
      9.0

    • 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:
      9.0