RSMassTransit.PowerShell

1.0.0-rc3

RSMassTransit.Client.xml

<?xml version="1.0" encoding="utf-8"?>
<doc>
    <assembly>
        <name>RSMassTransit.Client</name>
    </assembly>
    <members>
        <member name="T:RSMassTransit.Client.IReportingServices">
            <summary>
              Interface to SQL Server Reporting Services provided by RSMassTransit
              clients.
            </summary>
        </member>
        <member name="M:RSMassTransit.Client.IReportingServices.ExecuteReport(RSMassTransit.Messages.IExecuteReportRequest,System.Nullable{System.TimeSpan})">
            <summary>
              Executes a report.
            </summary>
            <param name="request">
              The parameters for report execution.
            </param>
            <param name="timeout">
              The duration after which the client will cease waiting for a
              response and throw an exception. If this parameter is
              <c>null</c>, this method will use the timeout specified by the
              <see cref="P:RSMassTransit.Client.ReportingServicesConfiguration.RequestTimeout" />
              property.
            </param>
            <returns>
              The result of report execution.
            </returns>
            <exception cref="T:System.ArgumentNullException">
              <paramref name="request" /> is <see langword="null" />.
            </exception>
        </member>
        <member name="M:RSMassTransit.Client.IReportingServices.ExecuteReportAsync(RSMassTransit.Messages.IExecuteReportRequest,System.Nullable{System.TimeSpan},System.Threading.CancellationToken)">
            <summary>
              Executes a report asynchronously.
            </summary>
            <param name="request">
              The parameters for report execution.
            </param>
            <param name="timeout">
              The duration after which the client will cease waiting for a
              response and throw an exception. If this parameter is
              <c>null</c>, this method will use the timeout specified by the
              <see cref="P:RSMassTransit.Client.ReportingServicesConfiguration.RequestTimeout" />
              property.
            </param>
            <param name="cancellationToken">
              A token that can cancel the operation.
            </param>
            <returns>
              A task representing the asynchronous operation.
              The task's <c>Result</c> property returns the result of report execution.
            </returns>
            <exception cref="T:System.ArgumentNullException">
              <paramref name="request" /> is <see langword="null" />.
            </exception>
        </member>
        <member name="T:RSMassTransit.Client.ReportingServices">
            <summary>
              Base class for RSMassTransit clients.
            </summary>
        </member>
        <member name="M:RSMassTransit.Client.ReportingServices.#ctor(RSMassTransit.Client.ReportingServicesConfiguration)">
            <summary>
              Creates a new <see cref="T:RSMassTransit.Client.ReportingServices" /> instance with the
              specified configuration.
            </summary>
            <param name="configuration">
              The configuration for the client, specifying how to communicate
              with RSMassTransit.
            </param>
            <exception cref="T:System.ArgumentNullException">
              <paramref name="configuration" /> is <see langword="null" />.
            </exception>
        </member>
        <member name="P:RSMassTransit.Client.ReportingServices.Configuration">
            <summary>
              The configuration of the client, specifying how to communicate
              with RSMassTransit.
            </summary>
        </member>
        <member name="M:RSMassTransit.Client.ReportingServices.CreateBus(System.Uri@)">
            <summary>
              When implemented in a derived class, creates the message bus
              instance used to communicate with RSMassTransit.
            </summary>
            <param name="queueUri">
              When this method returns, contains the normalized URI of the bus
              queue used to send and receive messages.
            </param>
            <returns>
              The message bus instance on which to send and receive messages.
            </returns>
        </member>
        <member name="M:RSMassTransit.Client.ReportingServices.ExecuteReport(RSMassTransit.Messages.IExecuteReportRequest,System.Nullable{System.TimeSpan})">
            <summary>
              Executes a report.
            </summary>
            <param name="request">
              The parameters for report execution.
            </param>
            <param name="timeout">
              The duration after which the client will cease waiting for a
              response and throw an exception. If this parameter is
              <c>null</c>, this method will use the timeout specified by the
              <see cref="P:RSMassTransit.Client.ReportingServicesConfiguration.RequestTimeout" />
              property.
            </param>
            <returns>
              The result of report execution.
            </returns>
            <exception cref="T:System.ArgumentNullException">
              <paramref name="request" /> is <see langword="null" />.
            </exception>
        </member>
        <member name="M:RSMassTransit.Client.ReportingServices.ExecuteReportAsync(RSMassTransit.Messages.IExecuteReportRequest,System.Nullable{System.TimeSpan},System.Threading.CancellationToken)">
            <summary>
              Executes a report asynchronously.
            </summary>
            <param name="request">
              The parameters for report execution.
            </param>
            <param name="timeout">
              The duration after which the client will cease waiting for a
              response and throw an exception. If this parameter is
              <c>null</c>, this method will use the timeout specified by the
              <see cref="P:RSMassTransit.Client.ReportingServicesConfiguration.RequestTimeout" />
              property.
            </param>
            <param name="cancellationToken">
              A token that can cancel the operation.
            </param>
            <returns>
              A task representing the asynchronous operation.
              The task's <c>Result</c> property returns the result of report execution.
            </returns>
            <exception cref="T:System.ArgumentNullException">
              <paramref name="request" /> is <see langword="null" />.
            </exception>
        </member>
        <member name="M:RSMassTransit.Client.ReportingServices.CreateRequestClient``1(System.Nullable{System.TimeSpan})">
            <summary>
              Creates a MassTransit request client.
            </summary>
            <typeparam name="TRequest">
              Type of the request.
            </typeparam>
            <param name="timeout">
              If specified, overrides the configured timeout.
            </param>
            <returns>
              A MassTransit request client.
            </returns>
        </member>
        <member name="M:RSMassTransit.Client.ReportingServices.Create(RSMassTransit.Client.ReportingServicesConfiguration)">
            <summary>
              Creates a new <see cref="T:RSMassTransit.Client.ReportingServices" /> instance with
              the specified configuration.
            </summary>
            <param name="configuration">
              The configuration for the client, specifying how to communicate
              with RSMassTransit.
            </param>
            <exception cref="T:System.ArgumentNullException">
              <paramref name="configuration" /> is <see langword="null" />.
            </exception>
            <exception cref="T:System.ArgumentException">
              The URI scheme specified by <paramref name="configuration" /> in
              the <see cref="P:RSMassTransit.Client.ReportingServicesConfiguration.BusUri" /> property
              is not supported by any loaded RSMassTransit client type.
            </exception>
            <exception cref="T:System.IO.FileLoadException">
              Could not load a client assembly (<c>RSMassTransit.Client.*.dll</c>).
            </exception>
        </member>
        <member name="M:RSMassTransit.Client.ReportingServices.NormalizeBusUri(System.String,System.String)">
            <summary>
              Validates the configured bus URI and converts it to a normalized
              form.
            </summary>
            <param name="scheme">
              The required URI scheme.
            </param>
            <param name="kind">
              A short human-readable name for the kind of bus URI.
            </param>
            <returns>
              The normalized bus URI.
            </returns>
            <exception cref="T:MassTransit.ConfigurationException">
              The <see cref="P:RSMassTransit.Client.ReportingServicesConfiguration.BusUri" /> value is
              not a valid URI for the <paramref name="kind" /> of bus.
            </exception>
        </member>
        <member name="M:RSMassTransit.Client.ReportingServices.NormalizeBusQueue">
            <summary>
              Validates the configured queue name and converts it to a
              normalized form.
            </summary>
            <returns>
              The normalized queue name.
            </returns>
        </member>
        <member name="M:RSMassTransit.Client.ReportingServices.NormalizeBusCredential">
            <summary>
              Validates the configured bus credential and converts to a
              normalized form.
            </summary>
            <returns>
              The normalized bus credential.
            </returns>
            <exception cref="T:MassTransit.ConfigurationException">
              The <see cref="P:RSMassTransit.Client.ReportingServicesConfiguration.BusCredential" />
              property is <see langword="null" />.
            </exception>
        </member>
        <member name="M:RSMassTransit.Client.ReportingServices.Dispose">
            <summary>
              Stops the bus instance used by the client and releases any
              managed or unmanaged resources owned by the client.
            </summary>
        </member>
        <member name="M:RSMassTransit.Client.ReportingServices.Dispose(System.Boolean)">
            <summary>
              Invoked by either <see cref="M:RSMassTransit.Client.ReportingServices.Dispose" /> or the finalizer thread.
              Stops the bus instance used by the client and releases any
              resources of the specified kind owned by the client.
            </summary>
            <param name="managed">
              <c>true</c> to dispose managed an unmanaged resources;
              <c>false</c> to dispose only unamanged resources.
            </param>
            <remarks>
              The current <see cref="T:RSMassTransit.Client.ReportingServices" /> implementation does
              not expect to own unmanaged resources and thus does not provide a
              finalizer. Thus the <paramref name="managed" /> parameter always
              will be <c>true</c>.
            </remarks>
        </member>
        <member name="T:RSMassTransit.Client.ReportingServicesConfiguration">
            <summary>
              Properties specifying how to communicate with a RSMassTransit instance.
            </summary>
        </member>
        <member name="F:RSMassTransit.Client.ReportingServicesConfiguration.DefaultBusQueue">
            <summary>
              The default value of the <see cref="P:RSMassTransit.Client.ReportingServicesConfiguration.BusQueue" /> property.
            </summary>
        </member>
        <member name="F:RSMassTransit.Client.ReportingServicesConfiguration.DefaultRequestTimeoutSeconds">
            <summary>
              The default value of the <see cref="P:RSMassTransit.Client.ReportingServicesConfiguration.RequestTimeout" /> property, in seconds.
            </summary>
        </member>
        <member name="P:RSMassTransit.Client.ReportingServicesConfiguration.BusUri">
            <summary>
              URI of the message bus. The scheme of the URI specifies the kind
              of message bus (RabbitMQ, etc.).
            </summary>
        </member>
        <member name="P:RSMassTransit.Client.ReportingServicesConfiguration.BusQueue">
            <summary>
              Name of the queue within the message bus. The default value is
              <c>"reports"</c>.
            </summary>
        </member>
        <member name="P:RSMassTransit.Client.ReportingServicesConfiguration.BusCredential">
            <summary>
              Credential used to authenticate with the message bus.
              If omitted, behavior is client-specific.
            </summary>
        </member>
        <member name="P:RSMassTransit.Client.ReportingServicesConfiguration.RequestTimeout">
            <summary>
              The duration after which the client will cease waiting for a
              response, if the caller does not provide an explicit timeout.
              The default value is 30 seconds.
            </summary>
        </member>
        <member name="T:RSMassTransit.Messages.ExecuteReportRequest">
            <summary>
              Default implementation of <see cref="T:RSMassTransit.Messages.IExecuteReportRequest" />.
            </summary>
        </member>
        <member name="P:RSMassTransit.Messages.ExecuteReportRequest.Path">
            <summary>
              Virtual path of the report on the report server.
              Example: <c>"/My Reports/Contoso/BalanceSheet"</c>
            </summary>
        </member>
        <member name="P:RSMassTransit.Messages.ExecuteReportRequest.ParameterValues">
            <summary>
              Values for the report's parameters.
            </summary>
            <remarks>
              To provide multiple values for one parameter, populate this
              collection with multiple key-value pairs for that parameter name.
            </remarks>
        </member>
        <member name="P:RSMassTransit.Messages.ExecuteReportRequest.ParameterLanguage">
            <summary>
              Language and locale used to interpret parameter values such as
              dates and numbers. Example: <c>"en-US"</c>
            </summary>
        </member>
        <member name="P:RSMassTransit.Messages.ExecuteReportRequest.Format">
            <summary>
              Format in which to render the report.
            </summary>
        </member>
        <member name="P:RSMassTransit.Messages.ExecuteReportRequest.UserName">
            <summary>
              Username to authenticate with the report server.
            </summary>
        </member>
        <member name="P:RSMassTransit.Messages.ExecuteReportRequest.Password">
            <summary>
              Password to authenticate with the report server.
            </summary>
        </member>
        <member name="T:RSMassTransit.Messages.ExecuteReportResponse">
            <summary>
              Default implementation of <see cref="T:RSMassTransit.Messages.IExecuteReportResponse" />.
            </summary>
        </member>
        <member name="P:RSMassTransit.Messages.ExecuteReportResponse.Uri">
            <summary>
              URI of the rendered report.
            </summary>
            <remarks>
              <para>
                The following URI types are valid:
              </para>
              <list type="bullet">
                <item><c>file:</c></item>
                <item><c>https:</c></item>
              </list>
            </remarks>
        </member>
        <member name="P:RSMassTransit.Messages.ExecuteReportResponse.ContentType">
            <summary>
              Content type (MIME type) of the rendered report.
            </summary>
        </member>
        <member name="P:RSMassTransit.Messages.ExecuteReportResponse.FileNameExtension">
            <summary>
              File name extension of the rendered report.
            </summary>
        </member>
        <member name="P:RSMassTransit.Messages.ExecuteReportResponse.Length">
            <summary>
              Length of the rendered report, in bytes.
            </summary>
        </member>
        <member name="P:RSMassTransit.Messages.ExecuteReportResponse.Messages">
            <summary>
              Diagnostic messages produced during report execution.
            </summary>
        </member>
        <member name="T:RSMassTransit.Messages.ICredential">
            <summary>
              Credential to authenticate with the report server.
            </summary>
        </member>
        <member name="P:RSMassTransit.Messages.ICredential.UserName">
            <summary>
              Username to authenticate with the report server.
            </summary>
        </member>
        <member name="P:RSMassTransit.Messages.ICredential.Password">
            <summary>
              Password to authenticate with the report server.
            </summary>
        </member>
        <member name="T:RSMassTransit.Messages.IExecuteReportRequest">
            <summary>
              A request to execute a report.
            </summary>
        </member>
        <member name="P:RSMassTransit.Messages.IExecuteReportRequest.Path">
            <summary>
              Virtual path of the report on the report server.
              Example: <c>"/My Reports/Contoso/BalanceSheet"</c>
            </summary>
        </member>
        <member name="P:RSMassTransit.Messages.IExecuteReportRequest.ParameterValues">
            <summary>
              Values for the report's parameters.
            </summary>
            <remarks>
              To provide multiple values for one parameter, populate this
              collection with multiple key-value pairs for that parameter name.
            </remarks>
        </member>
        <member name="P:RSMassTransit.Messages.IExecuteReportRequest.ParameterLanguage">
            <summary>
              Language and locale used to interpret parameter values such as
              dates and numbers. Example: <c>"en-US"</c>
            </summary>
        </member>
        <member name="P:RSMassTransit.Messages.IExecuteReportRequest.Format">
            <summary>
              Format in which to render the report.
            </summary>
        </member>
        <member name="T:RSMassTransit.Messages.IExecuteReportResponse">
            <summary>
              The response to a request to execute a report.
            </summary>
        </member>
        <member name="P:RSMassTransit.Messages.IExecuteReportResponse.Uri">
            <summary>
              URI of the rendered report.
            </summary>
            <remarks>
              <para>
                The following URI types are valid:
              </para>
              <list type="bullet">
                <item><c>file:</c></item>
                <item><c>https:</c></item>
              </list>
            </remarks>
        </member>
        <member name="P:RSMassTransit.Messages.IExecuteReportResponse.ContentType">
            <summary>
              Content type (MIME type) of the rendered report.
            </summary>
        </member>
        <member name="P:RSMassTransit.Messages.IExecuteReportResponse.FileNameExtension">
            <summary>
              File name extension of the rendered report.
            </summary>
        </member>
        <member name="P:RSMassTransit.Messages.IExecuteReportResponse.Length">
            <summary>
              Length of the rendered report, in bytes.
            </summary>
        </member>
        <member name="P:RSMassTransit.Messages.IExecuteReportResponse.Messages">
            <summary>
              Diagnostic messages produced during report execution.
            </summary>
        </member>
        <member name="T:RSMassTransit.Messages.IMessage">
            <summary>
              Marker interface for RSMassTransit messages.
            </summary>
        </member>
        <member name="T:RSMassTransit.Messages.ReportFormat">
            <summary>
              Supported report output formats.
            </summary>
        </member>
        <member name="F:RSMassTransit.Messages.ReportFormat.Word">
            <summary>
              Word 2007+ (Open XML) format.
              Uses the 'WORDOPENXML' rendering extension.
            </summary>
        </member>
        <member name="F:RSMassTransit.Messages.ReportFormat.WordLegacy">
            <summary>
              Word 97-2003 format.
              Uses the 'WORD' rendering extension.
            </summary>
        </member>
        <member name="F:RSMassTransit.Messages.ReportFormat.Excel">
            <summary>
              Excel 2007+ (Open XML) format.
              Uses the 'EXCELOPENXML' rendering extension.
            </summary>
        </member>
        <member name="F:RSMassTransit.Messages.ReportFormat.ExcelLegacy">
            <summary>
              Excel 97-2003 format.
              Uses the 'EXCEL' rendering extension.
            </summary>
        </member>
        <member name="F:RSMassTransit.Messages.ReportFormat.PowerPoint">
            <summary>
              PowerPoint 2007+ (Open XML) format.
              Uses the 'PPTX' rendering extension.
            </summary>
        </member>
        <member name="F:RSMassTransit.Messages.ReportFormat.Pdf">
            <summary>
              Portable Document Format
              Uses the 'PDF' rendering extension.
            </summary>
        </member>
        <member name="F:RSMassTransit.Messages.ReportFormat.Tiff">
            <summary>
              TIFF image format.
              Uses the 'IMAGE' rendering extension.
            </summary>
        </member>
        <member name="F:RSMassTransit.Messages.ReportFormat.Html4">
            <summary>
              HTML 4.0 format.
              Uses the 'HTML4.0' rendering extension.
            </summary>
        </member>
        <member name="F:RSMassTransit.Messages.ReportFormat.Html5">
            <summary>
              HTML 5 format.
              Uses the 'HTML5' rendering extension.
            </summary>
        </member>
        <member name="F:RSMassTransit.Messages.ReportFormat.Mhtml">
            <summary>
              MHTML (web archive) format.
              Uses the 'MHTML' rendering extension.
            </summary>
        </member>
        <member name="F:RSMassTransit.Messages.ReportFormat.Csv">
            <summary>
              Comma-separated values format.
              Uses the 'CSV' rendering extension.
            </summary>
        </member>
        <member name="F:RSMassTransit.Messages.ReportFormat.Xml">
            <summary>
              Data-only XML format.
              Uses the 'XML' rendering extension.
            </summary>
        </member>
    </members>
</doc>