three.MF.V3.Tasks.CloseProject 

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

* Close the current open project.

Request example:

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

Response example:

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

Client request for the CloseProject task.

CloseProject.Request(Index: int, Type: str) 
37        def __init__(self, Index: int, Type: str):
38            # A unique identifier generated by the client.
39            self.Index = Index
40            # "CloseProject"
41            self.Type = Type
Index
Type
class CloseProject.Response: 
43    class Response:
44
45        """
46         Server response for the `CloseProject` 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            # "CloseProject"
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

Server response for the CloseProject task.

CloseProject.Response( Index: int, Type: str, State: MF.V3.Task.TaskState = None, Error: str = None) 
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            # "CloseProject"
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
Index
Type
State
Error