OWS/src/OWSInstanceManagement/OWSInstanceManagement.xml at main · DigitalPotter/OWS · GitHub

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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
<?xml version="1.0"?>
<doc>
    <assembly>
        <name>OWSInstanceManagement</name>
    </assembly>
    <members>
        <member name="M:OWSInstanceManagement.Controllers.InstanceController.GetZoneInstance(System.Int32)">
            <summary>
            GetZoneInstance
            </summary>
            <remarks>
            Get information on the server instance that matches the ZoneInstanceId in the POST data
            </remarks>
        </member>
        <member name="T:OWSInstanceManagement.Controllers.SystemController">
            <summary>
            Public System API calls.
            </summary>
            <remarks>
            Contains system related API calls that are all publicly accessible.
            </remarks>
        </member>
        <member name="M:OWSInstanceManagement.Controllers.SystemController.Status">
            <summary>
            Gets the Api Status.
            </summary>
            <remarks>
            Get the Api Status and return true
            </remarks>
        </member>
        <member name="T:OWSInstanceManagement.Controllers.ZonesController">
            <summary>
            Zones Controller
            </summary>
            <remarks>
            Controller for Handling Zone related requests.
            </remarks>
        </member>
        <member name="M:OWSInstanceManagement.Controllers.ZonesController.OnActionExecuting(Microsoft.AspNetCore.Mvc.Filters.ActionExecutingContext)">
            <summary>
            Zones Controller - OnActionExecuting
            </summary>
            <remarks>
            OnActionExecuting
            </remarks>
        </member>
        <member name="M:OWSInstanceManagement.Controllers.ZonesController.#ctor(SimpleInjector.Container,OWSData.Repositories.Interfaces.IInstanceManagementRepository,OWSData.Repositories.Interfaces.ICharactersRepository,Microsoft.Extensions.Options.IOptions{OWSShared.Options.RabbitMQOptions},OWSShared.Interfaces.IHeaderCustomerGUID)">
            <summary>
            Zones Controller - Constructor
            </summary>
            <remarks>
            Setup for dependency injection.
            </remarks>
        </member>
        <member name="M:OWSInstanceManagement.Controllers.ZonesController.AddZone(OWSInstanceManagement.Requests.Zones.AddZoneRequest)">
            <summary>
            Add a Zone
            </summary>
            <remarks>
            Add a Zone to the Maps table.
            </remarks>
        </member>
        <member name="T:OWSInstanceManagement.Requests.Instance.GetCurrentWorldTimeRequest">
            <summary>
            GetCurrentWorldTimeRequest
            </summary>
            <remarks>
            Get the Current World Time based on the StartTime stored in the WorldSettings table.  The format is in seconds since 1/1/1970.
            </remarks>
        </member>
        <member name="T:OWSInstanceManagement.Requests.Instance.GetServerInstanceFromPortRequest">
            <summary>
            GetServerInstanceFromPortRequest
            </summary>
            <remarks>
            Get information on the server instance that matches the port and IP
            </remarks>
        </member>
        <member name="T:OWSInstanceManagement.Requests.Instance.GetZoneInstanceRequest">
            <summary>
            GetZoneInstanceRequest
            </summary>
            <remarks>
            Get information on the server instance that matches the ZoneInstanceId
            </remarks>
        </member>
        <member name="M:OWSInstanceManagement.Requests.Instance.GetZoneInstanceRequest.#ctor(System.Int32,OWSData.Repositories.Interfaces.IInstanceManagementRepository,OWSShared.Interfaces.IHeaderCustomerGUID)">
            <summary>
            GetZoneInstanceRequest Constructor
            </summary>
            <remarks>
            This constructor is used to inject the dependencies into the GetZoneInstanceRequest
            </remarks>
        </member>
        <member name="T:OWSInstanceManagement.Requests.Instance.GetZoneInstancesForZoneRequest">
            <summary>
            Get a list of Zone Instances for a Zone
            </summary>
            <remarks>
            Get a list of running Zone Instances for a Zone. This list can be used to allow players to pick which instance of a Zone they want to switch to.
            </remarks>
        </member>
        <member name="P:OWSInstanceManagement.Requests.Instance.GetZoneInstancesForZoneRequest.Request">
            <summary>
            Request - ZoneName
            </summary>
            <remarks>
            This Request object contains a field for sending in the ZoneName to get a list of running Zone Instances for.
            </remarks>
        </member>
        <member name="T:OWSInstanceManagement.Requests.Instance.UpdateNumberOfPlayersRequest">
            <summary>
            UpdateNumberOfPlayersRequest
            </summary>
            <remarks>
            Update the number of players on a zone instance by matching it to the port and IP
            </remarks>
        </member>
    </members>
</doc>