GBase/GBase.Api/GBase.Api.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>GBase.Api</name>
    </assembly>
    <members>
        <member name="T:GBase.Api.Communication.ICommunicationSettings">
            <summary>
            Settings for a client-server communication
            </summary>
        </member>
        <member name="P:GBase.Api.Communication.ICommunicationSettings.Protocol">
            <summary>
            The used <see cref="T:GBase.Api.Communication.ServerProtocol"/>
            </summary>
        </member>
        <member name="P:GBase.Api.Communication.ICommunicationSettings.IpAddress">
            <summary>
            The used <see cref="P:GBase.Api.Communication.ICommunicationSettings.IpAddress"/>
            </summary>
        </member>
        <member name="P:GBase.Api.Communication.ICommunicationSettings.Port">
            <summary>
            The used port
            </summary>
        </member>
        <member name="P:GBase.Api.Communication.ICommunicationSettings.GBaseEndpoint">
            <summary>
            The used endpoint for the GBase
            </summary>
        </member>
        <member name="P:GBase.Api.Communication.ICommunicationSettings.GBaseTableEndpoint">
            <summary>
            The used endpoint for the GBaseTable
            </summary>
        </member>
        <member name="P:GBase.Api.Communication.ICommunicationSettings.GBaseEntryEndpoint">
            <summary>
            The used endpoint for the GBaseEntry
            </summary>
        </member>
        <member name="T:GBase.Api.Communication.ServerProtocol">
            <summary>
            The protocol used for the connection between client and server
            </summary>
        </member>
        <member name="F:GBase.Api.Communication.ServerProtocol.Http">
            <summary>
            Http connection
            </summary>
        </member>
        <member name="F:GBase.Api.Communication.ServerProtocol.Https">
            <summary>
            Https connection
            </summary>
        </member>
        <member name="F:GBase.Api.Communication.ServerProtocol.Tcp">
            <summary>
            net.tcp connection
            </summary>
        </member>
        <member name="T:GBase.Api.Communication.ServerProtocolExtensions">
            <summary>
            Extension methods for the <see cref="T:GBase.Api.Communication.ServerProtocol"/> enum
            </summary>
        </member>
        <member name="M:GBase.Api.Communication.ServerProtocolExtensions.GetProtocolString(GBase.Api.Communication.ServerProtocol)">
            <summary>
            Get a protocol string for a <see cref="T:GBase.Api.Communication.ServerProtocol"/>
            </summary>
            <param name="protocol">The <see cref="T:GBase.Api.Communication.ServerProtocol"/></param>
            <returns>A protocol string for the <see cref="T:GBase.Api.Communication.ServerProtocol"/></returns>
            <exception cref="T:System.ArgumentOutOfRangeException">Invalid protocol passed.</exception>
        </member>
        <member name="M:GBase.Api.Communication.ServerProtocolExtensions.GetServerProtocolFromString(System.String)">
            <summary>
            Get the <see cref="T:GBase.Api.Communication.ServerProtocol"/> for a given <see cref="T:System.String"/>
            </summary>
            <param name="string">The given <see cref="T:System.String"/></param>
            <returns>The <see cref="T:GBase.Api.Communication.ServerProtocol"/> for the given <see cref="T:System.String"/></returns>
            <exception cref="T:System.ArgumentOutOfRangeException">Invalid string passed.</exception>
        </member>
        <member name="T:GBase.Api.IGBaseObject">
            <summary>
            GBase object that allows conversion from <see cref="T:System.String"/>
            </summary>
            <typeparam name="T"></typeparam>
        </member>
        <member name="M:GBase.Api.IGBaseObject.InitializeFromString(System.String)">
            <summary>
            Initialize this <see cref="T:GBase.Api.IGBaseObject"/> from a given <see cref="T:System.String"/>
            </summary>
            <param name="string">The given <see cref="T:System.String"/></param>
        </member>
        <member name="T:GBase.Api.Services.IGBaseEntryService">
            <summary>
            ServiceContract for the GBaseEntry
            </summary>
        </member>
        <member name="M:GBase.Api.Services.IGBaseEntryService.Dummy">
            <summary>
            Dummy OperationContract
            </summary>
        </member>
        <member name="T:GBase.Api.Services.IGBaseService">
            <summary>
            ServiceContract for the GBase
            </summary>
        </member>
        <member name="M:GBase.Api.Services.IGBaseService.AddTable">
            <summary>
            Add a table to the GBase
            </summary>
            <returns>True if successful, false if not</returns>
        </member>
        <member name="M:GBase.Api.Services.IGBaseService.RemoveTable">
            <summary>
            Remove a table from the GBase
            </summary>
            <returns>True if successful, false if not</returns>
        </member>
        <member name="T:GBase.Api.Services.IGBaseTableService">
            <summary>
            ServiceContract for the GBaseTable
            </summary>
        </member>
        <member name="M:GBase.Api.Services.IGBaseTableService.AddEntry">
            <summary>
            Add an entry to the GBaseTable
            </summary>
            <returns>True if successful, false if not</returns>
        </member>
        <member name="M:GBase.Api.Services.IGBaseTableService.RemoveEntry">
            <summary>
            Remove an entry from the GBaseTable
            </summary>
            <returns>True if successful, false if not</returns>
        </member>
    </members>
</doc>