:tocdepth: 3

:py:mod:`gws.plugin.qfield.action`
==================================

.. py:module:: gws.plugin.qfield.action


**Source code:** :source:`gws.plugin.qfield.action<gws/plugin/qfield/action.py>`



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



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


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

   QField action. (added in 8.1)

   .. py:attribute:: packages
      :type:  list[gws.plugin.qfield.core.PackageConfig]

   .. py:attribute:: withDbInDCIM
      :type:  bool
      :value: False


   .. py:attribute:: withSerialPrefix
      :type:  bool
      :value: False



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


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

   Command request.

   .. py:attribute:: omitData
      :type:  bool
      :value: False


   .. py:attribute:: omitStatic
      :type:  bool
      :value: False


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


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


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

   Command response.

   .. py:attribute:: data
      :type:  bytes


.. py:class:: Object


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

   .. py:attribute:: packages
      :type:  dict[str, gws.plugin.qfield.core.Package]

   .. py:attribute:: withDbInDCIM
      :type:  bool

   .. py:attribute:: withSerialPrefix
      :type:  bool

   .. py:method:: api_download(req: gws.WebRequester, p: DownloadRequest) -> DownloadResponse

   .. py:method:: api_upload(req: gws.WebRequester, p: UploadRequest) -> UploadResponse

   .. py:method:: cli_package(p: PackageParams)

      Create a package for QField.


   .. py:method:: configure()

   .. py:method:: end_export(args: gws.plugin.qfield.core.ExportArgs) -> bytes

   .. py:method:: end_import(args: gws.plugin.qfield.core.ImportArgs)

   .. py:method:: exec_export(args: gws.plugin.qfield.core.ExportArgs)

   .. py:method:: exec_import(args: gws.plugin.qfield.core.ImportArgs)

   .. py:method:: http_download(req: gws.WebRequester, p: DownloadRequest) -> gws.ContentResponse

   .. py:method:: http_upload(req: gws.WebRequester, p: UploadRequest) -> gws.ContentResponse

   .. py:method:: prepare_export(p: DownloadRequest, user: gws.User) -> gws.plugin.qfield.core.ExportArgs

   .. py:method:: prepare_import(p: UploadRequest, user: gws.User, data: bytes)


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


   Bases: :py:obj:`gws.CliParams`

   CLI params

   .. py:attribute:: out
      :type:  str

      Output filename.

   .. py:attribute:: packageUid
      :type:  str

      Package uid.

   .. py:attribute:: projectUid
      :type:  str

      Project uid.


.. py:class:: Props


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


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


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

   Command request.

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

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


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


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

   Command response.