1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
.. 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.
.. _api_public:
Public API
========================
.. toctree::
api/application_key
api/account_info
api/cache
api/api
api/exception
api/bucket
api/file_lock
api/data_classes
api/downloaded_file
api/enums
api/progress
api/sync
api/utils
api/transfer/emerge/write_intent
api/transfer/outbound/outbound_source
api/encryption/setting
api/encryption/types
.. _api_internal:
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/requests
api/internal/utils
api/internal/cache
api/internal/stream/chained
api/internal/stream/hashing
api/internal/stream/progress
api/internal/stream/range
api/internal/stream/wrapper
api/internal/scan/folder_parser
api/internal/scan/folder
api/internal/scan/path
api/internal/scan/policies
api/internal/scan/scan
api/internal/sync/action
api/internal/sync/exception
api/internal/sync/policy
api/internal/sync/policy_manager
api/internal/sync/sync
api/internal/transfer/inbound/downloader/abstract
api/internal/transfer/inbound/downloader/parallel
api/internal/transfer/inbound/downloader/simple
api/internal/transfer/inbound/download_manager
api/internal/transfer/outbound/upload_source
api/internal/raw_simulator
|
