DialogServiceConfig.xml

<Type Name="DialogServiceConfig" FullName="Microsoft.CognitiveServices.Speech.Dialog.DialogServiceConfig">
  <TypeSignature Language="C#" Value="public abstract class DialogServiceConfig" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit DialogServiceConfig extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.CognitiveServices.Speech.Dialog.DialogServiceConfig" />
  <TypeSignature Language="VB.NET" Value="Public MustInherit Class DialogServiceConfig" />
  <TypeSignature Language="F#" Value="type DialogServiceConfig = class" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
    <AssemblyVersion>1.16.0.28</AssemblyVersion>
    <AssemblyVersion>1.17.0.28</AssemblyVersion>
    <AssemblyVersion>1.18.0.28</AssemblyVersion>
    <AssemblyVersion>1.19.0.28</AssemblyVersion>
    <AssemblyVersion>1.20.0.28</AssemblyVersion>
    <AssemblyVersion>1.21.0.28</AssemblyVersion>
    <AssemblyVersion>1.22.0.28</AssemblyVersion>
    <AssemblyVersion>1.23.0.28</AssemblyVersion>
    <AssemblyVersion>1.24.0.28</AssemblyVersion>
    <AssemblyVersion>1.24.1.28</AssemblyVersion>
    <AssemblyVersion>1.25.1.26</AssemblyVersion>
    <AssemblyVersion>1.27.0.28</AssemblyVersion>
    <AssemblyVersion>1.28.0.28</AssemblyVersion>
    <AssemblyVersion>1.30.0.28</AssemblyVersion>
    <AssemblyVersion>1.31.0.28</AssemblyVersion>
    <AssemblyVersion>1.32.1.28</AssemblyVersion>
    <AssemblyVersion>1.34.0.28</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Contains base configurations for dialog service connector.
            Added in 1.5.0
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName="GetProperty">
      <MemberSignature Language="C#" Value="public string GetProperty (Microsoft.CognitiveServices.Speech.PropertyId id);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance string GetProperty(valuetype Microsoft.CognitiveServices.Speech.PropertyId id) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Dialog.DialogServiceConfig.GetProperty(Microsoft.CognitiveServices.Speech.PropertyId)" />
      <MemberSignature Language="VB.NET" Value="Public Function GetProperty (id As PropertyId) As String" />
      <MemberSignature Language="F#" Value="member this.GetProperty : Microsoft.CognitiveServices.Speech.PropertyId -&gt; string" Usage="dialogServiceConfig.GetProperty id" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
        <AssemblyVersion>1.34.0.28</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="id" Type="Microsoft.CognitiveServices.Speech.PropertyId" />
      </Parameters>
      <Docs>
        <param name="id">PropertyId of the property</param>
        <summary>
            Searches for the property named with the given PropertyId value.
            </summary>
        <returns>Value of the property</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetProperty">
      <MemberSignature Language="C#" Value="public string GetProperty (string name);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance string GetProperty(string name) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Dialog.DialogServiceConfig.GetProperty(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Function GetProperty (name As String) As String" />
      <MemberSignature Language="F#" Value="member this.GetProperty : string -&gt; string" Usage="dialogServiceConfig.GetProperty name" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
        <AssemblyVersion>1.34.0.28</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="name" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="name">Name of the property</param>
        <summary>
            Searches for the property based on the given string name.
            </summary>
        <returns>Value of the property</returns>
        <remarks>
            A small number of properties are stored using string names.
            In most cases, you will use <see cref="M:Microsoft.CognitiveServices.Speech.Audio.AudioConfig.GetProperty(Microsoft.CognitiveServices.Speech.PropertyId)" /> instead of this method.
            </remarks>
      </Docs>
    </Member>
    <Member MemberName="Language">
      <MemberSignature Language="C#" Value="public string Language { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Language" />
      <MemberSignature Language="DocId" Value="P:Microsoft.CognitiveServices.Speech.Dialog.DialogServiceConfig.Language" />
      <MemberSignature Language="VB.NET" Value="Public Property Language As String" />
      <MemberSignature Language="F#" Value="member this.Language : string with get, set" Usage="Microsoft.CognitiveServices.Speech.Dialog.DialogServiceConfig.Language" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
        <AssemblyVersion>1.34.0.28</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Specifies the name of the language to be used, in BCP-47 format.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="SetProperty">
      <MemberSignature Language="C#" Value="public void SetProperty (Microsoft.CognitiveServices.Speech.PropertyId id, string value);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetProperty(valuetype Microsoft.CognitiveServices.Speech.PropertyId id, string value) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Dialog.DialogServiceConfig.SetProperty(Microsoft.CognitiveServices.Speech.PropertyId,System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Sub SetProperty (id As PropertyId, value As String)" />
      <MemberSignature Language="F#" Value="member this.SetProperty : Microsoft.CognitiveServices.Speech.PropertyId * string -&gt; unit" Usage="dialogServiceConfig.SetProperty (id, value)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
        <AssemblyVersion>1.34.0.28</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="id" Type="Microsoft.CognitiveServices.Speech.PropertyId" />
        <Parameter Name="value" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="id">PropertyId of the property</param>
        <param name="value">Value of the property</param>
        <summary>
            Sets a property using a PropertyId value.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="SetProperty">
      <MemberSignature Language="C#" Value="public void SetProperty (string name, string value);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetProperty(string name, string value) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Dialog.DialogServiceConfig.SetProperty(System.String,System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Sub SetProperty (name As String, value As String)" />
      <MemberSignature Language="F#" Value="member this.SetProperty : string * string -&gt; unit" Usage="dialogServiceConfig.SetProperty (name, value)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
        <AssemblyVersion>1.34.0.28</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="name" Type="System.String" />
        <Parameter Name="value" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="name">Name of the property</param>
        <param name="value">Value of the property</param>
        <summary>
            Sets the property by name.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="SetProxy">
      <MemberSignature Language="C#" Value="public void SetProxy (string proxyHostName, int proxyPort);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetProxy(string proxyHostName, int32 proxyPort) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Dialog.DialogServiceConfig.SetProxy(System.String,System.Int32)" />
      <MemberSignature Language="VB.NET" Value="Public Sub SetProxy (proxyHostName As String, proxyPort As Integer)" />
      <MemberSignature Language="F#" Value="member this.SetProxy : string * int -&gt; unit" Usage="dialogServiceConfig.SetProxy (proxyHostName, proxyPort)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
        <AssemblyVersion>1.34.0.28</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="proxyHostName" Type="System.String" />
        <Parameter Name="proxyPort" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="proxyHostName">The host name of the proxy server.</param>
        <param name="proxyPort">The port number of the proxy server.</param>
        <summary>
            Sets proxy configuration.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="SetProxy">
      <MemberSignature Language="C#" Value="public void SetProxy (string proxyHostName, int proxyPort, string proxyUserName, string proxyPassword);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetProxy(string proxyHostName, int32 proxyPort, string proxyUserName, string proxyPassword) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Dialog.DialogServiceConfig.SetProxy(System.String,System.Int32,System.String,System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Sub SetProxy (proxyHostName As String, proxyPort As Integer, proxyUserName As String, proxyPassword As String)" />
      <MemberSignature Language="F#" Value="member this.SetProxy : string * int * string * string -&gt; unit" Usage="dialogServiceConfig.SetProxy (proxyHostName, proxyPort, proxyUserName, proxyPassword)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
        <AssemblyVersion>1.34.0.28</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="proxyHostName" Type="System.String" />
        <Parameter Name="proxyPort" Type="System.Int32" />
        <Parameter Name="proxyUserName" Type="System.String" />
        <Parameter Name="proxyPassword" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="proxyHostName">The host name of the proxy server, without the protocol scheme (http://)</param>
        <param name="proxyPort">The port number of the proxy server.</param>
        <param name="proxyUserName">The user name of the proxy server.</param>
        <param name="proxyPassword">The password of the proxy server.</param>
        <summary>
             Sets proxy configuration.
            
             Note: Proxy functionality is not available on macOS. This method will have no effect on the macOS platform.
             </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="SetServiceProperty">
      <MemberSignature Language="C#" Value="public void SetServiceProperty (string name, string value, Microsoft.CognitiveServices.Speech.ServicePropertyChannel channel);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetServiceProperty(string name, string value, valuetype Microsoft.CognitiveServices.Speech.ServicePropertyChannel channel) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Dialog.DialogServiceConfig.SetServiceProperty(System.String,System.String,Microsoft.CognitiveServices.Speech.ServicePropertyChannel)" />
      <MemberSignature Language="VB.NET" Value="Public Sub SetServiceProperty (name As String, value As String, channel As ServicePropertyChannel)" />
      <MemberSignature Language="F#" Value="member this.SetServiceProperty : string * string * Microsoft.CognitiveServices.Speech.ServicePropertyChannel -&gt; unit" Usage="dialogServiceConfig.SetServiceProperty (name, value, channel)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
        <AssemblyVersion>1.34.0.28</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="name" Type="System.String" />
        <Parameter Name="value" Type="System.String" />
        <Parameter Name="channel" Type="Microsoft.CognitiveServices.Speech.ServicePropertyChannel" />
      </Parameters>
      <Docs>
        <param name="name">The property name.</param>
        <param name="value">The property value.</param>
        <param name="channel">The channel used to pass the specified property to service.</param>
        <summary>
            Enables preview of new service features.
            </summary>
        <remarks>
            Used to configure services that are in Preview, and are not yet Generally Available. 
            This method might appear in some samples, where it can typically be ignored.
            </remarks>
      </Docs>
    </Member>
  </Members>
</Type>