OWSInstanceManagement.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>OWSInstanceManagement</name>
    </assembly>
    <members>
        <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.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>