-
Notifications
You must be signed in to change notification settings - Fork 264
/
MessageTemplateClient.xml
478 lines (470 loc) · 38 KB
/
MessageTemplateClient.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
<Type Name="MessageTemplateClient" FullName="Azure.Communication.Messages.MessageTemplateClient">
<TypeSignature Language="C#" Value="public class MessageTemplateClient" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MessageTemplateClient extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.Communication.Messages.MessageTemplateClient" />
<TypeSignature Language="VB.NET" Value="Public Class MessageTemplateClient" />
<TypeSignature Language="F#" Value="type MessageTemplateClient = class" />
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary> The MessageTemplate service client. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected MessageTemplateClient ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.MessageTemplateClient.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of <see cref="T:Azure.Communication.Messages.MessageTemplateClient" /> for mocking.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public MessageTemplateClient (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.MessageTemplateClient.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (connectionString As String)" />
<MemberSignature Language="F#" Value="new Azure.Communication.Messages.MessageTemplateClient : string -> Azure.Communication.Messages.MessageTemplateClient" Usage="new Azure.Communication.Messages.MessageTemplateClient connectionString" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.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.MessageTemplateClient" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public MessageTemplateClient (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.MessageTemplateClient.#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.MessageTemplateClient : string * Azure.Communication.Messages.CommunicationMessagesClientOptions -> Azure.Communication.Messages.MessageTemplateClient" Usage="new Azure.Communication.Messages.MessageTemplateClient (connectionString, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.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.MessageTemplateClient" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public MessageTemplateClient (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.MessageTemplateClient.#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.MessageTemplateClient : Uri * Azure.AzureKeyCredential -> Azure.Communication.Messages.MessageTemplateClient" Usage="new Azure.Communication.Messages.MessageTemplateClient (endpoint, credential)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.1.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 MessageTemplateClient. </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 MessageTemplateClient (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.MessageTemplateClient.#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.MessageTemplateClient : Uri * Azure.Core.TokenCredential -> Azure.Communication.Messages.MessageTemplateClient" Usage="new Azure.Communication.Messages.MessageTemplateClient (endpoint, credential)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.1.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 MessageTemplateClient. </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 MessageTemplateClient (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.MessageTemplateClient.#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.MessageTemplateClient : Uri * Azure.Core.TokenCredential * Azure.Communication.Messages.CommunicationMessagesClientOptions -> Azure.Communication.Messages.MessageTemplateClient" Usage="new Azure.Communication.Messages.MessageTemplateClient (endpoint, credential, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.1.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 MessageTemplateClient. </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 MessageTemplateClient (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.MessageTemplateClient.#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.MessageTemplateClient : Uri * Azure.AzureKeyCredential * Azure.Communication.Messages.CommunicationMessagesClientOptions -> Azure.Communication.Messages.MessageTemplateClient" Usage="new Azure.Communication.Messages.MessageTemplateClient (endpoint, credential, options)" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="C#" Value="public MessageTemplateClient (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.MessageTemplateClient : Uri * Azure.AzureKeyCredential * Azure.Communication.Messages.CommunicationMessagesClientOptions -> Azure.Communication.Messages.MessageTemplateClient" Usage="new Azure.Communication.Messages.MessageTemplateClient (endpoint, keyCredential, options)" FrameworkAlternate="azure-dotnet-preview" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.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.MessageTemplateClient" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetTemplates">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<Azure.Communication.Messages.MessageTemplateItem> GetTemplates (string channelRegistrationId, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class Azure.Communication.Messages.MessageTemplateItem> GetTemplates(string channelRegistrationId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.MessageTemplateClient.GetTemplates(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetTemplates (channelRegistrationId As String, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of MessageTemplateItem)" />
<MemberSignature Language="F#" Value="abstract member GetTemplates : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Communication.Messages.MessageTemplateItem>
override this.GetTemplates : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Communication.Messages.MessageTemplateItem>" Usage="messageTemplateClient.GetTemplates (channelRegistrationId, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<Azure.Communication.Messages.MessageTemplateItem></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="channelRegistrationId" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="channelRegistrationId"> The registration ID of the channel. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> List all templates for given ACS channel. </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="GetTemplates">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetTemplates (Guid channelId, int? maxpagesize, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetTemplates(valuetype System.Guid channelId, valuetype System.Nullable`1<int32> maxpagesize, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.MessageTemplateClient.GetTemplates(System.Guid,System.Nullable{System.Int32},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetTemplates (channelId As Guid, maxpagesize As Nullable(Of Integer), context As RequestContext) As Pageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetTemplates : Guid * Nullable<int> * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetTemplates : Guid * Nullable<int> * Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="messageTemplateClient.GetTemplates (channelId, maxpagesize, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="channelId" Type="System.Guid" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="context" Type="Azure.RequestContext" Index="2" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="channelId"> The registration ID of the channel. </param>
<param name="maxpagesize"> Number of objects to return per page. </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] List all templates for given Azure Communication Services channel
<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.MessageTemplateClient.GetTemplates(System.Guid,System.Nullable{System.Int32},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetTemplates and parse the result.
<code><![CDATA[
MessageTemplateClient client = new MessageTemplateClient((string)null);
foreach (BinaryData item in client.GetTemplates(Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a"), null, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("language").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("kind").ToString());
}
]]></code>
This sample shows how to call GetTemplates with all parameters and parse the result.
<code><![CDATA[
MessageTemplateClient client = new MessageTemplateClient((string)null);
foreach (BinaryData item in client.GetTemplates(Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a"), 1234, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("language").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("kind").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetTemplates">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<Azure.Communication.Messages.MessageTemplateItem> GetTemplates (Guid channelId, int? maxpagesize = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class Azure.Communication.Messages.MessageTemplateItem> GetTemplates(valuetype System.Guid channelId, valuetype System.Nullable`1<int32> maxpagesize, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.MessageTemplateClient.GetTemplates(System.Guid,System.Nullable{System.Int32},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetTemplates (channelId As Guid, Optional maxpagesize As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of MessageTemplateItem)" />
<MemberSignature Language="F#" Value="abstract member GetTemplates : Guid * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.Communication.Messages.MessageTemplateItem>
override this.GetTemplates : Guid * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.Communication.Messages.MessageTemplateItem>" Usage="messageTemplateClient.GetTemplates (channelId, maxpagesize, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<Azure.Communication.Messages.MessageTemplateItem></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="channelId" Type="System.Guid" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="channelId"> The registration ID of the channel. </param>
<param name="maxpagesize"> Number of objects to return per page. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> List all templates for given Azure Communication Services channel. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
This sample shows how to call GetTemplates.
<code><![CDATA[
MessageTemplateClient client = new MessageTemplateClient((string)null);
foreach (MessageTemplateItem item in client.GetTemplates(Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a")))
{
}
]]></code>
This sample shows how to call GetTemplates with all parameters.
<code><![CDATA[
MessageTemplateClient client = new MessageTemplateClient((string)null);
foreach (MessageTemplateItem item in client.GetTemplates(Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a"), maxpagesize: 1234))
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetTemplatesAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<Azure.Communication.Messages.MessageTemplateItem> GetTemplatesAsync (string channelRegistrationId, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class Azure.Communication.Messages.MessageTemplateItem> GetTemplatesAsync(string channelRegistrationId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.MessageTemplateClient.GetTemplatesAsync(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetTemplatesAsync (channelRegistrationId As String, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of MessageTemplateItem)" />
<MemberSignature Language="F#" Value="abstract member GetTemplatesAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Communication.Messages.MessageTemplateItem>
override this.GetTemplatesAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Communication.Messages.MessageTemplateItem>" Usage="messageTemplateClient.GetTemplatesAsync (channelRegistrationId, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<Azure.Communication.Messages.MessageTemplateItem></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="channelRegistrationId" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="channelRegistrationId"> The registration ID of the channel. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> List all templates for given ACS channel 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="GetTemplatesAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetTemplatesAsync (Guid channelId, int? maxpagesize, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetTemplatesAsync(valuetype System.Guid channelId, valuetype System.Nullable`1<int32> maxpagesize, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.MessageTemplateClient.GetTemplatesAsync(System.Guid,System.Nullable{System.Int32},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetTemplatesAsync (channelId As Guid, maxpagesize As Nullable(Of Integer), context As RequestContext) As AsyncPageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetTemplatesAsync : Guid * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetTemplatesAsync : Guid * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="messageTemplateClient.GetTemplatesAsync (channelId, maxpagesize, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="channelId" Type="System.Guid" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="context" Type="Azure.RequestContext" Index="2" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="channelId"> The registration ID of the channel. </param>
<param name="maxpagesize"> Number of objects to return per page. </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] List all templates for given Azure Communication Services channel
<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.MessageTemplateClient.GetTemplatesAsync(System.Guid,System.Nullable{System.Int32},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetTemplatesAsync and parse the result.
<code><![CDATA[
MessageTemplateClient client = new MessageTemplateClient((string)null);
await foreach (BinaryData item in client.GetTemplatesAsync(Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a"), null, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("language").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("kind").ToString());
}
]]></code>
This sample shows how to call GetTemplatesAsync with all parameters and parse the result.
<code><![CDATA[
MessageTemplateClient client = new MessageTemplateClient((string)null);
await foreach (BinaryData item in client.GetTemplatesAsync(Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a"), 1234, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("language").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("kind").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetTemplatesAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<Azure.Communication.Messages.MessageTemplateItem> GetTemplatesAsync (Guid channelId, int? maxpagesize = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class Azure.Communication.Messages.MessageTemplateItem> GetTemplatesAsync(valuetype System.Guid channelId, valuetype System.Nullable`1<int32> maxpagesize, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.MessageTemplateClient.GetTemplatesAsync(System.Guid,System.Nullable{System.Int32},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetTemplatesAsync (channelId As Guid, Optional maxpagesize As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of MessageTemplateItem)" />
<MemberSignature Language="F#" Value="abstract member GetTemplatesAsync : Guid * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Communication.Messages.MessageTemplateItem>
override this.GetTemplatesAsync : Guid * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Communication.Messages.MessageTemplateItem>" Usage="messageTemplateClient.GetTemplatesAsync (channelId, maxpagesize, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<Azure.Communication.Messages.MessageTemplateItem></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="channelId" Type="System.Guid" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="channelId"> The registration ID of the channel. </param>
<param name="maxpagesize"> Number of objects to return per page. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> List all templates for given Azure Communication Services channel. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<example>
This sample shows how to call GetTemplatesAsync.
<code><![CDATA[
MessageTemplateClient client = new MessageTemplateClient((string)null);
await foreach (MessageTemplateItem item in client.GetTemplatesAsync(Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a")))
{
}
]]></code>
This sample shows how to call GetTemplatesAsync with all parameters.
<code><![CDATA[
MessageTemplateClient client = new MessageTemplateClient((string)null);
await foreach (MessageTemplateItem item in client.GetTemplatesAsync(Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a"), maxpagesize: 1234))
{
}
]]></code></example>
</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.MessageTemplateClient.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.MessageTemplateClient.Pipeline" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.Messages</AssemblyName>
<AssemblyVersion>1.1.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>
</Members>
</Type>