Package lumis.service.doui.htmlsnippet

Class HtmlSnippetResource

  • @Path("/lumis/service/doui/htmlsnippet")
public class HtmlSnippetResource
extends java.lang.Object
    Resource that returns information used by the html snippet editor
    Since:
    15.0.0

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getInsertMarkers​(@NotNull java.lang.String serviceInstanceId)  
      java.lang.String getWidgetHtml​(@NotNull @NotBlank java.lang.String widgetId, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
      Renders a widget and returns its HTML for use.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • HtmlSnippetResource

        public HtmlSnippetResource()

    • Method Detail

      • getInsertMarkers

        @Path("/getinsertmarkers")
@GET
@Produces("application/json")
public java.lang.String getInsertMarkers​(@QueryParam("serviceInstanceId") @NotNull
                                         @NotNull java.lang.String serviceInstanceId)
                                  throws PortalException
        Throws:
        PortalException

      • getWidgetHtml

        @GET
@Produces("text/plain")
@Path("/widgetHtml/{widgetId:[a-fA-F0-9]{32}}")
public java.lang.String getWidgetHtml​(@PathParam("widgetId") @NotNull @NotBlank
                                      @NotNull @NotBlank java.lang.String widgetId,
                                      @Context
                                      javax.servlet.http.HttpServletRequest request,
                                      @Context
                                      javax.servlet.http.HttpServletResponse response)
                               throws PortalException
        Renders a widget and returns its HTML for use.
        Parameters:
        widgetInstanceId - the identifier of the widget instance.
        response - the HttpServletResponse.
        request - the HttpServletRequest.
        Returns:
        the HTML.
        Throws:
        PortalException
        Since:
        17.1.0