Skip to content

Latest commit

 

History

History
75 lines (62 loc) · 1.96 KB

api_reference.rst

File metadata and controls

75 lines (62 loc) · 1.96 KB
Raw

Hint

Use :doc:`quick_start` to quickly jump to examples

API Reference

Interface types

b2sdk API is divided into two parts, :ref:`public <api_public>` and :ref:`internal <api_internal>`. Please pay attention to which interface type you use.

Tip

:ref:`Pinning versions <semantic_versioning>` properly ensures the stability of your application.

Public API

.. toctree::
   api/account_info
   api/cache
   api/api
   api/exception
   api/bucket
   api/data_classes
   api/enums
   api/progress
   api/sync
   api/utils
   api/transfer/emerge/write_intent
   api/transfer/outbound/outbound_source
   api/download_dest

Internal API

Note

See :ref:`Internal interface <internal_interface>` chapter to learn when and how to safely use the Internal API

.. toctree::
   api/internal/session
   api/internal/raw_api
   api/internal/b2http
   api/internal/utils
   api/internal/cache
   api/internal/download_dest
   api/internal/stream/chained
   api/internal/stream/hashing
   api/internal/stream/progress
   api/internal/stream/range
   api/internal/stream/wrapper
   api/internal/sync/action
   api/internal/sync/exception
   api/internal/sync/file
   api/internal/sync/folder
   api/internal/sync/folder_parser
   api/internal/sync/policy
   api/internal/sync/policy_manager
   api/internal/sync/scan_policies
   api/internal/sync/sync
   api/internal/sync/encryption_provider
   api/internal/encryption/setting
   api/internal/encryption/types
   api/internal/transfer/inbound/downloader/abstract
   api/internal/transfer/inbound/downloader/parallel
   api/internal/transfer/inbound/downloader/range
   api/internal/transfer/inbound/downloader/simple
   api/internal/transfer/inbound/download_manager
   api/internal/transfer/inbound/file_metadata
   api/internal/transfer/outbound/upload_source
   api/internal/raw_simulator