three.MF.V3.Tasks.HasCameras

 1from MF.V3.Task import TaskState as MF_V3_Task_TaskState
 2
 3
 4class HasCameras:
 5    """*
 6    Check if the scanner has working cameras.
 7
 8    > Request example:
 9
10    ```json
11    {
12    "Task":{
13    "Index":1,
14    "Type":"HasCameras"
15    }
16    }
17    ```
18
19    > Response example:
20
21    ```json
22    {
23    "Task":{
24    "Index":1,
25    "Type":"HasCameras",
26    "Output":true,
27    "State":"Completed"
28    }
29    }
30    ```
31    """
32    class Request:
33
34        """
35         Client request for the `HasCameras` task.
36        """
37        def __init__(self, Index: int, Type: str):
38            # A unique identifier generated by the client.
39            self.Index = Index
40            # "HasCameras"
41            self.Type = Type
42
43    class Response:
44
45        """
46         Server response for the `HasCameras` task.
47        """
48        def __init__(self, Index: int, Type: str, Output: bool = None, State: MF_V3_Task_TaskState = None, Error: str = None):
49            # The unique identifier generated by the client.
50            self.Index = Index
51            # "HasCameras"
52            self.Type = Type
53            # The working state of the cameras.
54            self.Output = Output
55            # The current state of the task.
56            self.State = State
57            # A string describing the error if the task has failed.
58            self.Error = Error
59
60    def __init__(self):
61        pass
class HasCameras:
 5class HasCameras:
 6    """*
 7    Check if the scanner has working cameras.
 8
 9    > Request example:
10
11    ```json
12    {
13    "Task":{
14    "Index":1,
15    "Type":"HasCameras"
16    }
17    }
18    ```
19
20    > Response example:
21
22    ```json
23    {
24    "Task":{
25    "Index":1,
26    "Type":"HasCameras",
27    "Output":true,
28    "State":"Completed"
29    }
30    }
31    ```
32    """
33    class Request:
34
35        """
36         Client request for the `HasCameras` task.
37        """
38        def __init__(self, Index: int, Type: str):
39            # A unique identifier generated by the client.
40            self.Index = Index
41            # "HasCameras"
42            self.Type = Type
43
44    class Response:
45
46        """
47         Server response for the `HasCameras` task.
48        """
49        def __init__(self, Index: int, Type: str, Output: bool = None, State: MF_V3_Task_TaskState = None, Error: str = None):
50            # The unique identifier generated by the client.
51            self.Index = Index
52            # "HasCameras"
53            self.Type = Type
54            # The working state of the cameras.
55            self.Output = Output
56            # The current state of the task.
57            self.State = State
58            # A string describing the error if the task has failed.
59            self.Error = Error
60
61    def __init__(self):
62        pass

* Check if the scanner has working cameras.

Request example:

{
"Task":{
"Index":1,
"Type":"HasCameras"
}
}

Response example:

{
"Task":{
"Index":1,
"Type":"HasCameras",
"Output":true,
"State":"Completed"
}
}
class HasCameras.Request:
33    class Request:
34
35        """
36         Client request for the `HasCameras` task.
37        """
38        def __init__(self, Index: int, Type: str):
39            # A unique identifier generated by the client.
40            self.Index = Index
41            # "HasCameras"
42            self.Type = Type

Client request for the HasCameras task.

HasCameras.Request(Index: int, Type: str)
38        def __init__(self, Index: int, Type: str):
39            # A unique identifier generated by the client.
40            self.Index = Index
41            # "HasCameras"
42            self.Type = Type
Index
Type
class HasCameras.Response:
44    class Response:
45
46        """
47         Server response for the `HasCameras` task.
48        """
49        def __init__(self, Index: int, Type: str, Output: bool = None, State: MF_V3_Task_TaskState = None, Error: str = None):
50            # The unique identifier generated by the client.
51            self.Index = Index
52            # "HasCameras"
53            self.Type = Type
54            # The working state of the cameras.
55            self.Output = Output
56            # The current state of the task.
57            self.State = State
58            # A string describing the error if the task has failed.
59            self.Error = Error

Server response for the HasCameras task.

HasCameras.Response( Index: int, Type: str, Output: bool = None, State: MF.V3.Task.TaskState = None, Error: str = None)
49        def __init__(self, Index: int, Type: str, Output: bool = None, State: MF_V3_Task_TaskState = None, Error: str = None):
50            # The unique identifier generated by the client.
51            self.Index = Index
52            # "HasCameras"
53            self.Type = Type
54            # The working state of the cameras.
55            self.Output = Output
56            # The current state of the task.
57            self.State = State
58            # A string describing the error if the task has failed.
59            self.Error = Error
Index
Type
Output
State
Error