RSMassTransit.Client.xml
|
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 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 |
<?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> |