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
|
"""Nextcloud API for working with classics app's storage with user's context (table oc_preferences)."""
from ._misc import check_capabilities, require_capabilities
from ._session import AsyncNcSessionBasic, NcSessionBasic
class PreferencesAPI:
"""API for setting/removing configuration values of applications that support it."""
_ep_base: str = "/ocs/v1.php/apps/provisioning_api/api/v1/config/users"
def __init__(self, session: NcSessionBasic):
self._session = session
@property
def available(self) -> bool:
"""Returns True if the Nextcloud instance supports this feature, False otherwise."""
return not check_capabilities("provisioning_api", self._session.capabilities)
def set_value(self, app_name: str, key: str, value: str) -> None:
"""Sets the value for the key for the specific application."""
require_capabilities("provisioning_api", self._session.capabilities)
self._session.ocs("POST", f"{self._ep_base}/{app_name}/{key}", params={"configValue": value})
def delete(self, app_name: str, key: str) -> None:
"""Removes a key and its value for a specific application."""
require_capabilities("provisioning_api", self._session.capabilities)
self._session.ocs("DELETE", f"{self._ep_base}/{app_name}/{key}")
class AsyncPreferencesAPI:
"""Async API for setting/removing configuration values of applications that support it."""
_ep_base: str = "/ocs/v1.php/apps/provisioning_api/api/v1/config/users"
def __init__(self, session: AsyncNcSessionBasic):
self._session = session
@property
async def available(self) -> bool:
"""Returns True if the Nextcloud instance supports this feature, False otherwise."""
return not check_capabilities("provisioning_api", await self._session.capabilities)
async def set_value(self, app_name: str, key: str, value: str) -> None:
"""Sets the value for the key for the specific application."""
require_capabilities("provisioning_api", await self._session.capabilities)
await self._session.ocs("POST", f"{self._ep_base}/{app_name}/{key}", params={"configValue": value})
async def delete(self, app_name: str, key: str) -> None:
"""Removes a key and its value for a specific application."""
require_capabilities("provisioning_api", await self._session.capabilities)
await self._session.ocs("DELETE", f"{self._ep_base}/{app_name}/{key}")
|
