-
Notifications
You must be signed in to change notification settings - Fork 255
/
NotificationMessagesClient.xml
682 lines (670 loc) · 54.7 KB
/
NotificationMessagesClient.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
<Type Name="NotificationMessagesClient" FullName="Azure.Communication.Messages.NotificationMessagesClient">
<TypeSignature Language="C#" Value="public class NotificationMessagesClient" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit NotificationMessagesClient extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.Communication.Messages.NotificationMessagesClient" />
<TypeSignature Language="VB.NET" Value="Public Class NotificationMessagesClient" />
<TypeSignature Language="F#" Value="type NotificationMessagesClient = class" />
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary> The NotificationMessages service client. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected NotificationMessagesClient ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.NotificationMessagesClient.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of <see cref="T:Azure.Communication.Messages.NotificationMessagesClient" /> for mocking.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public NotificationMessagesClient (string connectionString);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string connectionString) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.NotificationMessagesClient.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (connectionString As String)" />
<MemberSignature Language="F#" Value="new Azure.Communication.Messages.NotificationMessagesClient : string -> Azure.Communication.Messages.NotificationMessagesClient" Usage="new Azure.Communication.Messages.NotificationMessagesClient connectionString" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="connectionString" Type="System.String" />
</Parameters>
<Docs>
<param name="connectionString">Connection string acquired from the Azure Communication Services resource.</param>
<summary>
Initializes a new instance of <see cref="T:Azure.Communication.Messages.NotificationMessagesClient" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public NotificationMessagesClient (string connectionString, Azure.Communication.Messages.CommunicationMessagesClientOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string connectionString, class Azure.Communication.Messages.CommunicationMessagesClientOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.NotificationMessagesClient.#ctor(System.String,Azure.Communication.Messages.CommunicationMessagesClientOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (connectionString As String, options As CommunicationMessagesClientOptions)" />
<MemberSignature Language="F#" Value="new Azure.Communication.Messages.NotificationMessagesClient : string * Azure.Communication.Messages.CommunicationMessagesClientOptions -> Azure.Communication.Messages.NotificationMessagesClient" Usage="new Azure.Communication.Messages.NotificationMessagesClient (connectionString, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="connectionString" Type="System.String" />
<Parameter Name="options" Type="Azure.Communication.Messages.CommunicationMessagesClientOptions" />
</Parameters>
<Docs>
<param name="connectionString">Connection string acquired from the Azure Communication Services resource.</param>
<param name="options">Client options exposing <see cref="P:Azure.Core.ClientOptions.Diagnostics" />, <see cref="P:Azure.Core.ClientOptions.Retry" />, <see cref="P:Azure.Core.ClientOptions.Transport" />, etc.</param>
<summary> Initializes a new instance of <see cref="T:Azure.Communication.Messages.NotificationMessagesClient" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public NotificationMessagesClient (Uri endpoint, Azure.AzureKeyCredential credential);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.AzureKeyCredential credential) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.NotificationMessagesClient.#ctor(System.Uri,Azure.AzureKeyCredential)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As AzureKeyCredential)" />
<MemberSignature Language="F#" Value="new Azure.Communication.Messages.NotificationMessagesClient : Uri * Azure.AzureKeyCredential -> Azure.Communication.Messages.NotificationMessagesClient" Usage="new Azure.Communication.Messages.NotificationMessagesClient (endpoint, credential)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="credential" Type="Azure.AzureKeyCredential" Index="1" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="endpoint"> The communication resource, for example https://my-resource.communication.azure.com. </param>
<param name="credential"> A credential used to authenticate to an Azure Service. </param>
<summary> Initializes a new instance of NotificationMessagesClient. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="endpoint" /> or <paramref name="credential" /> is null. </exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public NotificationMessagesClient (Uri endpoint, Azure.Core.TokenCredential credential);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.Core.TokenCredential credential) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.NotificationMessagesClient.#ctor(System.Uri,Azure.Core.TokenCredential)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As TokenCredential)" />
<MemberSignature Language="F#" Value="new Azure.Communication.Messages.NotificationMessagesClient : Uri * Azure.Core.TokenCredential -> Azure.Communication.Messages.NotificationMessagesClient" Usage="new Azure.Communication.Messages.NotificationMessagesClient (endpoint, credential)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="credential" Type="Azure.Core.TokenCredential" Index="1" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="endpoint"> The communication resource, for example https://my-resource.communication.azure.com. </param>
<param name="credential"> A credential used to authenticate to an Azure Service. </param>
<summary> Initializes a new instance of NotificationMessagesClient. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="endpoint" /> or <paramref name="credential" /> is null. </exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public NotificationMessagesClient (Uri endpoint, Azure.Core.TokenCredential credential, Azure.Communication.Messages.CommunicationMessagesClientOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.Core.TokenCredential credential, class Azure.Communication.Messages.CommunicationMessagesClientOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.NotificationMessagesClient.#ctor(System.Uri,Azure.Core.TokenCredential,Azure.Communication.Messages.CommunicationMessagesClientOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As TokenCredential, options As CommunicationMessagesClientOptions)" />
<MemberSignature Language="F#" Value="new Azure.Communication.Messages.NotificationMessagesClient : Uri * Azure.Core.TokenCredential * Azure.Communication.Messages.CommunicationMessagesClientOptions -> Azure.Communication.Messages.NotificationMessagesClient" Usage="new Azure.Communication.Messages.NotificationMessagesClient (endpoint, credential, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="credential" Type="Azure.Core.TokenCredential" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="options" Type="Azure.Communication.Messages.CommunicationMessagesClientOptions" Index="2" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="endpoint"> The communication resource, for example https://my-resource.communication.azure.com. </param>
<param name="credential"> A credential used to authenticate to an Azure Service. </param>
<param name="options"> The options for configuring the client. </param>
<summary> Initializes a new instance of NotificationMessagesClient. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="endpoint" /> or <paramref name="credential" /> is null. </exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public NotificationMessagesClient (Uri endpoint, Azure.AzureKeyCredential credential, Azure.Communication.Messages.CommunicationMessagesClientOptions options = default);" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.AzureKeyCredential credential, class Azure.Communication.Messages.CommunicationMessagesClientOptions options) cil managed" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.NotificationMessagesClient.#ctor(System.Uri,Azure.AzureKeyCredential,Azure.Communication.Messages.CommunicationMessagesClientOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As AzureKeyCredential, Optional options As CommunicationMessagesClientOptions = Nothing)" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="F#" Value="new Azure.Communication.Messages.NotificationMessagesClient : Uri * Azure.AzureKeyCredential * Azure.Communication.Messages.CommunicationMessagesClientOptions -> Azure.Communication.Messages.NotificationMessagesClient" Usage="new Azure.Communication.Messages.NotificationMessagesClient (endpoint, credential, options)" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="C#" Value="public NotificationMessagesClient (Uri endpoint, Azure.AzureKeyCredential keyCredential, Azure.Communication.Messages.CommunicationMessagesClientOptions options = default);" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.AzureKeyCredential keyCredential, class Azure.Communication.Messages.CommunicationMessagesClientOptions options) cil managed" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, keyCredential As AzureKeyCredential, Optional options As CommunicationMessagesClientOptions = Nothing)" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="F#" Value="new Azure.Communication.Messages.NotificationMessagesClient : Uri * Azure.AzureKeyCredential * Azure.Communication.Messages.CommunicationMessagesClientOptions -> Azure.Communication.Messages.NotificationMessagesClient" Usage="new Azure.Communication.Messages.NotificationMessagesClient (endpoint, keyCredential, options)" FrameworkAlternate="azure-dotnet-preview" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" Index="0" />
<Parameter Name="credential" Type="Azure.AzureKeyCredential" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="keyCredential" Type="Azure.AzureKeyCredential" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="options" Type="Azure.Communication.Messages.CommunicationMessagesClientOptions" Index="2" />
</Parameters>
<Docs>
<param name="endpoint">The URI of the Azure Communication Services resource.</param>
<param name="credential">The <see cref="T:Azure.AzureKeyCredential" /> used to authenticate requests.</param>
<param name="keyCredential">The <see cref="T:Azure.AzureKeyCredential" /> used to authenticate requests.</param>
<param name="options">Client options exposing <see cref="P:Azure.Core.ClientOptions.Diagnostics" />, <see cref="P:Azure.Core.ClientOptions.Retry" />, <see cref="P:Azure.Core.ClientOptions.Transport" />, etc.</param>
<summary> Initializes a new instance of <see cref="T:Azure.Communication.Messages.NotificationMessagesClient" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DownloadMedia">
<MemberSignature Language="C#" Value="public virtual Azure.Response<System.IO.Stream> DownloadMedia (string mediaContentId, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class System.IO.Stream> DownloadMedia(string mediaContentId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.NotificationMessagesClient.DownloadMedia(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function DownloadMedia (mediaContentId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of Stream)" />
<MemberSignature Language="F#" Value="abstract member DownloadMedia : string * System.Threading.CancellationToken -> Azure.Response<System.IO.Stream>
override this.DownloadMedia : string * System.Threading.CancellationToken -> Azure.Response<System.IO.Stream>" Usage="notificationMessagesClient.DownloadMedia (mediaContentId, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<System.IO.Stream></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="mediaContentId" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="mediaContentId">The Media Identifier contained in the User to Business message event.</param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
The <see cref="M:Azure.Communication.Messages.NotificationMessagesClient.DownloadMedia(System.String,System.Threading.CancellationToken)" /> downloads
the Media payload from a User to Business message asynchronously.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException">The server returned an error. See <see cref="P:System.Exception.Message" /> for details returned from the server.</exception>
</Docs>
</Member>
<Member MemberName="DownloadMediaAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<System.IO.Stream>> DownloadMediaAsync (string mediaContentId, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class System.IO.Stream>> DownloadMediaAsync(string mediaContentId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.NotificationMessagesClient.DownloadMediaAsync(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function DownloadMediaAsync (mediaContentId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of Stream))" />
<MemberSignature Language="F#" Value="abstract member DownloadMediaAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<System.IO.Stream>>
override this.DownloadMediaAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<System.IO.Stream>>" Usage="notificationMessagesClient.DownloadMediaAsync (mediaContentId, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<System.IO.Stream>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="mediaContentId" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="mediaContentId">The Media Identifier contained in the User to Business message event.</param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Download the Media payload from a User to Business message asynchronously. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException">The server returned an error. See <see cref="P:System.Exception.Message" /> for details returned from the server.</exception>
</Docs>
</Member>
<Member MemberName="DownloadMediaTo">
<MemberSignature Language="C#" Value="public virtual Azure.Response DownloadMediaTo (string mediaContentId, System.IO.Stream destinationStream, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response DownloadMediaTo(string mediaContentId, class System.IO.Stream destinationStream, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.NotificationMessagesClient.DownloadMediaTo(System.String,System.IO.Stream,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function DownloadMediaTo (mediaContentId As String, destinationStream As Stream, Optional cancellationToken As CancellationToken = Nothing) As Response" />
<MemberSignature Language="F#" Value="abstract member DownloadMediaTo : string * System.IO.Stream * System.Threading.CancellationToken -> Azure.Response
override this.DownloadMediaTo : string * System.IO.Stream * System.Threading.CancellationToken -> Azure.Response" Usage="notificationMessagesClient.DownloadMediaTo (mediaContentId, destinationStream, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="mediaContentId" Type="System.String" />
<Parameter Name="destinationStream" Type="System.IO.Stream" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="mediaContentId">The Media Identifier contained in the User to Business message event.</param>
<param name="destinationStream"> A <see cref="T:System.IO.Stream" /> to write the downloaded content to. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
The <see cref="M:Azure.Communication.Messages.NotificationMessagesClient.DownloadMediaTo(System.String,System.IO.Stream,System.Threading.CancellationToken)" /> operation downloads the
specified content, and writes the content to <paramref name="destinationStream" />.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException">The server returned an error. See <see cref="P:System.Exception.Message" /> for details returned from the server.</exception>
</Docs>
</Member>
<Member MemberName="DownloadMediaTo">
<MemberSignature Language="C#" Value="public virtual Azure.Response DownloadMediaTo (string mediaContentId, string destinationPath, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response DownloadMediaTo(string mediaContentId, string destinationPath, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.NotificationMessagesClient.DownloadMediaTo(System.String,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function DownloadMediaTo (mediaContentId As String, destinationPath As String, Optional cancellationToken As CancellationToken = Nothing) As Response" />
<MemberSignature Language="F#" Value="abstract member DownloadMediaTo : string * string * System.Threading.CancellationToken -> Azure.Response
override this.DownloadMediaTo : string * string * System.Threading.CancellationToken -> Azure.Response" Usage="notificationMessagesClient.DownloadMediaTo (mediaContentId, destinationPath, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="mediaContentId" Type="System.String" />
<Parameter Name="destinationPath" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="mediaContentId">The Media Identifier contained in the User to Business message event.</param>
<param name="destinationPath"> A file path to write the downloaded content to. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
The <see cref="M:Azure.Communication.Messages.NotificationMessagesClient.DownloadMediaTo(System.String,System.String,System.Threading.CancellationToken)" /> operation downloads the
specified content, and writes the content to <paramref name="destinationPath" />.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException">The server returned an error. See <see cref="P:System.Exception.Message" /> for details returned from the server.</exception>
</Docs>
</Member>
<Member MemberName="DownloadMediaToAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> DownloadMediaToAsync (string mediaContentId, System.IO.Stream destinationStream, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> DownloadMediaToAsync(string mediaContentId, class System.IO.Stream destinationStream, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.NotificationMessagesClient.DownloadMediaToAsync(System.String,System.IO.Stream,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function DownloadMediaToAsync (mediaContentId As String, destinationStream As Stream, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member DownloadMediaToAsync : string * System.IO.Stream * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DownloadMediaToAsync : string * System.IO.Stream * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>" Usage="notificationMessagesClient.DownloadMediaToAsync (mediaContentId, destinationStream, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="mediaContentId" Type="System.String" />
<Parameter Name="destinationStream" Type="System.IO.Stream" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="mediaContentId">The Media Identifier contained in the User to Business message event.</param>
<param name="destinationStream"> A <see cref="T:System.IO.Stream" /> to write the downloaded content to. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
The <see cref="M:Azure.Communication.Messages.NotificationMessagesClient.DownloadMediaToAsync(System.String,System.IO.Stream,System.Threading.CancellationToken)" /> operation downloads the
specified content asynchronously, and writes the content to <paramref name="destinationStream" />.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException">The server returned an error. See <see cref="P:System.Exception.Message" /> for details returned from the server.</exception>
</Docs>
</Member>
<Member MemberName="DownloadMediaToAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> DownloadMediaToAsync (string mediaContentId, string destinationPath, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> DownloadMediaToAsync(string mediaContentId, string destinationPath, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.NotificationMessagesClient.DownloadMediaToAsync(System.String,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function DownloadMediaToAsync (mediaContentId As String, destinationPath As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member DownloadMediaToAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DownloadMediaToAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>" Usage="notificationMessagesClient.DownloadMediaToAsync (mediaContentId, destinationPath, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="mediaContentId" Type="System.String" />
<Parameter Name="destinationPath" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="mediaContentId">The Media Identifier contained in the User to Business message event.</param>
<param name="destinationPath"> A file path to write the downloaded content to. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
The <see cref="M:Azure.Communication.Messages.NotificationMessagesClient.DownloadMediaTo(System.String,System.String,System.Threading.CancellationToken)" /> operation downloads the
specified content, and writes the content to <paramref name="destinationPath" />.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException">The server returned an error. See <see cref="P:System.Exception.Message" /> for details returned from the server.</exception>
</Docs>
</Member>
<Member MemberName="Pipeline">
<MemberSignature Language="C#" Value="public virtual Azure.Core.Pipeline.HttpPipeline Pipeline { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Azure.Core.Pipeline.HttpPipeline Pipeline" />
<MemberSignature Language="DocId" Value="P:Azure.Communication.Messages.NotificationMessagesClient.Pipeline" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property Pipeline As HttpPipeline" />
<MemberSignature Language="F#" Value="member this.Pipeline : Azure.Core.Pipeline.HttpPipeline" Usage="Azure.Communication.Messages.NotificationMessagesClient.Pipeline" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Core.Pipeline.HttpPipeline</ReturnType>
</ReturnValue>
<Docs>
<summary> The HTTP pipeline for sending and receiving REST requests and responses. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Send">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Communication.Messages.SendMessageResult> Send (Azure.Communication.Messages.NotificationContent notificationContent, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Communication.Messages.SendMessageResult> Send(class Azure.Communication.Messages.NotificationContent notificationContent, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.NotificationMessagesClient.Send(Azure.Communication.Messages.NotificationContent,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function Send (notificationContent As NotificationContent, Optional cancellationToken As CancellationToken = Nothing) As Response(Of SendMessageResult)" />
<MemberSignature Language="F#" Value="abstract member Send : Azure.Communication.Messages.NotificationContent * System.Threading.CancellationToken -> Azure.Response<Azure.Communication.Messages.SendMessageResult>
override this.Send : Azure.Communication.Messages.NotificationContent * System.Threading.CancellationToken -> Azure.Response<Azure.Communication.Messages.SendMessageResult>" Usage="notificationMessagesClient.Send (notificationContent, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.Communication.Messages.SendMessageResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="notificationContent" Type="Azure.Communication.Messages.NotificationContent" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="notificationContent"> Details of the message to send. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Sends a notification message from Business to User. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="notificationContent" /> is null. </exception>
<example>
This sample shows how to call Send.
<code><![CDATA[
NotificationMessagesClient client = new NotificationMessagesClient(null);
NotificationContent notificationContent = new TextNotificationContent(Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a"), new string[] { "<to>" }, "<content>");
Response<SendMessageResult> response = client.Send(notificationContent);
]]></code>
This sample shows how to call Send with all parameters.
<code><![CDATA[
NotificationMessagesClient client = new NotificationMessagesClient(null);
NotificationContent notificationContent = new TextNotificationContent(Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a"), new string[] { "<to>" }, "<content>");
Response<SendMessageResult> response = client.Send(notificationContent);
]]></code></example>
</Docs>
</Member>
<Member MemberName="Send">
<MemberSignature Language="C#" Value="public virtual Azure.Response Send (Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response Send(class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.NotificationMessagesClient.Send(Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function Send (content As RequestContent, Optional context As RequestContext = Nothing) As Response" />
<MemberSignature Language="F#" Value="abstract member Send : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.Send : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="notificationMessagesClient.Send (content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="content" Type="Azure.Core.RequestContent" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="context" Type="Azure.RequestContext" Index="1" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="content"> The content to send as the body of the request. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Sends a notification message from Business to User.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Communication.Messages.NotificationMessagesClient.Send(Azure.Communication.Messages.NotificationContent,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="content" /> is null. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call Send and parse the result.
<code><![CDATA[
NotificationMessagesClient client = new NotificationMessagesClient(null);
using RequestContent content = RequestContent.Create(new
{
content = "<content>",
channelRegistrationId = "73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a",
to = new object[]
{
"<to>"
},
kind = "text",
});
Response response = client.Send(content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("receipts")[0].GetProperty("messageId").ToString());
Console.WriteLine(result.GetProperty("receipts")[0].GetProperty("to").ToString());
]]></code>
This sample shows how to call Send with all request content and parse the result.
<code><![CDATA[
NotificationMessagesClient client = new NotificationMessagesClient(null);
using RequestContent content = RequestContent.Create(new
{
content = "<content>",
channelRegistrationId = "73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a",
to = new object[]
{
"<to>"
},
kind = "text",
});
Response response = client.Send(content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("receipts")[0].GetProperty("messageId").ToString());
Console.WriteLine(result.GetProperty("receipts")[0].GetProperty("to").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="SendAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Communication.Messages.SendMessageResult>> SendAsync (Azure.Communication.Messages.NotificationContent notificationContent, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Communication.Messages.SendMessageResult>> SendAsync(class Azure.Communication.Messages.NotificationContent notificationContent, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.NotificationMessagesClient.SendAsync(Azure.Communication.Messages.NotificationContent,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function SendAsync (notificationContent As NotificationContent, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SendMessageResult))" />
<MemberSignature Language="F#" Value="abstract member SendAsync : Azure.Communication.Messages.NotificationContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Communication.Messages.SendMessageResult>>
override this.SendAsync : Azure.Communication.Messages.NotificationContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Communication.Messages.SendMessageResult>>" Usage="notificationMessagesClient.SendAsync (notificationContent, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Communication.Messages.SendMessageResult>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="notificationContent" Type="Azure.Communication.Messages.NotificationContent" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="notificationContent"> Details of the message to send. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Sends a notification message from Business to User. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="notificationContent" /> is null. </exception>
<example>
This sample shows how to call SendAsync.
<code><![CDATA[
NotificationMessagesClient client = new NotificationMessagesClient(null);
NotificationContent notificationContent = new TextNotificationContent(Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a"), new string[] { "<to>" }, "<content>");
Response<SendMessageResult> response = await client.SendAsync(notificationContent);
]]></code>
This sample shows how to call SendAsync with all parameters.
<code><![CDATA[
NotificationMessagesClient client = new NotificationMessagesClient(null);
NotificationContent notificationContent = new TextNotificationContent(Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a"), new string[] { "<to>" }, "<content>");
Response<SendMessageResult> response = await client.SendAsync(notificationContent);
]]></code></example>
</Docs>
</Member>
<Member MemberName="SendAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> SendAsync (Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> SendAsync(class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.NotificationMessagesClient.SendAsync(Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function SendAsync (content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member SendAsync : Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.SendAsync : Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="notificationMessagesClient.SendAsync (content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="content" Type="Azure.Core.RequestContent" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="context" Type="Azure.RequestContext" Index="1" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="content"> The content to send as the body of the request. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Sends a notification message from Business to User.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Communication.Messages.NotificationMessagesClient.SendAsync(Azure.Communication.Messages.NotificationContent,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="content" /> is null. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call SendAsync and parse the result.
<code><![CDATA[
NotificationMessagesClient client = new NotificationMessagesClient(null);
using RequestContent content = RequestContent.Create(new
{
content = "<content>",
channelRegistrationId = "73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a",
to = new object[]
{
"<to>"
},
kind = "text",
});
Response response = await client.SendAsync(content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("receipts")[0].GetProperty("messageId").ToString());
Console.WriteLine(result.GetProperty("receipts")[0].GetProperty("to").ToString());
]]></code>
This sample shows how to call SendAsync with all request content and parse the result.
<code><![CDATA[
NotificationMessagesClient client = new NotificationMessagesClient(null);
using RequestContent content = RequestContent.Create(new
{
content = "<content>",
channelRegistrationId = "73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a",
to = new object[]
{
"<to>"
},
kind = "text",
});
Response response = await client.SendAsync(content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("receipts")[0].GetProperty("messageId").ToString());
Console.WriteLine(result.GetProperty("receipts")[0].GetProperty("to").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="SendMessage">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Communication.Messages.SendMessageResult> SendMessage (Azure.Communication.Messages.SendMessageOptions options, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Communication.Messages.SendMessageResult> SendMessage(class Azure.Communication.Messages.SendMessageOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.NotificationMessagesClient.SendMessage(Azure.Communication.Messages.SendMessageOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function SendMessage (options As SendMessageOptions, Optional cancellationToken As CancellationToken = Nothing) As Response(Of SendMessageResult)" />
<MemberSignature Language="F#" Value="abstract member SendMessage : Azure.Communication.Messages.SendMessageOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Communication.Messages.SendMessageResult>
override this.SendMessage : Azure.Communication.Messages.SendMessageOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Communication.Messages.SendMessageResult>" Usage="notificationMessagesClient.SendMessage (options, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.Communication.Messages.SendMessageResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="options" Type="Azure.Communication.Messages.SendMessageOptions" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="options"> Options for the message. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Sends a notification message. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException">The server returned an error. See <see cref="P:System.Exception.Message" /> for details returned from the server.</exception>
</Docs>
</Member>
<Member MemberName="SendMessageAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Communication.Messages.SendMessageResult>> SendMessageAsync (Azure.Communication.Messages.SendMessageOptions options, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Communication.Messages.SendMessageResult>> SendMessageAsync(class Azure.Communication.Messages.SendMessageOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.NotificationMessagesClient.SendMessageAsync(Azure.Communication.Messages.SendMessageOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function SendMessageAsync (options As SendMessageOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SendMessageResult))" />
<MemberSignature Language="F#" Value="abstract member SendMessageAsync : Azure.Communication.Messages.SendMessageOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Communication.Messages.SendMessageResult>>
override this.SendMessageAsync : Azure.Communication.Messages.SendMessageOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Communication.Messages.SendMessageResult>>" Usage="notificationMessagesClient.SendMessageAsync (options, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Communication.Messages.SendMessageResult>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="options" Type="Azure.Communication.Messages.SendMessageOptions" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="options"> Options for the message. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Sends a notification message asynchronously. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException">The server returned an error. See <see cref="P:System.Exception.Message" /> for details returned from the server.</exception>
</Docs>
</Member>
</Members>
</Type>