-
Notifications
You must be signed in to change notification settings - Fork 256
/
Message.xml
569 lines (569 loc) · 32.3 KB
/
Message.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
<Type Name="Message" FullName="Microsoft.Azure.ServiceBus.Message">
<TypeSignature Language="C#" Value="public class Message" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Message extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.ServiceBus.Message" />
<TypeSignature Language="VB.NET" Value="Public Class Message" />
<TypeSignature Language="F#" Value="type Message = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.1.3.0</AssemblyVersion>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
The message object used to communicate and transfer data with Service Bus.
</summary>
<remarks>
The message structure is discussed in detail in the <a href="https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads">product documentation.</a></remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Message ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ServiceBus.Message.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Creates a new Message
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Message (byte[] body);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(unsigned int8[] body) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ServiceBus.Message.#ctor(System.Byte[])" />
<MemberSignature Language="VB.NET" Value="Public Sub New (body As Byte())" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.ServiceBus.Message : byte[] -> Microsoft.Azure.ServiceBus.Message" Usage="new Microsoft.Azure.ServiceBus.Message body" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="body" Type="System.Byte[]" />
</Parameters>
<Docs>
<param name="body">The payload of the message in bytes</param>
<summary>
Creates a new message from the specified payload.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Body">
<MemberSignature Language="C#" Value="public byte[] Body { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance unsigned int8[] Body" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.Message.Body" />
<MemberSignature Language="VB.NET" Value="Public Property Body As Byte()" />
<MemberSignature Language="F#" Value="member this.Body : byte[] with get, set" Usage="Microsoft.Azure.ServiceBus.Message.Body" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Byte[]</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the body of the message.
</summary>
<value>To be added.</value>
<remarks>
The easiest way to create a new message from a string is the following:
<code>
message.Body = System.Text.Encoding.UTF8.GetBytes("Message1");
</code></remarks>
</Docs>
</Member>
<Member MemberName="Clone">
<MemberSignature Language="C#" Value="public Microsoft.Azure.ServiceBus.Message Clone ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Azure.ServiceBus.Message Clone() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ServiceBus.Message.Clone" />
<MemberSignature Language="VB.NET" Value="Public Function Clone () As Message" />
<MemberSignature Language="F#" Value="member this.Clone : unit -> Microsoft.Azure.ServiceBus.Message" Usage="message.Clone " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.ServiceBus.Message</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Clones a message, so that it is possible to send a clone of an already received
message as a new message. The system properties of original message
are not copied.</summary>
<returns>A cloned <see cref="T:Microsoft.Azure.ServiceBus.Message" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ContentType">
<MemberSignature Language="C#" Value="public string ContentType { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ContentType" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.Message.ContentType" />
<MemberSignature Language="VB.NET" Value="Public Property ContentType As String" />
<MemberSignature Language="F#" Value="member this.ContentType : string with get, set" Usage="Microsoft.Azure.ServiceBus.Message.ContentType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the content type descriptor.</summary>
<value>RFC2045 Content-Type descriptor.</value>
<remarks>
Optionally describes the payload of the message, with a descriptor following the format of
RFC2045, Section 5, for example "application/json".
</remarks>
</Docs>
</Member>
<Member MemberName="CorrelationId">
<MemberSignature Language="C#" Value="public string CorrelationId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string CorrelationId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.Message.CorrelationId" />
<MemberSignature Language="VB.NET" Value="Public Property CorrelationId As String" />
<MemberSignature Language="F#" Value="member this.CorrelationId : string with get, set" Usage="Microsoft.Azure.ServiceBus.Message.CorrelationId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the a correlation identifier.</summary>
<value>Correlation identifier.</value>
<remarks>
Allows an application to specify a context for the message for the purposes of correlation,
for example reflecting the MessageId of a message that is being replied to.
See <a href="https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation">Message Routing and Correlation</a>.
</remarks>
</Docs>
</Member>
<Member MemberName="DeadLetterErrorDescriptionHeader">
<MemberSignature Language="C#" Value="public static string DeadLetterErrorDescriptionHeader;" />
<MemberSignature Language="ILAsm" Value=".field public static string DeadLetterErrorDescriptionHeader" />
<MemberSignature Language="DocId" Value="F:Microsoft.Azure.ServiceBus.Message.DeadLetterErrorDescriptionHeader" />
<MemberSignature Language="VB.NET" Value="Public Shared DeadLetterErrorDescriptionHeader As String " />
<MemberSignature Language="F#" Value=" staticval mutable DeadLetterErrorDescriptionHeader : string" Usage="Microsoft.Azure.ServiceBus.Message.DeadLetterErrorDescriptionHeader" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
User property key representing detailed error description, when a message is received from a deadletter subqueue of an entity.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DeadLetterReasonHeader">
<MemberSignature Language="C#" Value="public static string DeadLetterReasonHeader;" />
<MemberSignature Language="ILAsm" Value=".field public static string DeadLetterReasonHeader" />
<MemberSignature Language="DocId" Value="F:Microsoft.Azure.ServiceBus.Message.DeadLetterReasonHeader" />
<MemberSignature Language="VB.NET" Value="Public Shared DeadLetterReasonHeader As String " />
<MemberSignature Language="F#" Value=" staticval mutable DeadLetterReasonHeader : string" Usage="Microsoft.Azure.ServiceBus.Message.DeadLetterReasonHeader" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
User property key representing deadletter reason, when a message is received from a deadletter subqueue of an entity.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ExpiresAtUtc">
<MemberSignature Language="C#" Value="public DateTime ExpiresAtUtc { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime ExpiresAtUtc" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.Message.ExpiresAtUtc" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ExpiresAtUtc As DateTime" />
<MemberSignature Language="F#" Value="member this.ExpiresAtUtc : DateTime" Usage="Microsoft.Azure.ServiceBus.Message.ExpiresAtUtc" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the date and time in UTC at which the message is set to expire.</summary>
<value>The message expiration time in UTC. This property is read-only.</value>
<remarks>
The UTC instant at which the message is marked for removal and no longer available for retrieval
from the entity due to expiration. Expiry is controlled by the <see cref="P:Microsoft.Azure.ServiceBus.Message.TimeToLive" /> property
and this property is computed from <see cref="P:Microsoft.Azure.ServiceBus.Message.SystemPropertiesCollection.EnqueuedTimeUtc" />+<see cref="P:Microsoft.Azure.ServiceBus.Message.TimeToLive" /></remarks>
<exception cref="T:System.InvalidOperationException">If the message has not been received. For example if a new message was created but not yet sent and received.</exception>
</Docs>
</Member>
<Member MemberName="Label">
<MemberSignature Language="C#" Value="public string Label { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Label" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.Message.Label" />
<MemberSignature Language="VB.NET" Value="Public Property Label As String" />
<MemberSignature Language="F#" Value="member this.Label : string with get, set" Usage="Microsoft.Azure.ServiceBus.Message.Label" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets an application specific label.</summary>
<value>The application specific label</value>
<remarks>
This property enables the application to indicate the purpose of the message to the receiver in a standardized
fashion, similar to an email subject line. The mapped AMQP property is "subject".
</remarks>
</Docs>
</Member>
<Member MemberName="MessageId">
<MemberSignature Language="C#" Value="public string MessageId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string MessageId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.Message.MessageId" />
<MemberSignature Language="VB.NET" Value="Public Property MessageId As String" />
<MemberSignature Language="F#" Value="member this.MessageId : string with get, set" Usage="Microsoft.Azure.ServiceBus.Message.MessageId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the MessageId to identify the message.
</summary>
<value>To be added.</value>
<remarks>
The message identifier is an application-defined value that uniquely identifies the
message and its payload. The identifier is a free-form string and can reflect a GUID
or an identifier derived from the application context. If enabled, the
<a href="https://docs.microsoft.com/azure/service-bus-messaging/duplicate-detection">duplicate detection</a>
feature identifies and removes second and further submissions of messages with the
same MessageId.
</remarks>
</Docs>
</Member>
<Member MemberName="PartitionKey">
<MemberSignature Language="C#" Value="public string PartitionKey { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string PartitionKey" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.Message.PartitionKey" />
<MemberSignature Language="VB.NET" Value="Public Property PartitionKey As String" />
<MemberSignature Language="F#" Value="member this.PartitionKey : string with get, set" Usage="Microsoft.Azure.ServiceBus.Message.PartitionKey" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a partition key for sending a message to a partitioned entity.</summary>
<value>The partition key. Maximum length is 128 characters.</value>
<remarks>
For <a href="https://docs.microsoft.com/azure/service-bus-messaging/service-bus-partitioning">partitioned entities</a>,
setting this value enables assigning related messages to the same internal partition, so that submission sequence
order is correctly recorded. The partition is chosen by a hash function over this value and cannot be chosen
directly. For session-aware entities, the <see cref="P:Microsoft.Azure.ServiceBus.Message.SessionId" /> property overrides this value.
</remarks>
</Docs>
</Member>
<Member MemberName="ReplyTo">
<MemberSignature Language="C#" Value="public string ReplyTo { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ReplyTo" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.Message.ReplyTo" />
<MemberSignature Language="VB.NET" Value="Public Property ReplyTo As String" />
<MemberSignature Language="F#" Value="member this.ReplyTo : string with get, set" Usage="Microsoft.Azure.ServiceBus.Message.ReplyTo" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the address of an entity to send replies to.</summary>
<value>The reply entity address.</value>
<remarks>
This optional and application-defined value is a standard way to express a reply path
to the receiver of the message. When a sender expects a reply, it sets the value to the
absolute or relative path of the queue or topic it expects the reply to be sent to.
See <a href="https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation">Message Routing and Correlation</a>.
</remarks>
</Docs>
</Member>
<Member MemberName="ReplyToSessionId">
<MemberSignature Language="C#" Value="public string ReplyToSessionId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ReplyToSessionId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.Message.ReplyToSessionId" />
<MemberSignature Language="VB.NET" Value="Public Property ReplyToSessionId As String" />
<MemberSignature Language="F#" Value="member this.ReplyToSessionId : string with get, set" Usage="Microsoft.Azure.ServiceBus.Message.ReplyToSessionId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a session identifier augmenting the <see cref="P:Microsoft.Azure.ServiceBus.Message.ReplyTo" /> address.</summary>
<value>Session identifier. Maximum length is 128 characters.</value>
<remarks>
This value augments the ReplyTo information and specifies which SessionId should be set
for the reply when sent to the reply entity. See <a href="https://docs.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads?#message-routing-and-correlation">Message Routing and Correlation</a></remarks>
</Docs>
</Member>
<Member MemberName="ScheduledEnqueueTimeUtc">
<MemberSignature Language="C#" Value="public DateTime ScheduledEnqueueTimeUtc { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime ScheduledEnqueueTimeUtc" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.Message.ScheduledEnqueueTimeUtc" />
<MemberSignature Language="VB.NET" Value="Public Property ScheduledEnqueueTimeUtc As DateTime" />
<MemberSignature Language="F#" Value="member this.ScheduledEnqueueTimeUtc : DateTime with get, set" Usage="Microsoft.Azure.ServiceBus.Message.ScheduledEnqueueTimeUtc" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the date and time in UTC at which the message will be enqueued. This
property returns the time in UTC; when setting the property, the supplied DateTime value must also be in UTC.</summary>
<value>The scheduled enqueue time in UTC. This value is for delayed message sending.
It is utilized to delay messages sending to a specific time in the future.</value>
<remarks> Message enqueuing time does not mean that the message will be sent at the same time. It will get enqueued, but the actual sending time
depends on the queue's workload and its state.</remarks>
</Docs>
</Member>
<Member MemberName="SessionId">
<MemberSignature Language="C#" Value="public string SessionId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string SessionId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.Message.SessionId" />
<MemberSignature Language="VB.NET" Value="Public Property SessionId As String" />
<MemberSignature Language="F#" Value="member this.SessionId : string with get, set" Usage="Microsoft.Azure.ServiceBus.Message.SessionId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the session identifier for a session-aware entity.</summary>
<value>The session identifier. Maximum length is 128 characters.</value>
<remarks>
For session-aware entities, this application-defined value specifies the session
affiliation of the message. Messages with the same session identifier are subject
to summary locking and enable exact in-order processing and demultiplexing.
For session-unaware entities, this value is ignored.
See <a href="https://docs.microsoft.com/azure/service-bus-messaging/message-sessions">Message Sessions</a>.
</remarks>
</Docs>
</Member>
<Member MemberName="Size">
<MemberSignature Language="C#" Value="public long Size { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 Size" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.Message.Size" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Size As Long" />
<MemberSignature Language="F#" Value="member this.Size : int64" Usage="Microsoft.Azure.ServiceBus.Message.Size" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the total size of the message body in bytes.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SystemProperties">
<MemberSignature Language="C#" Value="public Microsoft.Azure.ServiceBus.Message.SystemPropertiesCollection SystemProperties { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.ServiceBus.Message/SystemPropertiesCollection SystemProperties" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.Message.SystemProperties" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property SystemProperties As Message.SystemPropertiesCollection" />
<MemberSignature Language="F#" Value="member this.SystemProperties : Microsoft.Azure.ServiceBus.Message.SystemPropertiesCollection" Usage="Microsoft.Azure.ServiceBus.Message.SystemProperties" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.ServiceBus.Message+SystemPropertiesCollection</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the <see cref="T:Microsoft.Azure.ServiceBus.Message.SystemPropertiesCollection" />, which is used to store properties that are set by the system.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TimeToLive">
<MemberSignature Language="C#" Value="public TimeSpan TimeToLive { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan TimeToLive" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.Message.TimeToLive" />
<MemberSignature Language="VB.NET" Value="Public Property TimeToLive As TimeSpan" />
<MemberSignature Language="F#" Value="member this.TimeToLive : TimeSpan with get, set" Usage="Microsoft.Azure.ServiceBus.Message.TimeToLive" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the message’s "time to live" value.
</summary>
<value>The message’s time to live value.</value>
<remarks>
This value is the relative duration after which the message expires, starting from the instant
the message has been accepted and stored by the broker, as captured in <see cref="P:Microsoft.Azure.ServiceBus.Message.SystemPropertiesCollection.EnqueuedTimeUtc" />.
When not set explicitly, the assumed value is the DefaultTimeToLive for the respective queue or topic.
A message-level <see cref="P:Microsoft.Azure.ServiceBus.Message.TimeToLive" /> value cannot be longer than the entity's DefaultTimeToLive
setting and it is silently adjusted if it does.
See <a href="https://docs.microsoft.com/azure/service-bus-messaging/message-expiration">Expiration</a></remarks>
</Docs>
</Member>
<Member MemberName="To">
<MemberSignature Language="C#" Value="public string To { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string To" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.Message.To" />
<MemberSignature Language="VB.NET" Value="Public Property To As String" />
<MemberSignature Language="F#" Value="member this.To : string with get, set" Usage="Microsoft.Azure.ServiceBus.Message.To" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the "to" address.</summary>
<value>The "to" address.</value>
<remarks>
This property is reserved for future use in routing scenarios and presently ignored by the broker itself.
Applications can use this value in rule-driven
<a href="https://docs.microsoft.com/azure/service-bus-messaging/service-bus-auto-forwarding">auto-forward chaining</a> scenarios to indicate the
intended logical destination of the message.
</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ServiceBus.Message.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="message.ToString " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns a string that represents the current message.</summary>
<returns>The string representation of the current message.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UserProperties">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IDictionary<string,object> UserProperties { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IDictionary`2<string, object> UserProperties" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.Message.UserProperties" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property UserProperties As IDictionary(Of String, Object)" />
<MemberSignature Language="F#" Value="member this.UserProperties : System.Collections.Generic.IDictionary<string, obj>" Usage="Microsoft.Azure.ServiceBus.Message.UserProperties" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IDictionary<System.String,System.Object></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the "user properties" bag, which can be used for custom message metadata.
</summary>
<value>To be added.</value>
<remarks>
Only following value types are supported:
byte, sbyte, char, short, ushort, int, uint, long, ulong, float, double, decimal,
bool, Guid, string, Uri, DateTime, DateTimeOffset, TimeSpan
</remarks>
</Docs>
</Member>
<Member MemberName="ViaPartitionKey">
<MemberSignature Language="C#" Value="public string ViaPartitionKey { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ViaPartitionKey" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.Message.ViaPartitionKey" />
<MemberSignature Language="VB.NET" Value="Public Property ViaPartitionKey As String" />
<MemberSignature Language="F#" Value="member this.ViaPartitionKey : string with get, set" Usage="Microsoft.Azure.ServiceBus.Message.ViaPartitionKey" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a partition key for sending a message into an entity via a partitioned transfer queue.</summary>
<value>The partition key. Maximum length is 128 characters. </value>
<remarks>
If a message is sent via a transfer queue in the scope of a transaction, this value selects the
transfer queue partition: This is functionally equivalent to <see cref="P:Microsoft.Azure.ServiceBus.Message.PartitionKey" /> and ensures that
messages are kept together and in order as they are transferred.
See <a href="https://docs.microsoft.com/azure/service-bus-messaging/service-bus-transactions#transfers-and-send-via">Transfers and Send Via</a>.
</remarks>
</Docs>
</Member>
</Members>
</Type>