-
Notifications
You must be signed in to change notification settings - Fork 255
/
TopicClient.xml
780 lines (774 loc) · 55.7 KB
/
TopicClient.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
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
<Type Name="TopicClient" FullName="Microsoft.ServiceBus.Messaging.TopicClient">
<TypeSignature Language="C#" Value="public abstract class TopicClient : Microsoft.ServiceBus.Messaging.MessagingEntityClient" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit TopicClient extends Microsoft.ServiceBus.Messaging.MessagingEntityClient" />
<TypeSignature Language="DocId" Value="T:Microsoft.ServiceBus.Messaging.TopicClient" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class TopicClient
Inherits MessagingEntityClient" />
<TypeSignature Language="F#" Value="type TopicClient = class
 inherit MessagingEntityClient" />
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.ServiceBus.Messaging.MessagingEntityClient</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>An anchor class used to access a <see cref="T:Microsoft.ServiceBus.Messaging.TopicDescription" /> to perform run-time operations.</summary>
<remarks>To be added.</remarks>
<example>
<code>
// Create settings for the MessagingFactory (for rutime operations)
MessagingFactorySettings factorySettings = new MessagingFactorySettings()
{
NetMessagingTransportSettings = new NetMessagingTransportSettings(),
Credential = TransportClientCredentialBase.CreateSharedSecretCredential(IssuerName, IssuerKey),
};
// Create the MessagingFactory
MessagingFactory factory =
MessagingFactory.Create(myServiceBusNamespace, factorySettings);
//********************************************************************************
// Sending messages to a Topic
//********************************************************************************
// Create topic client
TopicClient myTopicClient = factory.CreateTopicClient(myTopic);
// Create a sender
//MessageSender myMessageSender = myTopicClient.CreateSender(SendMode.Default);
// Send messages
List <object> Issues = new List <object>();
foreach (var issue in Issues)
{
myMessageSender.Send(new BrokeredMessage(issue));
}
</code>
</example>
<altmember cref="P:Microsoft.ServiceBus.Messaging.TopicClient.MessagingFactory" />
</Docs>
<Members>
<Member MemberName="CancelScheduledMessageAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task CancelScheduledMessageAsync (long sequenceNumber);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task CancelScheduledMessageAsync(int64 sequenceNumber) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.TopicClient.CancelScheduledMessageAsync(System.Int64)" />
<MemberSignature Language="VB.NET" Value="Public Function CancelScheduledMessageAsync (sequenceNumber As Long) As Task" />
<MemberSignature Language="F#" Value="member this.CancelScheduledMessageAsync : int64 -> System.Threading.Tasks.Task" Usage="topicClient.CancelScheduledMessageAsync sequenceNumber" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sequenceNumber" Type="System.Int64" />
</Parameters>
<Docs>
<param name="sequenceNumber">Returned on scheduling a message.</param>
<summary>
Cancels a scheduled message
</summary>
<returns />
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Create">
<MemberSignature Language="C#" Value="public static Microsoft.ServiceBus.Messaging.TopicClient Create (string path);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ServiceBus.Messaging.TopicClient Create(string path) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.TopicClient.Create(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Create (path As String) As TopicClient" />
<MemberSignature Language="F#" Value="static member Create : string -> Microsoft.ServiceBus.Messaging.TopicClient" Usage="Microsoft.ServiceBus.Messaging.TopicClient.Create path" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.TopicClient</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="path" Type="System.String" />
</Parameters>
<Docs>
<param name="path">The path.</param>
<summary>Creates a new instance of <see cref="T:Microsoft.ServiceBus.Messaging.TopicClient" />.</summary>
<returns>The created <see cref="T:Microsoft.ServiceBus.Messaging.TopicClient" />.</returns>
<remarks>This method will attempt to retrieve the connection string information
from either app.config, or web.config files. User must supply the connection
string using the "AppSettings" section of the configuration. The format of the section
is as follows:
<code><appSettings><!-- Service Bus specific app setings for messaging connections --><add key="Microsoft.ServiceBus.ConnectionString" value="Endpoint=sb://[your namespace].servicebus.windows.net;SharedSecretIssuer=owner;SharedSecretValue=[your secret]" /></appSettings></code></remarks>
</Docs>
</Member>
<Member MemberName="CreateFromConnectionString">
<MemberSignature Language="C#" Value="public static Microsoft.ServiceBus.Messaging.TopicClient CreateFromConnectionString (string connectionString);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ServiceBus.Messaging.TopicClient CreateFromConnectionString(string connectionString) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.TopicClient.CreateFromConnectionString(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function CreateFromConnectionString (connectionString As String) As TopicClient" />
<MemberSignature Language="F#" Value="static member CreateFromConnectionString : string -> Microsoft.ServiceBus.Messaging.TopicClient" Usage="Microsoft.ServiceBus.Messaging.TopicClient.CreateFromConnectionString connectionString" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.TopicClient</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="connectionString" Type="System.String" />
</Parameters>
<Docs>
<param name="connectionString">The connection string to use.</param>
<summary>Creates a new instance of <see cref="T:Microsoft.ServiceBus.Messaging.TopicClient" /> using the specified connection string.</summary>
<returns>Returns <see cref="T:Microsoft.ServiceBus.Messaging.TopicClient" />.</returns>
<remarks>This method expects the connection string supplied has entity level information such as the entity path and
authentication information supplied.</remarks>
</Docs>
</Member>
<Member MemberName="CreateFromConnectionString">
<MemberSignature Language="C#" Value="public static Microsoft.ServiceBus.Messaging.TopicClient CreateFromConnectionString (string connectionString, string path);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ServiceBus.Messaging.TopicClient CreateFromConnectionString(string connectionString, string path) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.TopicClient.CreateFromConnectionString(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function CreateFromConnectionString (connectionString As String, path As String) As TopicClient" />
<MemberSignature Language="F#" Value="static member CreateFromConnectionString : string * string -> Microsoft.ServiceBus.Messaging.TopicClient" Usage="Microsoft.ServiceBus.Messaging.TopicClient.CreateFromConnectionString (connectionString, path)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.TopicClient</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="connectionString" Type="System.String" />
<Parameter Name="path" Type="System.String" />
</Parameters>
<Docs>
<param name="connectionString">The connection string to use.</param>
<param name="path">The path.</param>
<summary>Creates a new instance of
<see cref="T:Microsoft.ServiceBus.Messaging.TopicClient" /> using the specified connection string and path to the topic. Use this overload only when the connection string does not use the
<see cref="P:Microsoft.ServiceBus.ServiceBusConnectionStringBuilder.EntityPath" /> property.</summary>
<returns>The created <see cref="T:Microsoft.ServiceBus.Messaging.TopicClient" />.</returns>
<remarks>This method should only be used with a connection string that has namespace level authentication because
the connection string supplied should not have entity level information associated with it.</remarks>
<exception cref="T:System.ArgumentException">Thrown when the format of the parameters is incorrect.</exception>
</Docs>
</Member>
<Member MemberName="CreateWithAzureActiveDirectory">
<MemberSignature Language="C#" Value="public static Microsoft.ServiceBus.Messaging.TopicClient CreateWithAzureActiveDirectory (Uri endpointAddress, string path, Microsoft.ServiceBus.AzureActiveDirectoryTokenProvider.AuthenticationCallback authCallback, string authority, TimeSpan? operationTimeout = default, Microsoft.ServiceBus.Messaging.TransportType transportType = Microsoft.ServiceBus.Messaging.TransportType.NetMessaging);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ServiceBus.Messaging.TopicClient CreateWithAzureActiveDirectory(class System.Uri endpointAddress, string path, class Microsoft.ServiceBus.AzureActiveDirectoryTokenProvider/AuthenticationCallback authCallback, string authority, valuetype System.Nullable`1<valuetype System.TimeSpan> operationTimeout, valuetype Microsoft.ServiceBus.Messaging.TransportType transportType) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.TopicClient.CreateWithAzureActiveDirectory(System.Uri,System.String,Microsoft.ServiceBus.AzureActiveDirectoryTokenProvider.AuthenticationCallback,System.String,System.Nullable{System.TimeSpan},Microsoft.ServiceBus.Messaging.TransportType)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function CreateWithAzureActiveDirectory (endpointAddress As Uri, path As String, authCallback As AzureActiveDirectoryTokenProvider.AuthenticationCallback, authority As String, Optional operationTimeout As Nullable(Of TimeSpan) = Nothing, Optional transportType As TransportType = Microsoft.ServiceBus.Messaging.TransportType.NetMessaging) As TopicClient" />
<MemberSignature Language="F#" Value="static member CreateWithAzureActiveDirectory : Uri * string * Microsoft.ServiceBus.AzureActiveDirectoryTokenProvider.AuthenticationCallback * string * Nullable<TimeSpan> * Microsoft.ServiceBus.Messaging.TransportType -> Microsoft.ServiceBus.Messaging.TopicClient" Usage="Microsoft.ServiceBus.Messaging.TopicClient.CreateWithAzureActiveDirectory (endpointAddress, path, authCallback, authority, operationTimeout, transportType)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.TopicClient</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="endpointAddress" Type="System.Uri" />
<Parameter Name="path" Type="System.String" />
<Parameter Name="authCallback" Type="Microsoft.ServiceBus.AzureActiveDirectoryTokenProvider+AuthenticationCallback" />
<Parameter Name="authority" Type="System.String" />
<Parameter Name="operationTimeout" Type="System.Nullable<System.TimeSpan>" />
<Parameter Name="transportType" Type="Microsoft.ServiceBus.Messaging.TransportType" />
</Parameters>
<Docs>
<param name="endpointAddress">Fully qualified domain name for Service Bus. Most likely, {yournamespace}.servicebus.windows.net</param>
<param name="path">The path to the topic.</param>
<param name="authCallback">The authentication delegate to provide access token.</param>
<param name="authority">Address of the authority to issue token.</param>
<param name="operationTimeout">
<see cref="T:System.TimeSpan" /> that specifies how long the messaging operation has to complete before timing out</param>
<param name="transportType">Messaging transport type.</param>
<summary>Creates a new instance of the
<see cref="T:Microsoft.ServiceBus.Messaging.TopicClient" /> by using authentication callback .</summary>
<returns>The created <see cref="T:Microsoft.ServiceBus.Messaging.TopicClient" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateWithManagedIdentity">
<MemberSignature Language="C#" Value="public static Microsoft.ServiceBus.Messaging.TopicClient CreateWithManagedIdentity (Uri endpointAddress, string path, TimeSpan? operationTimeout = default, Microsoft.ServiceBus.Messaging.TransportType transportType = Microsoft.ServiceBus.Messaging.TransportType.NetMessaging);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ServiceBus.Messaging.TopicClient CreateWithManagedIdentity(class System.Uri endpointAddress, string path, valuetype System.Nullable`1<valuetype System.TimeSpan> operationTimeout, valuetype Microsoft.ServiceBus.Messaging.TransportType transportType) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.TopicClient.CreateWithManagedIdentity(System.Uri,System.String,System.Nullable{System.TimeSpan},Microsoft.ServiceBus.Messaging.TransportType)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function CreateWithManagedIdentity (endpointAddress As Uri, path As String, Optional operationTimeout As Nullable(Of TimeSpan) = Nothing, Optional transportType As TransportType = Microsoft.ServiceBus.Messaging.TransportType.NetMessaging) As TopicClient" />
<MemberSignature Language="F#" Value="static member CreateWithManagedIdentity : Uri * string * Nullable<TimeSpan> * Microsoft.ServiceBus.Messaging.TransportType -> Microsoft.ServiceBus.Messaging.TopicClient" Usage="Microsoft.ServiceBus.Messaging.TopicClient.CreateWithManagedIdentity (endpointAddress, path, operationTimeout, transportType)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.TopicClient</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="endpointAddress" Type="System.Uri" />
<Parameter Name="path" Type="System.String" />
<Parameter Name="operationTimeout" Type="System.Nullable<System.TimeSpan>" />
<Parameter Name="transportType" Type="Microsoft.ServiceBus.Messaging.TransportType" />
</Parameters>
<Docs>
<param name="endpointAddress">Fully qualified domain name for Service Bus. Most likely, {yournamespace}.servicebus.windows.net</param>
<param name="path">The path to the topic.</param>
<param name="operationTimeout">
<see cref="T:System.TimeSpan" /> that specifies how long the messaging operation has to complete before timing out</param>
<param name="transportType">Messaging transport type.</param>
<summary>Creates a new instance of the
<see cref="T:Microsoft.ServiceBus.Messaging.TopicClient" /> by using Azure Managed Identity authentication.</summary>
<returns>The created <see cref="T:Microsoft.ServiceBus.Messaging.TopicClient" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FormatTransferDeadLetterPath">
<MemberSignature Language="C#" Value="public static string FormatTransferDeadLetterPath (string topicPath);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig string FormatTransferDeadLetterPath(string topicPath) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.TopicClient.FormatTransferDeadLetterPath(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function FormatTransferDeadLetterPath (topicPath As String) As String" />
<MemberSignature Language="F#" Value="static member FormatTransferDeadLetterPath : string -> string" Usage="Microsoft.ServiceBus.Messaging.TopicClient.FormatTransferDeadLetterPath topicPath" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="topicPath" Type="System.String" />
</Parameters>
<Docs>
<param name="topicPath">The topic path.</param>
<summary>A utility method that, given the topic path and subscription name, forms a
full path that points to the dead letter queue of the topic's transfer topic.</summary>
<returns>Returns a
<see cref="T:System.String" /> representing a full path that points to the dead letter queue of the transfer topic of the specified topic. This path can be used in receiver creation or in URI formation (such as a REST URI).</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsSubQueue">
<MemberSignature Language="C#" Value="protected bool IsSubQueue { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsSubQueue" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.TopicClient.IsSubQueue" />
<MemberSignature Language="VB.NET" Value="Protected ReadOnly Property IsSubQueue As Boolean" />
<MemberSignature Language="F#" Value="member this.IsSubQueue : bool" Usage="Microsoft.ServiceBus.Messaging.TopicClient.IsSubQueue" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that indicates whether the message receiver is created from a subqueue.</summary>
<value>true if the message receiver is created from a subqueue; otherwise, false.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MessagingFactory">
<MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.MessagingFactory MessagingFactory { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.ServiceBus.Messaging.MessagingFactory MessagingFactory" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.TopicClient.MessagingFactory" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property MessagingFactory As MessagingFactory" />
<MemberSignature Language="F#" Value="member this.MessagingFactory : Microsoft.ServiceBus.Messaging.MessagingFactory" Usage="Microsoft.ServiceBus.Messaging.TopicClient.MessagingFactory" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.MessagingFactory</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the messaging factory that was used in creating this
<see cref="T:Microsoft.ServiceBus.Messaging.TopicClient" /> object.</summary>
<value>The messaging factory that was used in creating this <see cref="T:Microsoft.ServiceBus.Messaging.TopicClient" /> object.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnAbort">
<MemberSignature Language="C#" Value="protected override void OnAbort ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void OnAbort() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.TopicClient.OnAbort" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub OnAbort ()" />
<MemberSignature Language="F#" Value="override this.OnAbort : unit -> unit" Usage="topicClient.OnAbort " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Executes the abort action.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnBeginClose">
<MemberSignature Language="C#" Value="protected override IAsyncResult OnBeginClose (TimeSpan timeout, AsyncCallback callback, object state);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance class System.IAsyncResult OnBeginClose(valuetype System.TimeSpan timeout, class System.AsyncCallback callback, object state) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.TopicClient.OnBeginClose(System.TimeSpan,System.AsyncCallback,System.Object)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function OnBeginClose (timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult" />
<MemberSignature Language="F#" Value="override this.OnBeginClose : TimeSpan * AsyncCallback * obj -> IAsyncResult" Usage="topicClient.OnBeginClose (timeout, callback, state)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IAsyncResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="timeout" Type="System.TimeSpan" />
<Parameter Name="callback" Type="System.AsyncCallback" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<param name="timeout">The wait time before the operation times out.</param>
<param name="callback">An
<see cref="T:System.AsyncCallback" /> delegate that references the method to invoke when the operation is complete.</param>
<param name="state">A user-defined object that contains information about the receive operation.
This object is passed to the EndClose delegate when the operation is complete.</param>
<summary>Executes the begin close action.</summary>
<returns>An <see cref="T:System.IAsyncResult" /> that references the asynchronous Close operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnBeginCreateSender">
<MemberSignature Language="C#" Value="protected abstract IAsyncResult OnBeginCreateSender (TimeSpan timeout, AsyncCallback callback, object state);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.IAsyncResult OnBeginCreateSender(valuetype System.TimeSpan timeout, class System.AsyncCallback callback, object state) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.TopicClient.OnBeginCreateSender(System.TimeSpan,System.AsyncCallback,System.Object)" />
<MemberSignature Language="VB.NET" Value="Protected MustOverride Function OnBeginCreateSender (timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult" />
<MemberSignature Language="F#" Value="abstract member OnBeginCreateSender : TimeSpan * AsyncCallback * obj -> IAsyncResult" Usage="topicClient.OnBeginCreateSender (timeout, callback, state)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IAsyncResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="timeout" Type="System.TimeSpan" />
<Parameter Name="callback" Type="System.AsyncCallback" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<param name="timeout">The wait time before the operation times out.</param>
<param name="callback">An
<see cref="T:System.AsyncCallback" /> delegate that references the method to invoke when the operation is complete.</param>
<param name="state">A user-defined object that contains information about the receive operation. This object is passed to the
<see cref="M:Microsoft.ServiceBus.Messaging.TopicClient.EndCreateSender(System.IAsyncResult)" /> when the operation is complete.</param>
<summary>Executes the begin create sender action.</summary>
<returns>An
<see cref="T:System.IAsyncResult" /> that references the asynchronous parent method.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnClose">
<MemberSignature Language="C#" Value="protected override void OnClose (TimeSpan timeout);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void OnClose(valuetype System.TimeSpan timeout) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.TopicClient.OnClose(System.TimeSpan)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub OnClose (timeout As TimeSpan)" />
<MemberSignature Language="F#" Value="override this.OnClose : TimeSpan -> unit" Usage="topicClient.OnClose timeout" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="timeout" Type="System.TimeSpan" />
</Parameters>
<Docs>
<param name="timeout">The wait time before the operation times out.</param>
<summary>Executes the close action.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnEndClose">
<MemberSignature Language="C#" Value="protected override void OnEndClose (IAsyncResult result);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void OnEndClose(class System.IAsyncResult result) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.TopicClient.OnEndClose(System.IAsyncResult)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub OnEndClose (result As IAsyncResult)" />
<MemberSignature Language="F#" Value="override this.OnEndClose : IAsyncResult -> unit" Usage="topicClient.OnEndClose result" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="System.IAsyncResult" />
</Parameters>
<Docs>
<param name="result">An <see cref="T:System.IAsyncResult" /> that references the asynchronous Close operation.</param>
<summary>Executes the end close action.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnEndCreateSender">
<MemberSignature Language="C#" Value="protected abstract Microsoft.ServiceBus.Messaging.MessageSender OnEndCreateSender (IAsyncResult result);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class Microsoft.ServiceBus.Messaging.MessageSender OnEndCreateSender(class System.IAsyncResult result) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.TopicClient.OnEndCreateSender(System.IAsyncResult)" />
<MemberSignature Language="VB.NET" Value="Protected MustOverride Function OnEndCreateSender (result As IAsyncResult) As MessageSender" />
<MemberSignature Language="F#" Value="abstract member OnEndCreateSender : IAsyncResult -> Microsoft.ServiceBus.Messaging.MessageSender" Usage="topicClient.OnEndCreateSender result" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.MessageSender</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="System.IAsyncResult" />
</Parameters>
<Docs>
<param name="result">An
<see cref="T:System.IAsyncResult" /> that references the asynchronous parent method.</param>
<summary>Executes the end create sender action.</summary>
<returns>The newly created <see cref="T:Microsoft.ServiceBus.Messaging.MessageSender" /> object.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Peek">
<MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.BrokeredMessage Peek ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.ServiceBus.Messaging.BrokeredMessage Peek() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.TopicClient.Peek" />
<MemberSignature Language="VB.NET" Value="Public Function Peek () As BrokeredMessage" />
<MemberSignature Language="F#" Value="abstract member Peek : unit -> Microsoft.ServiceBus.Messaging.BrokeredMessage
override this.Peek : unit -> Microsoft.ServiceBus.Messaging.BrokeredMessage" Usage="topicClient.Peek " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.BrokeredMessage</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary> Peeks a BrokeredMessage from current queue/topic. </summary>
<returns> return the peeked BrokeredMessage. A null is return if peek
operation cannot obtain the message within <see cref="P:Microsoft.ServiceBus.Messaging.MessagingFactorySettings.OperationTimeout" />.</returns>
<remarks>A Null can be return by this API if operation exceeded the timeout specified,
or the operations succeeded but there are no more messages to be received.</remarks>
</Docs>
</Member>
<Member MemberName="Peek">
<MemberSignature Language="C#" Value="public Microsoft.ServiceBus.Messaging.BrokeredMessage Peek (long fromSequenceNumber);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.ServiceBus.Messaging.BrokeredMessage Peek(int64 fromSequenceNumber) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.TopicClient.Peek(System.Int64)" />
<MemberSignature Language="VB.NET" Value="Public Function Peek (fromSequenceNumber As Long) As BrokeredMessage" />
<MemberSignature Language="F#" Value="abstract member Peek : int64 -> Microsoft.ServiceBus.Messaging.BrokeredMessage
override this.Peek : int64 -> Microsoft.ServiceBus.Messaging.BrokeredMessage" Usage="topicClient.Peek fromSequenceNumber" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.BrokeredMessage</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fromSequenceNumber" Type="System.Int64" />
</Parameters>
<Docs>
<param name="fromSequenceNumber"> The sequence number of message to start peeking from. </param>
<summary> Peeks a BrokeredMessage from current queue/topic. </summary>
<returns> return the peeked BrokeredMessage. A null is return if peek
operation cannot obtain the message within <see cref="P:Microsoft.ServiceBus.Messaging.MessagingFactorySettings.OperationTimeout" />.</returns>
<remarks>A Null can be return by this API if operation exceeded the timeout specified,
or the operations succeeded but there are no more messages to be received.</remarks>
</Docs>
</Member>
<Member MemberName="PeekAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.BrokeredMessage> PeekAsync ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceBus.Messaging.BrokeredMessage> PeekAsync() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.TopicClient.PeekAsync" />
<MemberSignature Language="VB.NET" Value="Public Function PeekAsync () As Task(Of BrokeredMessage)" />
<MemberSignature Language="F#" Value="abstract member PeekAsync : unit -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.BrokeredMessage>
override this.PeekAsync : unit -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.BrokeredMessage>" Usage="topicClient.PeekAsync " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.BrokeredMessage></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary />
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PeekAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.BrokeredMessage> PeekAsync (long fromSequenceNumber);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceBus.Messaging.BrokeredMessage> PeekAsync(int64 fromSequenceNumber) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.TopicClient.PeekAsync(System.Int64)" />
<MemberSignature Language="VB.NET" Value="Public Function PeekAsync (fromSequenceNumber As Long) As Task(Of BrokeredMessage)" />
<MemberSignature Language="F#" Value="abstract member PeekAsync : int64 -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.BrokeredMessage>
override this.PeekAsync : int64 -> System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.BrokeredMessage>" Usage="topicClient.PeekAsync fromSequenceNumber" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceBus.Messaging.BrokeredMessage></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fromSequenceNumber" Type="System.Int64" />
</Parameters>
<Docs>
<param name="fromSequenceNumber" />
<summary />
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PeekBatch">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage> PeekBatch (int messageCount);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Collections.Generic.IEnumerable`1<class Microsoft.ServiceBus.Messaging.BrokeredMessage> PeekBatch(int32 messageCount) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.TopicClient.PeekBatch(System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Function PeekBatch (messageCount As Integer) As IEnumerable(Of BrokeredMessage)" />
<MemberSignature Language="F#" Value="abstract member PeekBatch : int -> seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>
override this.PeekBatch : int -> seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>" Usage="topicClient.PeekBatch messageCount" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="messageCount" Type="System.Int32" />
</Parameters>
<Docs>
<param name="messageCount"> The maximum number of messages to peek. </param>
<summary> Peeks a BrokeredMessage from current queue/topic. </summary>
<returns> return a list of peeked BrokeredMessages. An empty list is returned if peek
operation cannot obtain the message within <see cref="P:Microsoft.ServiceBus.Messaging.MessagingFactorySettings.OperationTimeout" />.</returns>
<remarks>A Null can be return by this API if operation exceeded the timeout specified,
or the operations succeeded but there are no more messages to be received.</remarks>
</Docs>
</Member>
<Member MemberName="PeekBatch">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage> PeekBatch (long fromSequenceNumber, int messageCount);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Collections.Generic.IEnumerable`1<class Microsoft.ServiceBus.Messaging.BrokeredMessage> PeekBatch(int64 fromSequenceNumber, int32 messageCount) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.TopicClient.PeekBatch(System.Int64,System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Function PeekBatch (fromSequenceNumber As Long, messageCount As Integer) As IEnumerable(Of BrokeredMessage)" />
<MemberSignature Language="F#" Value="abstract member PeekBatch : int64 * int -> seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>
override this.PeekBatch : int64 * int -> seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>" Usage="topicClient.PeekBatch (fromSequenceNumber, messageCount)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fromSequenceNumber" Type="System.Int64" />
<Parameter Name="messageCount" Type="System.Int32" />
</Parameters>
<Docs>
<param name="fromSequenceNumber" />
<param name="messageCount" />
<summary />
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PeekBatchAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage>> PeekBatchAsync (int messageCount);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class System.Collections.Generic.IEnumerable`1<class Microsoft.ServiceBus.Messaging.BrokeredMessage>> PeekBatchAsync(int32 messageCount) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.TopicClient.PeekBatchAsync(System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Function PeekBatchAsync (messageCount As Integer) As Task(Of IEnumerable(Of BrokeredMessage))" />
<MemberSignature Language="F#" Value="abstract member PeekBatchAsync : int -> System.Threading.Tasks.Task<seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>>
override this.PeekBatchAsync : int -> System.Threading.Tasks.Task<seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>>" Usage="topicClient.PeekBatchAsync messageCount" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="messageCount" Type="System.Int32" />
</Parameters>
<Docs>
<param name="messageCount" />
<summary />
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PeekBatchAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage>> PeekBatchAsync (long fromSequenceNumber, int messageCount);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class System.Collections.Generic.IEnumerable`1<class Microsoft.ServiceBus.Messaging.BrokeredMessage>> PeekBatchAsync(int64 fromSequenceNumber, int32 messageCount) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.TopicClient.PeekBatchAsync(System.Int64,System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Function PeekBatchAsync (fromSequenceNumber As Long, messageCount As Integer) As Task(Of IEnumerable(Of BrokeredMessage))" />
<MemberSignature Language="F#" Value="abstract member PeekBatchAsync : int64 * int -> System.Threading.Tasks.Task<seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>>
override this.PeekBatchAsync : int64 * int -> System.Threading.Tasks.Task<seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>>" Usage="topicClient.PeekBatchAsync (fromSequenceNumber, messageCount)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="fromSequenceNumber" Type="System.Int64" />
<Parameter Name="messageCount" Type="System.Int32" />
</Parameters>
<Docs>
<param name="fromSequenceNumber" />
<param name="messageCount" />
<summary />
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ScheduleMessageAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<long> ScheduleMessageAsync (Microsoft.ServiceBus.Messaging.BrokeredMessage message, DateTimeOffset scheduleEnqueueTimeUtc);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<int64> ScheduleMessageAsync(class Microsoft.ServiceBus.Messaging.BrokeredMessage message, valuetype System.DateTimeOffset scheduleEnqueueTimeUtc) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.TopicClient.ScheduleMessageAsync(Microsoft.ServiceBus.Messaging.BrokeredMessage,System.DateTimeOffset)" />
<MemberSignature Language="VB.NET" Value="Public Function ScheduleMessageAsync (message As BrokeredMessage, scheduleEnqueueTimeUtc As DateTimeOffset) As Task(Of Long)" />
<MemberSignature Language="F#" Value="member this.ScheduleMessageAsync : Microsoft.ServiceBus.Messaging.BrokeredMessage * DateTimeOffset -> System.Threading.Tasks.Task<int64>" Usage="topicClient.ScheduleMessageAsync (message, scheduleEnqueueTimeUtc)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Int64></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="Microsoft.ServiceBus.Messaging.BrokeredMessage" />
<Parameter Name="scheduleEnqueueTimeUtc" Type="System.DateTimeOffset" />
</Parameters>
<Docs>
<param name="message">Message to be scheduled</param>
<param name="scheduleEnqueueTimeUtc">Time of enqueue</param>
<summary>
Sends a scheduled message
</summary>
<returns>Sequence number that is needed for cancelling.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Send">
<MemberSignature Language="C#" Value="public void Send (Microsoft.ServiceBus.Messaging.BrokeredMessage message);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Send(class Microsoft.ServiceBus.Messaging.BrokeredMessage message) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.TopicClient.Send(Microsoft.ServiceBus.Messaging.BrokeredMessage)" />
<MemberSignature Language="VB.NET" Value="Public Sub Send (message As BrokeredMessage)" />
<MemberSignature Language="F#" Value="abstract member Send : Microsoft.ServiceBus.Messaging.BrokeredMessage -> unit
override this.Send : Microsoft.ServiceBus.Messaging.BrokeredMessage -> unit" Usage="topicClient.Send message" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="Microsoft.ServiceBus.Messaging.BrokeredMessage" />
</Parameters>
<Docs>
<param name="message">The message to send.</param>
<summary>Sends a message using the <see cref="P:Microsoft.ServiceBus.Messaging.TopicClient.InternalSender" />.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.TimeoutException">Thrown when operation times out. Timeout period is initialized through the
<see cref="P:Microsoft.ServiceBus.Messaging.MessagingFactorySettings.OperationTimeout" /> to avoid this exception if timeout value is relatively low.</exception>
<exception cref="T:System.ArgumentException">Thrown when the <see cref="T:Microsoft.ServiceBus.Messaging.BrokeredMessage" /> is null.</exception>
<exception cref="T:System.InvalidOperationException">Thrown if the <paramref name="message" /> has already been sent by a
<see cref="T:Microsoft.ServiceBus.Messaging.TopicClient" /> or
<see cref="T:Microsoft.ServiceBus.Messaging.MessageSender" /> once already.</exception>
<exception cref="T:System.OperationCanceledException">Thrown if the client entity has been closed or aborted.</exception>
<exception cref="T:System.UnauthorizedAccessException">Thrown if there is an I/O or security error.</exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">Thrown when an
error occurs during serialization or deserialization.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessagingEntityNotFoundException">Thrown if the topic does not exist.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.MessagingException">Thrown if there is a messaging error.</exception>
</Docs>
</Member>
<Member MemberName="SendAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task SendAsync (Microsoft.ServiceBus.Messaging.BrokeredMessage message);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task SendAsync(class Microsoft.ServiceBus.Messaging.BrokeredMessage message) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.TopicClient.SendAsync(Microsoft.ServiceBus.Messaging.BrokeredMessage)" />
<MemberSignature Language="VB.NET" Value="Public Function SendAsync (message As BrokeredMessage) As Task" />
<MemberSignature Language="F#" Value="abstract member SendAsync : Microsoft.ServiceBus.Messaging.BrokeredMessage -> System.Threading.Tasks.Task
override this.SendAsync : Microsoft.ServiceBus.Messaging.BrokeredMessage -> System.Threading.Tasks.Task" Usage="topicClient.SendAsync message" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="Microsoft.ServiceBus.Messaging.BrokeredMessage" />
</Parameters>
<Docs>
<param name="message">The message to send.</param>
<summary>Asynchronously sends a message using the <see cref="P:Microsoft.ServiceBus.Messaging.TopicClient.InternalSender" />.</summary>
<returns>The asynchronous result of the operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SendBatch">
<MemberSignature Language="C#" Value="public void SendBatch (System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage> messages);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void SendBatch(class System.Collections.Generic.IEnumerable`1<class Microsoft.ServiceBus.Messaging.BrokeredMessage> messages) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.TopicClient.SendBatch(System.Collections.Generic.IEnumerable{Microsoft.ServiceBus.Messaging.BrokeredMessage})" />
<MemberSignature Language="VB.NET" Value="Public Sub SendBatch (messages As IEnumerable(Of BrokeredMessage))" />
<MemberSignature Language="F#" Value="abstract member SendBatch : seq<Microsoft.ServiceBus.Messaging.BrokeredMessage> -> unit
override this.SendBatch : seq<Microsoft.ServiceBus.Messaging.BrokeredMessage> -> unit" Usage="topicClient.SendBatch messages" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="messages" Type="System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage>" />
</Parameters>
<Docs>
<param name="messages">The messages to send.</param>
<summary>Sends a set of brokered messages (for batch processing).</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SendBatchAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task SendBatchAsync (System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage> messages);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task SendBatchAsync(class System.Collections.Generic.IEnumerable`1<class Microsoft.ServiceBus.Messaging.BrokeredMessage> messages) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.TopicClient.SendBatchAsync(System.Collections.Generic.IEnumerable{Microsoft.ServiceBus.Messaging.BrokeredMessage})" />
<MemberSignature Language="VB.NET" Value="Public Function SendBatchAsync (messages As IEnumerable(Of BrokeredMessage)) As Task" />
<MemberSignature Language="F#" Value="abstract member SendBatchAsync : seq<Microsoft.ServiceBus.Messaging.BrokeredMessage> -> System.Threading.Tasks.Task
override this.SendBatchAsync : seq<Microsoft.ServiceBus.Messaging.BrokeredMessage> -> System.Threading.Tasks.Task" Usage="topicClient.SendBatchAsync messages" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="messages" Type="System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage>" />
</Parameters>
<Docs>
<param name="messages">The messages to send.</param>
<summary>Asynchronously sends a set of brokered messages (for batch processing).</summary>
<returns>The asynchronous result of the operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>