:tocdepth: 3

:py:mod:`gws.base.storage`
==========================

.. py:module:: gws.base.storage

.. autoapi-nested-parse::

   Storage API.



**Source code:** :source:`gws.base.storage<gws/base/storage/__init__.py>`


Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   core/index.rst
   manager/index.rst



Package Contents
----------------



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


   Bases: :py:obj:`gws.ConfigWithAccess`

   Storage configuration

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

      category name

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

      storage provider uid


.. py:class:: Object


   Bases: :py:obj:`gws.Node`

   Configurable GWS object.

   .. py:attribute:: categoryName
      :type:  str

   .. py:attribute:: storageProvider
      :type:  gws.StorageProvider

   .. py:method:: configure()

      Configuration hook.


   .. py:method:: configure_provider()

   .. py:method:: get_state_for(user)

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

   .. py:method:: props(user)

      Generate a ``Props`` struct for this object.

      :param user: The user for which the props should be generated.



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


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

   Object properties.

   .. py:attribute:: state
      :type:  State


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


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

   Command request.

   .. py:attribute:: entryData
      :type:  Optional[dict]

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

   .. py:attribute:: verb
      :type:  Verb


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


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

   Command response.

   .. py:attribute:: data
      :type:  Optional[dict]

   .. py:attribute:: state
      :type:  State