com.atlassian.confluence.plugins.quicknav.resources
Class QuickNavResource
java.lang.Object
com.atlassian.confluence.plugins.quicknav.resources.QuickNavResource
public class QuickNavResource
- extends java.lang.Object
This is the resource that provides QuickNav search endpoints to Confluence Users. Try and keep it light and make the
ContentNameSearchService
contain the majority of the logic.
Method Summary |
javax.ws.rs.core.Response |
getQuickNavResults(javax.servlet.http.HttpServletRequest httpServletRequest,
java.lang.String query,
java.util.List<java.lang.String> types,
java.lang.String spaceKey,
java.lang.Integer maxPerCategoryNullableDefault)
This is the primary Confluence QuickNav endpoint, it provides the majority (if not all) of the search results in
the QuickNav dropdown. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
QuickNavResource
public QuickNavResource(ContentNameSearchService contentNameSearchService)
getQuickNavResults
public javax.ws.rs.core.Response getQuickNavResults(@Context
javax.servlet.http.HttpServletRequest httpServletRequest,
java.lang.String query,
java.util.List<java.lang.String> types,
java.lang.String spaceKey,
java.lang.Integer maxPerCategoryNullableDefault)
- This is the primary Confluence QuickNav endpoint, it provides the majority (if not all) of the search results in
the QuickNav dropdown.
- Parameters:
httpServletRequest
- The HttpServletRequest
that was made by this request. Important to know the request context.query
- The actual query string that the user was searching for.types
- Content is grouped by 'type'. This is a list of all of the 'types' of content that you wish to search through.spaceKey
- You can provide the single key of a space to restrict the QuickNav search to results within that space.maxPerCategoryNullableDefault
- The maximum results per category/type that will be returned. Pass in null if you wish to use the default maxima.
- Returns:
- The QuickNav Search results.
Copyright © 2003-2014 Atlassian. All Rights Reserved.