Skip to content

device_access

DeviceId

Bases: str

A device id.

Source code in zendriver/cdp/device_access.py 
31
32
33
34
35
36
37
38
39
40
41
42
43
44
class DeviceId(str):
    """
    A device id.
    """

    def to_json(self) -> str:
        return self

    @classmethod
    def from_json(cls, json: str) -> DeviceId:
        return cls(json)

    def __repr__(self):
        return "DeviceId({})".format(super().__repr__())

__repr__()

Source code in zendriver/cdp/device_access.py 
43
44
def __repr__(self):
    return "DeviceId({})".format(super().__repr__())

from_json(json) classmethod

Source code in zendriver/cdp/device_access.py 
39
40
41
@classmethod
def from_json(cls, json: str) -> DeviceId:
    return cls(json)

to_json()

Source code in zendriver/cdp/device_access.py 
36
37
def to_json(self) -> str:
    return self

DeviceRequestPrompted dataclass

A device request opened a user prompt to select a device. Respond with the selectPrompt or cancelPrompt command.

Source code in zendriver/cdp/device_access.py 
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
@event_class("DeviceAccess.deviceRequestPrompted")
@dataclass
class DeviceRequestPrompted:
    """
    A device request opened a user prompt to select a device. Respond with the
    selectPrompt or cancelPrompt command.
    """

    id_: RequestId
    devices: typing.List[PromptDevice]

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> DeviceRequestPrompted:
        return cls(
            id_=RequestId.from_json(json["id"]),
            devices=[PromptDevice.from_json(i) for i in json["devices"]],
        )

devices: typing.List[PromptDevice] instance-attribute

id_: RequestId instance-attribute

__init__(id_, devices)

from_json(json) classmethod

Source code in zendriver/cdp/device_access.py 
137
138
139
140
141
142
@classmethod
def from_json(cls, json: T_JSON_DICT) -> DeviceRequestPrompted:
    return cls(
        id_=RequestId.from_json(json["id"]),
        devices=[PromptDevice.from_json(i) for i in json["devices"]],
    )

PromptDevice dataclass

Device information displayed in a user prompt to select a device.

Source code in zendriver/cdp/device_access.py 
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
@dataclass
class PromptDevice:
    """
    Device information displayed in a user prompt to select a device.
    """

    id_: DeviceId

    #: Display name as it appears in a device request user prompt.
    name: str

    def to_json(self) -> T_JSON_DICT:
        json: T_JSON_DICT = dict()
        json["id"] = self.id_.to_json()
        json["name"] = self.name
        return json

    @classmethod
    def from_json(cls, json: T_JSON_DICT) -> PromptDevice:
        return cls(
            id_=DeviceId.from_json(json["id"]),
            name=str(json["name"]),
        )

id_: DeviceId instance-attribute

name: str instance-attribute

__init__(id_, name)

from_json(json) classmethod

Source code in zendriver/cdp/device_access.py 
64
65
66
67
68
69
@classmethod
def from_json(cls, json: T_JSON_DICT) -> PromptDevice:
    return cls(
        id_=DeviceId.from_json(json["id"]),
        name=str(json["name"]),
    )

to_json()

Source code in zendriver/cdp/device_access.py 
58
59
60
61
62
def to_json(self) -> T_JSON_DICT:
    json: T_JSON_DICT = dict()
    json["id"] = self.id_.to_json()
    json["name"] = self.name
    return json

RequestId

Bases: str

Device request id.

Source code in zendriver/cdp/device_access.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
class RequestId(str):
    """
    Device request id.
    """

    def to_json(self) -> str:
        return self

    @classmethod
    def from_json(cls, json: str) -> RequestId:
        return cls(json)

    def __repr__(self):
        return "RequestId({})".format(super().__repr__())

__repr__()

Source code in zendriver/cdp/device_access.py 
27
28
def __repr__(self):
    return "RequestId({})".format(super().__repr__())

from_json(json) classmethod

Source code in zendriver/cdp/device_access.py 
23
24
25
@classmethod
def from_json(cls, json: str) -> RequestId:
    return cls(json)

to_json()

Source code in zendriver/cdp/device_access.py 
20
21
def to_json(self) -> str:
    return self

cancel_prompt(id_)

Cancel a prompt in response to a DeviceAccess.deviceRequestPrompted event.

Parameters:

Name Type Description Default
id_ RequestId
required
Source code in zendriver/cdp/device_access.py 
111
112
113
114
115
116
117
118
119
120
121
122
123
def cancel_prompt(id_: RequestId) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Cancel a prompt in response to a DeviceAccess.deviceRequestPrompted event.

    :param id_:
    """
    params: T_JSON_DICT = dict()
    params["id"] = id_.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "DeviceAccess.cancelPrompt",
        "params": params,
    }
    json = yield cmd_dict

disable()

Disable events in this domain.

Source code in zendriver/cdp/device_access.py 
82
83
84
85
86
87
88
89
def disable() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Disable events in this domain.
    """
    cmd_dict: T_JSON_DICT = {
        "method": "DeviceAccess.disable",
    }
    json = yield cmd_dict

enable()

Enable events in this domain.

Source code in zendriver/cdp/device_access.py 
72
73
74
75
76
77
78
79
def enable() -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Enable events in this domain.
    """
    cmd_dict: T_JSON_DICT = {
        "method": "DeviceAccess.enable",
    }
    json = yield cmd_dict

select_prompt(id_, device_id)

Select a device in response to a DeviceAccess.deviceRequestPrompted event.

Parameters:

Name Type Description Default
id_ RequestId
required
device_id DeviceId
required
Source code in zendriver/cdp/device_access.py 
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
def select_prompt(
    id_: RequestId, device_id: DeviceId
) -> typing.Generator[T_JSON_DICT, T_JSON_DICT, None]:
    """
    Select a device in response to a DeviceAccess.deviceRequestPrompted event.

    :param id_:
    :param device_id:
    """
    params: T_JSON_DICT = dict()
    params["id"] = id_.to_json()
    params["deviceId"] = device_id.to_json()
    cmd_dict: T_JSON_DICT = {
        "method": "DeviceAccess.selectPrompt",
        "params": params,
    }
    json = yield cmd_dict