xml/Azure.Communication.Messages/ConversationAdministrationClient.xml

<Type Name="ConversationAdministrationClient" FullName="Azure.Communication.Messages.ConversationAdministrationClient"> <TypeSignature Language="C#" Value="public class ConversationAdministrationClient" /> <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ConversationAdministrationClient extends System.Object" /> <TypeSignature Language="DocId" Value="T:Azure.Communication.Messages.ConversationAdministrationClient" /> <TypeSignature Language="VB.NET" Value="Public Class ConversationAdministrationClient" /> <TypeSignature Language="F#" Value="type ConversationAdministrationClient = class" /> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <Base> <BaseTypeName>System.Object</BaseTypeName> </Base> <Interfaces /> <Docs> <summary> The Azure Communication Services Conversation Adminstration client. </summary> <remarks>To be added.</remarks> </Docs> <Members> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="protected ConversationAdministrationClient ();" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.#ctor" /> <MemberSignature Language="VB.NET" Value="Protected Sub New ()" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <Parameters /> <Docs> <summary>Initializes a new instance of <see cref="T:Azure.Communication.Messages.ConversationAdministrationClient" /> for mocking.</summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public ConversationAdministrationClient (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.ConversationAdministrationClient.#ctor(System.String)" /> <MemberSignature Language="VB.NET" Value="Public Sub New (connectionString As String)" /> <MemberSignature Language="F#" Value="new Azure.Communication.Messages.ConversationAdministrationClient : string -> Azure.Communication.Messages.ConversationAdministrationClient" Usage="new Azure.Communication.Messages.ConversationAdministrationClient connectionString" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.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.ConversationAdministrationClient" />. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public ConversationAdministrationClient (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.ConversationAdministrationClient.#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.ConversationAdministrationClient : string * Azure.Communication.Messages.CommunicationMessagesClientOptions -> Azure.Communication.Messages.ConversationAdministrationClient" Usage="new Azure.Communication.Messages.ConversationAdministrationClient (connectionString, options)" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.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.ConversationAdministrationClient" />.</summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public ConversationAdministrationClient (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.ConversationAdministrationClient.#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.ConversationAdministrationClient : Uri * Azure.AzureKeyCredential -> Azure.Communication.Messages.ConversationAdministrationClient" Usage="new Azure.Communication.Messages.ConversationAdministrationClient (endpoint, credential)" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <Parameters> <Parameter Name="endpoint" Type="System.Uri" /> <Parameter Name="credential" Type="Azure.AzureKeyCredential" /> </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 ConversationAdministrationClient. </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 ConversationAdministrationClient (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.ConversationAdministrationClient.#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.ConversationAdministrationClient : Uri * Azure.Core.TokenCredential -> Azure.Communication.Messages.ConversationAdministrationClient" Usage="new Azure.Communication.Messages.ConversationAdministrationClient (endpoint, credential)" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <Parameters> <Parameter Name="endpoint" Type="System.Uri" /> <Parameter Name="credential" Type="Azure.Core.TokenCredential" /> </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 ConversationManagementClient. </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 ConversationAdministrationClient (Uri endpoint, Azure.AzureKeyCredential credential, Azure.Communication.Messages.CommunicationMessagesClientOptions options = default);" /> <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" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.#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)" /> <MemberSignature Language="F#" Value="new Azure.Communication.Messages.ConversationAdministrationClient : Uri * Azure.AzureKeyCredential * Azure.Communication.Messages.CommunicationMessagesClientOptions -> Azure.Communication.Messages.ConversationAdministrationClient" Usage="new Azure.Communication.Messages.ConversationAdministrationClient (endpoint, credential, options)" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <Parameters> <Parameter Name="endpoint" Type="System.Uri" /> <Parameter Name="credential" Type="Azure.AzureKeyCredential" /> <Parameter Name="options" Type="Azure.Communication.Messages.CommunicationMessagesClientOptions" /> </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="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.ConversationAdministrationClient" />.</summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public ConversationAdministrationClient (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.ConversationAdministrationClient.#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.ConversationAdministrationClient : Uri * Azure.Core.TokenCredential * Azure.Communication.Messages.CommunicationMessagesClientOptions -> Azure.Communication.Messages.ConversationAdministrationClient" Usage="new Azure.Communication.Messages.ConversationAdministrationClient (endpoint, credential, options)" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <Parameters> <Parameter Name="endpoint" Type="System.Uri" /> <Parameter Name="credential" Type="Azure.Core.TokenCredential" /> <Parameter Name="options" Type="Azure.Communication.Messages.CommunicationMessagesClientOptions" /> </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 ConversationManagementClient. </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="AddParticipants"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Communication.Messages.AddParticipantsResult> AddParticipants (string conversationId, Azure.Communication.Messages.AddParticipantsOptions options, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Communication.Messages.AddParticipantsResult> AddParticipants(string conversationId, class Azure.Communication.Messages.AddParticipantsOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.AddParticipants(System.String,Azure.Communication.Messages.AddParticipantsOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddParticipants (conversationId As String, options As AddParticipantsOptions, Optional cancellationToken As CancellationToken = Nothing) As Response(Of AddParticipantsResult)" /> <MemberSignature Language="F#" Value="abstract member AddParticipants : string * Azure.Communication.Messages.AddParticipantsOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Communication.Messages.AddParticipantsResult>
override this.AddParticipants : string * Azure.Communication.Messages.AddParticipantsOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Communication.Messages.AddParticipantsResult>" Usage="conversationAdministrationClient.AddParticipants (conversationId, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.Communication.Messages.AddParticipantsResult></ReturnType> </ReturnValue> <Parameters> <Parameter Name="conversationId" Type="System.String" /> <Parameter Name="options" Type="Azure.Communication.Messages.AddParticipantsOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="conversationId"> The conversation ID. </param> <param name="options"> Details of the payload for adding participants to a conversation. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Adds participants to a specific conversation. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="conversationId" /> or <paramref name="options" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="conversationId" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call AddParticipants. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); AddParticipantsOptions options = new AddParticipantsOptions(new ConversationParticipant[] { new ExternalConversationParticipant(new ConversationContact[] { new WhatsAppContact("12345678901") }) { DisplayName = "Customer", }, new InternalConversationParticipant(new CommunicationContact("8:acs:uuid1")) { DisplayName = "Support", } }); Response<AddParticipantsResult> response = client.AddParticipants("19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2", options); ]]></code></example> </Docs> </Member> <Member MemberName="AddParticipants"> <MemberSignature Language="C#" Value="public virtual Azure.Response AddParticipants (string conversationId, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response AddParticipants(string conversationId, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.AddParticipants(System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddParticipants (conversationId As String, content As RequestContent, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member AddParticipants : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.AddParticipants : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="conversationAdministrationClient.AddParticipants (conversationId, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="conversationId" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="conversationId"> The conversation ID. </param> <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] Adds participants to a specific conversation. <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.ConversationAdministrationClient.AddParticipants(System.String,Azure.Communication.Messages.AddParticipantsOptions,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="conversationId" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="conversationId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call AddParticipants and parse the result. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); using RequestContent content = RequestContent.Create(new { participants = new object[] { new { displayName = "Customer", kind = "external", contacts = new object[] { new { id = "12345678901", kind = "whatsApp", } }, }, new { displayName = "Support", kind = "internal", contact = new { id = "8:acs:uuid1", kind = "communication", }, } }, }); Response response = client.AddParticipants("19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2", content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("invalidParticipants")[0].GetProperty("id").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="AddParticipantsAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Communication.Messages.AddParticipantsResult>> AddParticipantsAsync (string conversationId, Azure.Communication.Messages.AddParticipantsOptions 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.AddParticipantsResult>> AddParticipantsAsync(string conversationId, class Azure.Communication.Messages.AddParticipantsOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.AddParticipantsAsync(System.String,Azure.Communication.Messages.AddParticipantsOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddParticipantsAsync (conversationId As String, options As AddParticipantsOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AddParticipantsResult))" /> <MemberSignature Language="F#" Value="abstract member AddParticipantsAsync : string * Azure.Communication.Messages.AddParticipantsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Communication.Messages.AddParticipantsResult>>
override this.AddParticipantsAsync : string * Azure.Communication.Messages.AddParticipantsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Communication.Messages.AddParticipantsResult>>" Usage="conversationAdministrationClient.AddParticipantsAsync (conversationId, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Communication.Messages.AddParticipantsResult>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="conversationId" Type="System.String" /> <Parameter Name="options" Type="Azure.Communication.Messages.AddParticipantsOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="conversationId"> The conversation ID. </param> <param name="options"> Details of the payload for adding participants to a conversation. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Adds participants to a specific conversation. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="conversationId" /> or <paramref name="options" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="conversationId" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call AddParticipantsAsync. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); AddParticipantsOptions options = new AddParticipantsOptions(new ConversationParticipant[] { new ExternalConversationParticipant(new ConversationContact[] { new WhatsAppContact("12345678901") }) { DisplayName = "Customer", }, new InternalConversationParticipant(new CommunicationContact("8:acs:uuid1")) { DisplayName = "Support", } }); Response<AddParticipantsResult> response = await client.AddParticipantsAsync("19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2", options); ]]></code></example> </Docs> </Member> <Member MemberName="AddParticipantsAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> AddParticipantsAsync (string conversationId, 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> AddParticipantsAsync(string conversationId, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.AddParticipantsAsync(System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddParticipantsAsync (conversationId As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member AddParticipantsAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.AddParticipantsAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="conversationAdministrationClient.AddParticipantsAsync (conversationId, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="conversationId" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="conversationId"> The conversation ID. </param> <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] Adds participants to a specific conversation. <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.ConversationAdministrationClient.AddParticipantsAsync(System.String,Azure.Communication.Messages.AddParticipantsOptions,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="conversationId" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="conversationId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call AddParticipantsAsync and parse the result. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); using RequestContent content = RequestContent.Create(new { participants = new object[] { new { displayName = "Customer", kind = "external", contacts = new object[] { new { id = "12345678901", kind = "whatsApp", } }, }, new { displayName = "Support", kind = "internal", contact = new { id = "8:acs:uuid1", kind = "communication", }, } }, }); Response response = await client.AddParticipantsAsync("19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2", content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("invalidParticipants")[0].GetProperty("id").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="AnalyzeConversation"> <MemberSignature Language="C#" Value="public virtual Azure.Response AnalyzeConversation (string conversationId, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response AnalyzeConversation(string conversationId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.AnalyzeConversation(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeConversation (conversationId As String, context As RequestContext) As Response" /> <MemberSignature Language="F#" Value="abstract member AnalyzeConversation : string * Azure.RequestContext -> Azure.Response
override this.AnalyzeConversation : string * Azure.RequestContext -> Azure.Response" Usage="conversationAdministrationClient.AnalyzeConversation (conversationId, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="conversationId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="conversationId"> The conversation ID. </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] Get AI Analysis of a conversation. <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.ConversationAdministrationClient.AnalyzeConversation(System.String,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="conversationId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="conversationId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call AnalyzeConversation and parse the result. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); Response response = client.AnalyzeConversation("19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2", null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("summary").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="AnalyzeConversation"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Communication.Messages.GetConversationThreadAnalysisResult> AnalyzeConversation (string conversationId, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Communication.Messages.GetConversationThreadAnalysisResult> AnalyzeConversation(string conversationId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.AnalyzeConversation(System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeConversation (conversationId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of GetConversationThreadAnalysisResult)" /> <MemberSignature Language="F#" Value="abstract member AnalyzeConversation : string * System.Threading.CancellationToken -> Azure.Response<Azure.Communication.Messages.GetConversationThreadAnalysisResult>
override this.AnalyzeConversation : string * System.Threading.CancellationToken -> Azure.Response<Azure.Communication.Messages.GetConversationThreadAnalysisResult>" Usage="conversationAdministrationClient.AnalyzeConversation (conversationId, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.Communication.Messages.GetConversationThreadAnalysisResult></ReturnType> </ReturnValue> <Parameters> <Parameter Name="conversationId" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="conversationId"> The conversation ID. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Get AI Analysis of a conversation. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="conversationId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="conversationId" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call AnalyzeConversation. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); Response<GetConversationThreadAnalysisResult> response = client.AnalyzeConversation("19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2"); ]]></code></example> </Docs> </Member> <Member MemberName="AnalyzeConversationAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> AnalyzeConversationAsync (string conversationId, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> AnalyzeConversationAsync(string conversationId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.AnalyzeConversationAsync(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeConversationAsync (conversationId As String, context As RequestContext) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member AnalyzeConversationAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.AnalyzeConversationAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="conversationAdministrationClient.AnalyzeConversationAsync (conversationId, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="conversationId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="conversationId"> The conversation ID. </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] Get AI Analysis of a conversation. <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.ConversationAdministrationClient.AnalyzeConversationAsync(System.String,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="conversationId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="conversationId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call AnalyzeConversationAsync and parse the result. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); Response response = await client.AnalyzeConversationAsync("19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2", null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("summary").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="AnalyzeConversationAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Communication.Messages.GetConversationThreadAnalysisResult>> AnalyzeConversationAsync (string conversationId, 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.GetConversationThreadAnalysisResult>> AnalyzeConversationAsync(string conversationId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.AnalyzeConversationAsync(System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeConversationAsync (conversationId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of GetConversationThreadAnalysisResult))" /> <MemberSignature Language="F#" Value="abstract member AnalyzeConversationAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Communication.Messages.GetConversationThreadAnalysisResult>>
override this.AnalyzeConversationAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Communication.Messages.GetConversationThreadAnalysisResult>>" Usage="conversationAdministrationClient.AnalyzeConversationAsync (conversationId, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Communication.Messages.GetConversationThreadAnalysisResult>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="conversationId" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="conversationId"> The conversation ID. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Get AI Analysis of a conversation. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="conversationId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="conversationId" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call AnalyzeConversationAsync. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); Response<GetConversationThreadAnalysisResult> response = await client.AnalyzeConversationAsync("19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2"); ]]></code></example> </Docs> </Member> <Member MemberName="CreateConversation"> <MemberSignature Language="C#" Value="public virtual Azure.Response CreateConversation (Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response CreateConversation(class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.CreateConversation(Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function CreateConversation (content As RequestContent, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member CreateConversation : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.CreateConversation : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="conversationAdministrationClient.CreateConversation (content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </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] Creates a new conversation. This is only for create operation. <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.ConversationAdministrationClient.CreateConversation(Azure.Communication.Messages.CommunicationConversation,Azure.Communication.Messages.ConversationMessage,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 CreateConversation and parse the result. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); using RequestContent content = RequestContent.Create(new { conversation = new object(), }); Response response = client.CreateConversation(content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("id").ToString()); ]]></code> This sample shows how to call CreateConversation with all request content and parse the result. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); using RequestContent content = RequestContent.Create(new { conversation = new { topic = "<topic>", deliveryChannelIds = new object[] { "<deliveryChannelIds>" }, outboundDeliveryStrategy = "internalOnly", participants = new object[] { new { kind = "internal", contact = new { kind = "communication", id = "<id>", }, displayName = "<displayName>", } }, }, initialMessage = new { content = "<content>", }, }); Response response = client.CreateConversation(content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("id").ToString()); Console.WriteLine(result.GetProperty("topic").ToString()); Console.WriteLine(result.GetProperty("deliveryChannelIds")[0].ToString()); Console.WriteLine(result.GetProperty("outboundDeliveryStrategy").ToString()); Console.WriteLine(result.GetProperty("participants")[0].GetProperty("id").ToString()); Console.WriteLine(result.GetProperty("participants")[0].GetProperty("displayName").ToString()); Console.WriteLine(result.GetProperty("participants")[0].GetProperty("kind").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="CreateConversation"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Communication.Messages.CommunicationConversation> CreateConversation (Azure.Communication.Messages.CommunicationConversation conversation, Azure.Communication.Messages.ConversationMessage initialMessage = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Communication.Messages.CommunicationConversation> CreateConversation(class Azure.Communication.Messages.CommunicationConversation conversation, class Azure.Communication.Messages.ConversationMessage initialMessage, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.CreateConversation(Azure.Communication.Messages.CommunicationConversation,Azure.Communication.Messages.ConversationMessage,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function CreateConversation (conversation As CommunicationConversation, Optional initialMessage As ConversationMessage = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of CommunicationConversation)" /> <MemberSignature Language="F#" Value="abstract member CreateConversation : Azure.Communication.Messages.CommunicationConversation * Azure.Communication.Messages.ConversationMessage * System.Threading.CancellationToken -> Azure.Response<Azure.Communication.Messages.CommunicationConversation>
override this.CreateConversation : Azure.Communication.Messages.CommunicationConversation * Azure.Communication.Messages.ConversationMessage * System.Threading.CancellationToken -> Azure.Response<Azure.Communication.Messages.CommunicationConversation>" Usage="conversationAdministrationClient.CreateConversation (conversation, initialMessage, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.Communication.Messages.CommunicationConversation></ReturnType> </ReturnValue> <Parameters> <Parameter Name="conversation" Type="Azure.Communication.Messages.CommunicationConversation" /> <Parameter Name="initialMessage" Type="Azure.Communication.Messages.ConversationMessage" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="conversation"> The conversation details. </param> <param name="initialMessage"> An initial message within the conversation. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Creates a new conversation. This is only for create operation. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="conversation" /> is null. </exception> <example> This sample shows how to call CreateConversation. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); CommunicationConversation conversation = new CommunicationConversation(); Response<CommunicationConversation> response = client.CreateConversation(conversation); ]]></code> This sample shows how to call CreateConversation with all parameters. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); CommunicationConversation conversation = new CommunicationConversation { Topic = "<topic>", DeliveryChannelIds = { "<deliveryChannelIds>" }, OutboundDeliveryStrategy = OutboundDeliveryStrategyKind.InternalOnly, Participants = {new InternalConversationParticipant(new CommunicationContact("<id>")) { DisplayName = "<displayName>", }}, }; ConversationMessage initialMessage = new ConversationMessage("<content>"); Response<CommunicationConversation> response = client.CreateConversation(conversation, initialMessage: initialMessage); ]]></code></example> </Docs> </Member> <Member MemberName="CreateConversationAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> CreateConversationAsync (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> CreateConversationAsync(class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.CreateConversationAsync(Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function CreateConversationAsync (content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member CreateConversationAsync : Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.CreateConversationAsync : Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="conversationAdministrationClient.CreateConversationAsync (content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </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] Creates a new conversation. This is only for create operation. <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.ConversationAdministrationClient.CreateConversationAsync(Azure.Communication.Messages.CommunicationConversation,Azure.Communication.Messages.ConversationMessage,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 CreateConversationAsync and parse the result. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); using RequestContent content = RequestContent.Create(new { conversation = new object(), }); Response response = await client.CreateConversationAsync(content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("id").ToString()); ]]></code> This sample shows how to call CreateConversationAsync with all request content and parse the result. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); using RequestContent content = RequestContent.Create(new { conversation = new { topic = "<topic>", deliveryChannelIds = new object[] { "<deliveryChannelIds>" }, outboundDeliveryStrategy = "internalOnly", participants = new object[] { new { kind = "internal", contact = new { kind = "communication", id = "<id>", }, displayName = "<displayName>", } }, }, initialMessage = new { content = "<content>", }, }); Response response = await client.CreateConversationAsync(content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("id").ToString()); Console.WriteLine(result.GetProperty("topic").ToString()); Console.WriteLine(result.GetProperty("deliveryChannelIds")[0].ToString()); Console.WriteLine(result.GetProperty("outboundDeliveryStrategy").ToString()); Console.WriteLine(result.GetProperty("participants")[0].GetProperty("id").ToString()); Console.WriteLine(result.GetProperty("participants")[0].GetProperty("displayName").ToString()); Console.WriteLine(result.GetProperty("participants")[0].GetProperty("kind").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="CreateConversationAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Communication.Messages.CommunicationConversation>> CreateConversationAsync (Azure.Communication.Messages.CommunicationConversation conversation, Azure.Communication.Messages.ConversationMessage initialMessage = default, 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.CommunicationConversation>> CreateConversationAsync(class Azure.Communication.Messages.CommunicationConversation conversation, class Azure.Communication.Messages.ConversationMessage initialMessage, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.CreateConversationAsync(Azure.Communication.Messages.CommunicationConversation,Azure.Communication.Messages.ConversationMessage,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function CreateConversationAsync (conversation As CommunicationConversation, Optional initialMessage As ConversationMessage = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of CommunicationConversation))" /> <MemberSignature Language="F#" Value="abstract member CreateConversationAsync : Azure.Communication.Messages.CommunicationConversation * Azure.Communication.Messages.ConversationMessage * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Communication.Messages.CommunicationConversation>>
override this.CreateConversationAsync : Azure.Communication.Messages.CommunicationConversation * Azure.Communication.Messages.ConversationMessage * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Communication.Messages.CommunicationConversation>>" Usage="conversationAdministrationClient.CreateConversationAsync (conversation, initialMessage, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Communication.Messages.CommunicationConversation>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="conversation" Type="Azure.Communication.Messages.CommunicationConversation" /> <Parameter Name="initialMessage" Type="Azure.Communication.Messages.ConversationMessage" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="conversation"> The conversation details. </param> <param name="initialMessage"> An initial message within the conversation. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Creates a new conversation. This is only for create operation. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="conversation" /> is null. </exception> <example> This sample shows how to call CreateConversationAsync. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); CommunicationConversation conversation = new CommunicationConversation(); Response<CommunicationConversation> response = await client.CreateConversationAsync(conversation); ]]></code> This sample shows how to call CreateConversationAsync with all parameters. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); CommunicationConversation conversation = new CommunicationConversation { Topic = "<topic>", DeliveryChannelIds = { "<deliveryChannelIds>" }, OutboundDeliveryStrategy = OutboundDeliveryStrategyKind.InternalOnly, Participants = {new InternalConversationParticipant(new CommunicationContact("<id>")) { DisplayName = "<displayName>", }}, }; ConversationMessage initialMessage = new ConversationMessage("<content>"); Response<CommunicationConversation> response = await client.CreateConversationAsync(conversation, initialMessage: initialMessage); ]]></code></example> </Docs> </Member> <Member MemberName="DeleteConversation"> <MemberSignature Language="C#" Value="public virtual Azure.Response DeleteConversation (string conversationId, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response DeleteConversation(string conversationId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.DeleteConversation(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteConversation (conversationId As String, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member DeleteConversation : string * Azure.RequestContext -> Azure.Response
override this.DeleteConversation : string * Azure.RequestContext -> Azure.Response" Usage="conversationAdministrationClient.DeleteConversation (conversationId, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="conversationId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="conversationId"> The conversation ID. </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] Deletes a specific conversation. <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></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="conversationId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="conversationId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call DeleteConversation. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); Response response = client.DeleteConversation("<conversationId>"); Console.WriteLine(response.Status); ]]></code> This sample shows how to call DeleteConversation with all parameters. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); Response response = client.DeleteConversation("<conversationId>"); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="DeleteConversationAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> DeleteConversationAsync (string conversationId, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> DeleteConversationAsync(string conversationId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.DeleteConversationAsync(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteConversationAsync (conversationId As String, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member DeleteConversationAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteConversationAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="conversationAdministrationClient.DeleteConversationAsync (conversationId, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="conversationId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="conversationId"> The conversation ID. </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] Deletes a specific conversation. <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></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="conversationId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="conversationId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call DeleteConversationAsync. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); Response response = await client.DeleteConversationAsync("<conversationId>"); Console.WriteLine(response.Status); ]]></code> This sample shows how to call DeleteConversationAsync with all parameters. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); Response response = await client.DeleteConversationAsync("<conversationId>"); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="GetConversation"> <MemberSignature Language="C#" Value="public virtual Azure.Response GetConversation (string conversationId, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetConversation(string conversationId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.GetConversation(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetConversation (conversationId As String, context As RequestContext) As Response" /> <MemberSignature Language="F#" Value="abstract member GetConversation : string * Azure.RequestContext -> Azure.Response
override this.GetConversation : string * Azure.RequestContext -> Azure.Response" Usage="conversationAdministrationClient.GetConversation (conversationId, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="conversationId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="conversationId"> The conversation ID. </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] Gets the details of a specific conversation. <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.ConversationAdministrationClient.GetConversation(System.String,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="conversationId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="conversationId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetConversation and parse the result. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); Response response = client.GetConversation("<conversationId>", null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("id").ToString()); ]]></code> This sample shows how to call GetConversation with all parameters and parse the result. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); Response response = client.GetConversation("<conversationId>", null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("id").ToString()); Console.WriteLine(result.GetProperty("topic").ToString()); Console.WriteLine(result.GetProperty("deliveryChannelIds")[0].ToString()); Console.WriteLine(result.GetProperty("outboundDeliveryStrategy").ToString()); Console.WriteLine(result.GetProperty("participants")[0].GetProperty("id").ToString()); Console.WriteLine(result.GetProperty("participants")[0].GetProperty("displayName").ToString()); Console.WriteLine(result.GetProperty("participants")[0].GetProperty("kind").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetConversation"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Communication.Messages.CommunicationConversation> GetConversation (string conversationId, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Communication.Messages.CommunicationConversation> GetConversation(string conversationId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.GetConversation(System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetConversation (conversationId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of CommunicationConversation)" /> <MemberSignature Language="F#" Value="abstract member GetConversation : string * System.Threading.CancellationToken -> Azure.Response<Azure.Communication.Messages.CommunicationConversation>
override this.GetConversation : string * System.Threading.CancellationToken -> Azure.Response<Azure.Communication.Messages.CommunicationConversation>" Usage="conversationAdministrationClient.GetConversation (conversationId, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.Communication.Messages.CommunicationConversation></ReturnType> </ReturnValue> <Parameters> <Parameter Name="conversationId" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="conversationId"> The conversation ID. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Gets the details of a specific conversation. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="conversationId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="conversationId" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call GetConversation. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); Response<CommunicationConversation> response = client.GetConversation("<conversationId>"); ]]></code> This sample shows how to call GetConversation with all parameters. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); Response<CommunicationConversation> response = client.GetConversation("<conversationId>"); ]]></code></example> </Docs> </Member> <Member MemberName="GetConversationAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetConversationAsync (string conversationId, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetConversationAsync(string conversationId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.GetConversationAsync(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetConversationAsync (conversationId As String, context As RequestContext) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member GetConversationAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetConversationAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="conversationAdministrationClient.GetConversationAsync (conversationId, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="conversationId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="conversationId"> The conversation ID. </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] Gets the details of a specific conversation. <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.ConversationAdministrationClient.GetConversationAsync(System.String,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="conversationId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="conversationId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetConversationAsync and parse the result. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); Response response = await client.GetConversationAsync("<conversationId>", null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("id").ToString()); ]]></code> This sample shows how to call GetConversationAsync with all parameters and parse the result. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); Response response = await client.GetConversationAsync("<conversationId>", null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("id").ToString()); Console.WriteLine(result.GetProperty("topic").ToString()); Console.WriteLine(result.GetProperty("deliveryChannelIds")[0].ToString()); Console.WriteLine(result.GetProperty("outboundDeliveryStrategy").ToString()); Console.WriteLine(result.GetProperty("participants")[0].GetProperty("id").ToString()); Console.WriteLine(result.GetProperty("participants")[0].GetProperty("displayName").ToString()); Console.WriteLine(result.GetProperty("participants")[0].GetProperty("kind").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetConversationAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Communication.Messages.CommunicationConversation>> GetConversationAsync (string conversationId, 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.CommunicationConversation>> GetConversationAsync(string conversationId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.GetConversationAsync(System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetConversationAsync (conversationId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of CommunicationConversation))" /> <MemberSignature Language="F#" Value="abstract member GetConversationAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Communication.Messages.CommunicationConversation>>
override this.GetConversationAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Communication.Messages.CommunicationConversation>>" Usage="conversationAdministrationClient.GetConversationAsync (conversationId, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Communication.Messages.CommunicationConversation>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="conversationId" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="conversationId"> The conversation ID. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Gets the details of a specific conversation. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="conversationId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="conversationId" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call GetConversationAsync. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); Response<CommunicationConversation> response = await client.GetConversationAsync("<conversationId>"); ]]></code> This sample shows how to call GetConversationAsync with all parameters. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); Response<CommunicationConversation> response = await client.GetConversationAsync("<conversationId>"); ]]></code></example> </Docs> </Member> <Member MemberName="GetConversations"> <MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetConversations (int? maxPageSize, string participantId, Guid? channelId, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetConversations(valuetype System.Nullable`1<int32> maxPageSize, string participantId, valuetype System.Nullable`1<valuetype System.Guid> channelId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.GetConversations(System.Nullable{System.Int32},System.String,System.Nullable{System.Guid},Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetConversations (maxPageSize As Nullable(Of Integer), participantId As String, channelId As Nullable(Of Guid), context As RequestContext) As Pageable(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member GetConversations : Nullable<int> * string * Nullable<Guid> * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetConversations : Nullable<int> * string * Nullable<Guid> * Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="conversationAdministrationClient.GetConversations (maxPageSize, participantId, channelId, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Pageable<System.BinaryData></ReturnType> </ReturnValue> <Parameters> <Parameter Name="maxPageSize" Type="System.Nullable<System.Int32>" /> <Parameter Name="participantId" Type="System.String" /> <Parameter Name="channelId" Type="System.Nullable<System.Guid>" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="maxPageSize"> Number of objects to return per page. </param> <param name="participantId"> The participant user ID. </param> <param name="channelId"> The id of channel. </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] Retrieves list of conversations. <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.ConversationAdministrationClient.GetConversations(System.Nullable{System.Int32},System.String,System.Nullable{System.Guid},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 GetConversations and parse the result. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); foreach (BinaryData item in client.GetConversations(25, null, Guid.Parse("0f0eb78e-a576-1dfc-b414-0f0756de3338"), null)) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("id").ToString()); } ]]></code></example> </Docs> </Member> <Member MemberName="GetConversations"> <MemberSignature Language="C#" Value="public virtual Azure.Pageable<Azure.Communication.Messages.CommunicationConversation> GetConversations (int? maxPageSize = default, string participantId = default, Guid? channelId = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class Azure.Communication.Messages.CommunicationConversation> GetConversations(valuetype System.Nullable`1<int32> maxPageSize, string participantId, valuetype System.Nullable`1<valuetype System.Guid> channelId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.GetConversations(System.Nullable{System.Int32},System.String,System.Nullable{System.Guid},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetConversations (Optional maxPageSize As Nullable(Of Integer) = Nothing, Optional participantId As String = Nothing, Optional channelId As Nullable(Of Guid) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of CommunicationConversation)" /> <MemberSignature Language="F#" Value="abstract member GetConversations : Nullable<int> * string * Nullable<Guid> * System.Threading.CancellationToken -> Azure.Pageable<Azure.Communication.Messages.CommunicationConversation>
override this.GetConversations : Nullable<int> * string * Nullable<Guid> * System.Threading.CancellationToken -> Azure.Pageable<Azure.Communication.Messages.CommunicationConversation>" Usage="conversationAdministrationClient.GetConversations (maxPageSize, participantId, channelId, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Pageable<Azure.Communication.Messages.CommunicationConversation></ReturnType> </ReturnValue> <Parameters> <Parameter Name="maxPageSize" Type="System.Nullable<System.Int32>" /> <Parameter Name="participantId" Type="System.String" /> <Parameter Name="channelId" Type="System.Nullable<System.Guid>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="maxPageSize"> Number of objects to return per page. </param> <param name="participantId"> The participant user ID. </param> <param name="channelId"> The id of channel. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Retrieves list of conversations. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <example> This sample shows how to call GetConversations. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); foreach (CommunicationConversation item in client.GetConversations()) { } ]]></code></example> </Docs> </Member> <Member MemberName="GetConversationsAsync"> <MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetConversationsAsync (int? maxPageSize, string participantId, Guid? channelId, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetConversationsAsync(valuetype System.Nullable`1<int32> maxPageSize, string participantId, valuetype System.Nullable`1<valuetype System.Guid> channelId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.GetConversationsAsync(System.Nullable{System.Int32},System.String,System.Nullable{System.Guid},Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetConversationsAsync (maxPageSize As Nullable(Of Integer), participantId As String, channelId As Nullable(Of Guid), context As RequestContext) As AsyncPageable(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member GetConversationsAsync : Nullable<int> * string * Nullable<Guid> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetConversationsAsync : Nullable<int> * string * Nullable<Guid> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="conversationAdministrationClient.GetConversationsAsync (maxPageSize, participantId, channelId, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.AsyncPageable<System.BinaryData></ReturnType> </ReturnValue> <Parameters> <Parameter Name="maxPageSize" Type="System.Nullable<System.Int32>" /> <Parameter Name="participantId" Type="System.String" /> <Parameter Name="channelId" Type="System.Nullable<System.Guid>" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="maxPageSize"> Number of objects to return per page. </param> <param name="participantId"> The participant user ID. </param> <param name="channelId"> The id of channel. </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] Retrieves list of conversations. <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.ConversationAdministrationClient.GetConversationsAsync(System.Nullable{System.Int32},System.String,System.Nullable{System.Guid},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 GetConversationsAsync and parse the result. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); await foreach (BinaryData item in client.GetConversationsAsync(25, null, Guid.Parse("0f0eb78e-a576-1dfc-b414-0f0756de3338"), null)) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("id").ToString()); } ]]></code></example> </Docs> </Member> <Member MemberName="GetConversationsAsync"> <MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<Azure.Communication.Messages.CommunicationConversation> GetConversationsAsync (int? maxPageSize = default, string participantId = default, Guid? channelId = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class Azure.Communication.Messages.CommunicationConversation> GetConversationsAsync(valuetype System.Nullable`1<int32> maxPageSize, string participantId, valuetype System.Nullable`1<valuetype System.Guid> channelId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.GetConversationsAsync(System.Nullable{System.Int32},System.String,System.Nullable{System.Guid},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetConversationsAsync (Optional maxPageSize As Nullable(Of Integer) = Nothing, Optional participantId As String = Nothing, Optional channelId As Nullable(Of Guid) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of CommunicationConversation)" /> <MemberSignature Language="F#" Value="abstract member GetConversationsAsync : Nullable<int> * string * Nullable<Guid> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Communication.Messages.CommunicationConversation>
override this.GetConversationsAsync : Nullable<int> * string * Nullable<Guid> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Communication.Messages.CommunicationConversation>" Usage="conversationAdministrationClient.GetConversationsAsync (maxPageSize, participantId, channelId, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.AsyncPageable<Azure.Communication.Messages.CommunicationConversation></ReturnType> </ReturnValue> <Parameters> <Parameter Name="maxPageSize" Type="System.Nullable<System.Int32>" /> <Parameter Name="participantId" Type="System.String" /> <Parameter Name="channelId" Type="System.Nullable<System.Guid>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="maxPageSize"> Number of objects to return per page. </param> <param name="participantId"> The participant user ID. </param> <param name="channelId"> The id of channel. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Retrieves list of conversations. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <example> This sample shows how to call GetConversationsAsync. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); await foreach (CommunicationConversation item in client.GetConversationsAsync()) { } ]]></code></example> </Docs> </Member> <Member MemberName="GetMessages"> <MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetMessages (string conversationId, int? maxPageSize, string participantId, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetMessages(string conversationId, valuetype System.Nullable`1<int32> maxPageSize, string participantId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.GetMessages(System.String,System.Nullable{System.Int32},System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetMessages (conversationId As String, maxPageSize As Nullable(Of Integer), participantId As String, context As RequestContext) As Pageable(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member GetMessages : string * Nullable<int> * string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetMessages : string * Nullable<int> * string * Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="conversationAdministrationClient.GetMessages (conversationId, maxPageSize, participantId, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Pageable<System.BinaryData></ReturnType> </ReturnValue> <Parameters> <Parameter Name="conversationId" Type="System.String" /> <Parameter Name="maxPageSize" Type="System.Nullable<System.Int32>" /> <Parameter Name="participantId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="conversationId"> The conversation ID. </param> <param name="maxPageSize"> Number of objects to return per page. </param> <param name="participantId"> The participant user ID. </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] Retrieves list of conversation messages. <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.ConversationAdministrationClient.GetMessages(System.String,System.Nullable{System.Int32},System.String,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:System.ArgumentNullException"> <paramref name="conversationId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="conversationId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetMessages and parse the result. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); foreach (BinaryData item in client.GetMessages("19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2", null, null, null)) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("id").ToString()); Console.WriteLine(result.GetProperty("message").GetProperty("kind").ToString()); Console.WriteLine(result.GetProperty("senderCommunicationIdentifier").ToString()); Console.WriteLine(result.GetProperty("createdOn").ToString()); } ]]></code></example> </Docs> </Member> <Member MemberName="GetMessages"> <MemberSignature Language="C#" Value="public virtual Azure.Pageable<Azure.Communication.Messages.ConversationMessageItem> GetMessages (string conversationId, int? maxPageSize = default, string participantId = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class Azure.Communication.Messages.ConversationMessageItem> GetMessages(string conversationId, valuetype System.Nullable`1<int32> maxPageSize, string participantId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.GetMessages(System.String,System.Nullable{System.Int32},System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetMessages (conversationId As String, Optional maxPageSize As Nullable(Of Integer) = Nothing, Optional participantId As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of ConversationMessageItem)" /> <MemberSignature Language="F#" Value="abstract member GetMessages : string * Nullable<int> * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Communication.Messages.ConversationMessageItem>
override this.GetMessages : string * Nullable<int> * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Communication.Messages.ConversationMessageItem>" Usage="conversationAdministrationClient.GetMessages (conversationId, maxPageSize, participantId, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Pageable<Azure.Communication.Messages.ConversationMessageItem></ReturnType> </ReturnValue> <Parameters> <Parameter Name="conversationId" Type="System.String" /> <Parameter Name="maxPageSize" Type="System.Nullable<System.Int32>" /> <Parameter Name="participantId" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="conversationId"> The conversation ID. </param> <param name="maxPageSize"> Number of objects to return per page. </param> <param name="participantId"> The participant user ID. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Retrieves list of conversation messages. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="conversationId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="conversationId" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call GetMessages. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); foreach (ConversationMessageItem item in client.GetMessages("19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2")) { } ]]></code></example> </Docs> </Member> <Member MemberName="GetMessagesAsync"> <MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetMessagesAsync (string conversationId, int? maxPageSize, string participantId, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetMessagesAsync(string conversationId, valuetype System.Nullable`1<int32> maxPageSize, string participantId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.GetMessagesAsync(System.String,System.Nullable{System.Int32},System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetMessagesAsync (conversationId As String, maxPageSize As Nullable(Of Integer), participantId As String, context As RequestContext) As AsyncPageable(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member GetMessagesAsync : string * Nullable<int> * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetMessagesAsync : string * Nullable<int> * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="conversationAdministrationClient.GetMessagesAsync (conversationId, maxPageSize, participantId, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.AsyncPageable<System.BinaryData></ReturnType> </ReturnValue> <Parameters> <Parameter Name="conversationId" Type="System.String" /> <Parameter Name="maxPageSize" Type="System.Nullable<System.Int32>" /> <Parameter Name="participantId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="conversationId"> The conversation ID. </param> <param name="maxPageSize"> Number of objects to return per page. </param> <param name="participantId"> The participant user ID. </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] Retrieves list of conversation messages. <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.ConversationAdministrationClient.GetMessagesAsync(System.String,System.Nullable{System.Int32},System.String,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:System.ArgumentNullException"> <paramref name="conversationId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="conversationId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetMessagesAsync and parse the result. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); await foreach (BinaryData item in client.GetMessagesAsync("19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2", null, null, null)) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("id").ToString()); Console.WriteLine(result.GetProperty("message").GetProperty("kind").ToString()); Console.WriteLine(result.GetProperty("senderCommunicationIdentifier").ToString()); Console.WriteLine(result.GetProperty("createdOn").ToString()); } ]]></code></example> </Docs> </Member> <Member MemberName="GetMessagesAsync"> <MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<Azure.Communication.Messages.ConversationMessageItem> GetMessagesAsync (string conversationId, int? maxPageSize = default, string participantId = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class Azure.Communication.Messages.ConversationMessageItem> GetMessagesAsync(string conversationId, valuetype System.Nullable`1<int32> maxPageSize, string participantId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.GetMessagesAsync(System.String,System.Nullable{System.Int32},System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetMessagesAsync (conversationId As String, Optional maxPageSize As Nullable(Of Integer) = Nothing, Optional participantId As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of ConversationMessageItem)" /> <MemberSignature Language="F#" Value="abstract member GetMessagesAsync : string * Nullable<int> * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Communication.Messages.ConversationMessageItem>
override this.GetMessagesAsync : string * Nullable<int> * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Communication.Messages.ConversationMessageItem>" Usage="conversationAdministrationClient.GetMessagesAsync (conversationId, maxPageSize, participantId, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.AsyncPageable<Azure.Communication.Messages.ConversationMessageItem></ReturnType> </ReturnValue> <Parameters> <Parameter Name="conversationId" Type="System.String" /> <Parameter Name="maxPageSize" Type="System.Nullable<System.Int32>" /> <Parameter Name="participantId" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="conversationId"> The conversation ID. </param> <param name="maxPageSize"> Number of objects to return per page. </param> <param name="participantId"> The participant user ID. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Retrieves list of conversation messages. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="conversationId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="conversationId" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call GetMessagesAsync. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); await foreach (ConversationMessageItem item in client.GetMessagesAsync("19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2")) { } ]]></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.ConversationAdministrationClient.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.ConversationAdministrationClient.Pipeline" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.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="RemoveParticipants"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Communication.Messages.RemoveParticipantsResult> RemoveParticipants (string conversationId, Azure.Communication.Messages.RemoveParticipantsOptions options, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Communication.Messages.RemoveParticipantsResult> RemoveParticipants(string conversationId, class Azure.Communication.Messages.RemoveParticipantsOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.RemoveParticipants(System.String,Azure.Communication.Messages.RemoveParticipantsOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RemoveParticipants (conversationId As String, options As RemoveParticipantsOptions, Optional cancellationToken As CancellationToken = Nothing) As Response(Of RemoveParticipantsResult)" /> <MemberSignature Language="F#" Value="abstract member RemoveParticipants : string * Azure.Communication.Messages.RemoveParticipantsOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Communication.Messages.RemoveParticipantsResult>
override this.RemoveParticipants : string * Azure.Communication.Messages.RemoveParticipantsOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Communication.Messages.RemoveParticipantsResult>" Usage="conversationAdministrationClient.RemoveParticipants (conversationId, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.Communication.Messages.RemoveParticipantsResult></ReturnType> </ReturnValue> <Parameters> <Parameter Name="conversationId" Type="System.String" /> <Parameter Name="options" Type="Azure.Communication.Messages.RemoveParticipantsOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="conversationId"> The conversation ID. </param> <param name="options"> Details of the request body for removing participants from a conversation. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> remove a participant from a conversation. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="conversationId" /> or <paramref name="options" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="conversationId" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call RemoveParticipants. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); RemoveParticipantsOptions options = new RemoveParticipantsOptions(new string[] { "8:acs:uuid2" }); Response<RemoveParticipantsResult> response = client.RemoveParticipants("19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2", options); ]]></code></example> </Docs> </Member> <Member MemberName="RemoveParticipants"> <MemberSignature Language="C#" Value="public virtual Azure.Response RemoveParticipants (string conversationId, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response RemoveParticipants(string conversationId, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.RemoveParticipants(System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RemoveParticipants (conversationId As String, content As RequestContent, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member RemoveParticipants : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.RemoveParticipants : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="conversationAdministrationClient.RemoveParticipants (conversationId, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="conversationId" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="conversationId"> The conversation ID. </param> <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] remove a participant from a conversation <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.ConversationAdministrationClient.RemoveParticipants(System.String,Azure.Communication.Messages.RemoveParticipantsOptions,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="conversationId" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="conversationId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call RemoveParticipants and parse the result. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); using RequestContent content = RequestContent.Create(new { participantIds = new object[] { "8:acs:uuid2" }, }); Response response = client.RemoveParticipants("19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2", content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("invalidParticipants")[0].GetProperty("id").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="RemoveParticipantsAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Communication.Messages.RemoveParticipantsResult>> RemoveParticipantsAsync (string conversationId, Azure.Communication.Messages.RemoveParticipantsOptions 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.RemoveParticipantsResult>> RemoveParticipantsAsync(string conversationId, class Azure.Communication.Messages.RemoveParticipantsOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.RemoveParticipantsAsync(System.String,Azure.Communication.Messages.RemoveParticipantsOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RemoveParticipantsAsync (conversationId As String, options As RemoveParticipantsOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of RemoveParticipantsResult))" /> <MemberSignature Language="F#" Value="abstract member RemoveParticipantsAsync : string * Azure.Communication.Messages.RemoveParticipantsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Communication.Messages.RemoveParticipantsResult>>
override this.RemoveParticipantsAsync : string * Azure.Communication.Messages.RemoveParticipantsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Communication.Messages.RemoveParticipantsResult>>" Usage="conversationAdministrationClient.RemoveParticipantsAsync (conversationId, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Communication.Messages.RemoveParticipantsResult>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="conversationId" Type="System.String" /> <Parameter Name="options" Type="Azure.Communication.Messages.RemoveParticipantsOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="conversationId"> The conversation ID. </param> <param name="options"> Details of the request body for removing participants from a conversation. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> remove a participant from a conversation. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="conversationId" /> or <paramref name="options" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="conversationId" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call RemoveParticipantsAsync. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); RemoveParticipantsOptions options = new RemoveParticipantsOptions(new string[] { "8:acs:uuid2" }); Response<RemoveParticipantsResult> response = await client.RemoveParticipantsAsync("19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2", options); ]]></code></example> </Docs> </Member> <Member MemberName="RemoveParticipantsAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> RemoveParticipantsAsync (string conversationId, 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> RemoveParticipantsAsync(string conversationId, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.RemoveParticipantsAsync(System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RemoveParticipantsAsync (conversationId As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member RemoveParticipantsAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.RemoveParticipantsAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="conversationAdministrationClient.RemoveParticipantsAsync (conversationId, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="conversationId" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="conversationId"> The conversation ID. </param> <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] remove a participant from a conversation <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.ConversationAdministrationClient.RemoveParticipantsAsync(System.String,Azure.Communication.Messages.RemoveParticipantsOptions,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="conversationId" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="conversationId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call RemoveParticipantsAsync and parse the result. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); using RequestContent content = RequestContent.Create(new { participantIds = new object[] { "8:acs:uuid2" }, }); Response response = await client.RemoveParticipantsAsync("19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2", content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("invalidParticipants")[0].GetProperty("id").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="TerminateConversation"> <MemberSignature Language="C#" Value="public virtual Azure.Response TerminateConversation (string conversationId, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response TerminateConversation(string conversationId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.TerminateConversation(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function TerminateConversation (conversationId As String, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member TerminateConversation : string * Azure.RequestContext -> Azure.Response
override this.TerminateConversation : string * Azure.RequestContext -> Azure.Response" Usage="conversationAdministrationClient.TerminateConversation (conversationId, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="conversationId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="conversationId"> The conversation ID. </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] Terminates a specific conversation. <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></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="conversationId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="conversationId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call TerminateConversation. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); Response response = client.TerminateConversation("<conversationId>"); Console.WriteLine(response.Status); ]]></code> This sample shows how to call TerminateConversation with all parameters. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); Response response = client.TerminateConversation("<conversationId>"); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="TerminateConversationAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> TerminateConversationAsync (string conversationId, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> TerminateConversationAsync(string conversationId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.Communication.Messages.ConversationAdministrationClient.TerminateConversationAsync(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function TerminateConversationAsync (conversationId As String, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member TerminateConversationAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.TerminateConversationAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="conversationAdministrationClient.TerminateConversationAsync (conversationId, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.Communication.Messages</AssemblyName> <AssemblyVersion>1.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="conversationId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="conversationId"> The conversation ID. </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] Terminates a specific conversation. <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></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="conversationId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="conversationId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call TerminateConversationAsync. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); Response response = await client.TerminateConversationAsync("<conversationId>"); Console.WriteLine(response.Status); ]]></code> This sample shows how to call TerminateConversationAsync with all parameters. <code><![CDATA[ ConversationAdministrationClient client = new ConversationAdministrationClient((string)null); Response response = await client.TerminateConversationAsync("<conversationId>"); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> </Members> </Type>

xml/Azure.Communication.Messages/ConversationAdministrationClient.xml (1,841 lines of code) (raw):