Interface AgentSidebarViewContext

All Superinterfaces:
UserProvider, ViewContext

public interface AgentSidebarViewContext extends ViewContext
This interface provides information and functionality for view context sensitive data and operations to render an AgentSidebarContent.
Since:
11.27
  • Method Summary

    Modifier and Type
    Method
    Description
    getViewUrl(String viewPath)
    This method should be used to prepare the sidebar view url

    Methods inherited from interface com.novomind.ecom.api.iagent.frontend.ViewContext

    getUser
  • Method Details

    • getViewUrl

      String getViewUrl(String viewPath)
      This method should be used to prepare the sidebar view url
      Parameters:
      viewPath - the relative path to the view (.xhtml) or an absolute url. Supported formats: 1. Absolute path without protocol: //host.domain.com/... 2. Absolute path with protocol: http://host.domain.com/... https://host.domain.com/... 3. Relative path to .xhtml file: /helloworld/helloWorldSidebar.xhtml Example:
               public class MySidebarContentProvider implements AgentSidebarContentProvider {
                 @Override
                 public AgentSidebarContent getAgentSidebarContent(AgentSidebarViewContext context) {
                   return new AgentSidebarContent(context.getViewUrl("/helloworld/helloWorldSidebar.xhtml"));
                 }
               }
               
      Returns:
      the correct url to render the view that can be passed to AgentSidebarContent
      Since:
      11.27