Package lumis.portal.commandpalette

Class CommandPaletteResource

  • @Path("/lum-internal/admin/commandpalette")
public class CommandPaletteResource
extends java.lang.Object
    Command palette resource.
    Since:
    10.3.0
    Version:
    $Revision$ $Date$

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getSuggestions​(java.lang.String hint)
      Returns the suggestions for the given hint.
      java.lang.String searchContents​(@NotEmpty java.lang.String autoAdminChannelId, @NotEmpty java.lang.String userQuery)
      Returns contents for a command palette search in content administration mode.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • CommandPaletteResource

        public CommandPaletteResource()

    • Method Detail

      • getSuggestions

        @Path("/suggest")
@GET
@Produces("application/json")
public java.lang.String getSuggestions​(@QueryParam("q")
                                       java.lang.String hint)
                                throws PortalException
        Returns the suggestions for the given hint.
        Parameters:
        hint - the hint.
        Returns:
        the suggestions for the given hint.
        Throws:
        PortalException
        Since:
        10.3.0

      • searchContents

        @Path("/searchContents/{autoAdminChannelId: [A-F0-9]{32}}")
@GET
@Produces("application/json")
public java.lang.String searchContents​(@NotEmpty @PathParam("autoAdminChannelId")
                                       @NotEmpty java.lang.String autoAdminChannelId,
                                       @NotEmpty @QueryParam("q")
                                       @NotEmpty java.lang.String userQuery)
                                throws PortalException
        Returns contents for a command palette search in content administration mode.
        Parameters:
        autoAdminChannelId - the current auto administration target channel identifier.
        userQuery - the user query.
        Returns:
        a JSON with the search results.
        Throws:
        PortalException
        Since:
        17.0.0