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
|
"""Clients are devices on a UniFi network."""
from ..models.api import TypedApiResponse
from ..models.client import (
Client,
ClientBlockRequest,
ClientListRequest,
ClientReconnectRequest,
ClientRemoveRequest,
)
from ..models.message import MessageKey
from .api_handlers import APIHandler
class Clients(APIHandler[Client]):
"""Represents client network devices."""
obj_id_key = "mac"
item_cls = Client
process_messages = (MessageKey.CLIENT,)
remove_messages = (MessageKey.CLIENT_REMOVED,)
api_request = ClientListRequest.create()
async def block(self, mac: str) -> TypedApiResponse:
"""Block client from controller."""
return await self.controller.request(ClientBlockRequest.create(mac, block=True))
async def unblock(self, mac: str) -> TypedApiResponse:
"""Unblock client from controller."""
return await self.controller.request(
ClientBlockRequest.create(mac, block=False)
)
async def reconnect(self, mac: str) -> TypedApiResponse:
"""Force a wireless client to reconnect to the network."""
return await self.controller.request(ClientReconnectRequest.create(mac))
async def remove_clients(self, macs: list[str]) -> TypedApiResponse:
"""Make controller forget provided clients."""
return await self.controller.request(ClientRemoveRequest.create(macs))
|
