three.MF.V3.Tasks.FactoryReset

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

* Reset the scanner to factory settings. This removes all projects and restores factory calibration.

Request example:

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

Response example:

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

Client request for the FactoryReset task.

FactoryReset.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            # "FactoryReset"
42            self.Type = Type
Index
Type
class FactoryReset.Response:
44    class Response:
45
46        """
47         Server response for the `FactoryReset` task.
48        """
49        def __init__(self, Index: int, Type: str, State: MF_V3_Task_TaskState = None, Error: str = None):
50            # The unique identifier generated by the client.
51            self.Index = Index
52            # "FactoryReset"
53            self.Type = Type
54            # The current state of the task.
55            self.State = State
56            # A string describing the error if the task has failed.
57            self.Error = Error

Server response for the FactoryReset task.

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