:tocdepth: 3

:py:mod:`gws.base.search.action`
================================

.. py:module:: gws.base.search.action

.. autoapi-nested-parse::

   Search API.



**Source code:** :source:`gws.base.search.action<gws/base/search/action.py>`



Module Contents
---------------



.. py:class:: Config


   Bases: :py:obj:`gws.base.action.Config`

   Search action

   .. py:attribute:: categories
      :type:  Optional[list[str]]

      Search categories. (added in 8.2)

   .. py:attribute:: limit
      :type:  int
      :value: 1000


      Search results limit.

   .. py:attribute:: tolerance
      :type:  Optional[gws.UomValueStr]

      Default tolerance.


.. py:class:: Object


   Bases: :py:obj:`gws.base.action.Object`

   .. py:attribute:: categories
      :type:  list[str]
      :value: []


   .. py:attribute:: limit
      :value: 0


   .. py:attribute:: tolerance
      :type:  gws.UomValue

   .. py:method:: configure()

   .. py:method:: find(req: gws.WebRequester, p: Request) -> Response

      Perform a search


   .. py:method:: props(user)


.. py:class:: Props


   Bases: :py:obj:`gws.base.action.Props`

   .. py:attribute:: categories
      :type:  list[str]


.. py:class:: Request(*args, **kwargs)


   Bases: :py:obj:`gws.Request`

   Command request.

   .. py:attribute:: categories
      :type:  Optional[list[str]]

   .. py:attribute:: crs
      :type:  Optional[gws.CrsName]

   .. py:attribute:: extent
      :type:  Optional[gws.Extent]

   .. py:attribute:: keyword
      :type:  str
      :value: ''


   .. py:attribute:: layerUids
      :type:  list[str]

   .. py:attribute:: limit
      :type:  Optional[int]

   .. py:attribute:: resolution
      :type:  float

   .. py:attribute:: shapes
      :type:  Optional[list[gws.base.shape.Props]]

   .. py:attribute:: tolerance
      :type:  Optional[str]

   .. py:attribute:: views
      :type:  Optional[list[str]]

   .. py:attribute:: withCategories
      :type:  bool


.. py:class:: Response(*args, **kwargs)


   Bases: :py:obj:`gws.Response`

   Command response.

   .. py:attribute:: features
      :type:  list[gws.FeatureProps]