xml/System.ClientModel.Primitives/ClientConnection.xml

<Type Name="ClientConnection" FullName="System.ClientModel.Primitives.ClientConnection">
  <TypeSignature Language="C#" Value="public readonly struct ClientConnection" />
  <TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit ClientConnection extends System.ValueType" />
  <TypeSignature Language="DocId" Value="T:System.ClientModel.Primitives.ClientConnection" />
  <TypeSignature Language="VB.NET" Value="Public Structure ClientConnection" />
  <TypeSignature Language="F#" Value="type ClientConnection = struct" />
  <AssemblyInfo>
    <AssemblyName>System.ClientModel</AssemblyName>
    <AssemblyVersion>1.4.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.ValueType</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Represents the connection options for a client.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ClientConnection (string id, string locator);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string id, string locator) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.ClientConnection.#ctor(System.String,System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (id As String, locator As String)" />
      <MemberSignature Language="F#" Value="new System.ClientModel.Primitives.ClientConnection : string * string -&gt; System.ClientModel.Primitives.ClientConnection" Usage="new System.ClientModel.Primitives.ClientConnection (id, locator)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="id" Type="System.String" />
        <Parameter Name="locator" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="id">The identifier for the connection.</param>
        <param name="locator">The endpoint or resource identifier.</param>
        <summary>
            Initializes a new instance of the <see cref="T:System.ClientModel.Primitives.ClientConnection" /> struct with a with no authentication.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ClientConnection (string id, string locator, object credential);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string id, string locator, object credential) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.ClientConnection.#ctor(System.String,System.String,System.Object)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (id As String, locator As String, credential As Object)" />
      <MemberSignature Language="F#" Value="new System.ClientModel.Primitives.ClientConnection : string * string * obj -&gt; System.ClientModel.Primitives.ClientConnection" Usage="new System.ClientModel.Primitives.ClientConnection (id, locator, credential)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="id" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet-preview" />
        <Parameter Name="locator" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet-preview" />
        <Parameter Name="credential" Type="System.Object" Index="2" FrameworkAlternate="azure-dotnet-preview" />
      </Parameters>
      <Docs>
        <param name="id">The identifier for the connection.</param>
        <param name="locator">The endpoint or resource identifier.</param>
        <param name="credential">The token credential.</param>
        <summary>
            Initializes a new instance of the <see cref="T:System.ClientModel.Primitives.ClientConnection" /> struct with a token credential.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ClientConnection (string id, string locator, string apiKey);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string id, string locator, string apiKey) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.ClientConnection.#ctor(System.String,System.String,System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (id As String, locator As String, apiKey As String)" />
      <MemberSignature Language="F#" Value="new System.ClientModel.Primitives.ClientConnection : string * string * string -&gt; System.ClientModel.Primitives.ClientConnection" Usage="new System.ClientModel.Primitives.ClientConnection (id, locator, apiKey)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="id" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet-preview" />
        <Parameter Name="locator" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet-preview" />
        <Parameter Name="apiKey" Type="System.String" Index="2" FrameworkAlternate="azure-dotnet-preview" />
      </Parameters>
      <Docs>
        <param name="id">The identifier for the connection.</param>
        <param name="locator">The endpoint or resource identifier.</param>
        <param name="apiKey">The API key credential.</param>
        <summary>
            Initializes a new instance of the <see cref="T:System.ClientModel.Primitives.ClientConnection" /> struct with an API key credential.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ClientConnection (string id, string locator, object credential, System.ClientModel.Primitives.CredentialKind credentialKind);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string id, string locator, object credential, valuetype System.ClientModel.Primitives.CredentialKind credentialKind) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.ClientConnection.#ctor(System.String,System.String,System.Object,System.ClientModel.Primitives.CredentialKind)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (id As String, locator As String, credential As Object, credentialKind As CredentialKind)" />
      <MemberSignature Language="F#" Value="new System.ClientModel.Primitives.ClientConnection : string * string * obj * System.ClientModel.Primitives.CredentialKind -&gt; System.ClientModel.Primitives.ClientConnection" Usage="new System.ClientModel.Primitives.ClientConnection (id, locator, credential, credentialKind)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="id" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
        <Parameter Name="locator" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet" />
        <Parameter Name="credential" Type="System.Object" Index="2" FrameworkAlternate="azure-dotnet" />
        <Parameter Name="credentialKind" Type="System.ClientModel.Primitives.CredentialKind" Index="3" FrameworkAlternate="azure-dotnet" />
      </Parameters>
      <Docs>
        <param name="id">The identifier for the connection.</param>
        <param name="locator">The endpoint or resource identifier.</param>
        <param name="credential">The client credential.</param>
        <param name="credentialKind">The kind of connection used by the client.</param>
        <summary>
            Initializes a new instance of the <see cref="T:System.ClientModel.Primitives.ClientConnection" /> struct with a token credential.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ApiKeyCredential">
      <MemberSignature Language="C#" Value="public string? ApiKeyCredential { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string ApiKeyCredential" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.ClientConnection.ApiKeyCredential" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property ApiKeyCredential As String" />
      <MemberSignature Language="F#" Value="member this.ApiKeyCredential : string" Usage="System.ClientModel.Primitives.ClientConnection.ApiKeyCredential" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the API key credential, if applicable.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Authentication">
      <MemberSignature Language="C#" Value="public System.ClientModel.Primitives.ClientAuthenticationMethod Authentication { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.ClientModel.Primitives.ClientAuthenticationMethod Authentication" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.ClientConnection.Authentication" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Authentication As ClientAuthenticationMethod" />
      <MemberSignature Language="F#" Value="member this.Authentication : System.ClientModel.Primitives.ClientAuthenticationMethod" Usage="System.ClientModel.Primitives.ClientConnection.Authentication" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.ClientModel.Primitives.ClientAuthenticationMethod</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the kind of connection used by the client.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Credential">
      <MemberSignature Language="C#" Value="public object? Credential { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance object Credential" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.ClientConnection.Credential" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Credential As Object" />
      <MemberSignature Language="F#" Value="member this.Credential : obj" Usage="System.ClientModel.Primitives.ClientConnection.Credential" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Object</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the credential.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="CredentialKind">
      <MemberSignature Language="C#" Value="public System.ClientModel.Primitives.CredentialKind CredentialKind { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.ClientModel.Primitives.CredentialKind CredentialKind" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.ClientConnection.CredentialKind" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property CredentialKind As CredentialKind" />
      <MemberSignature Language="F#" Value="member this.CredentialKind : System.ClientModel.Primitives.CredentialKind" Usage="System.ClientModel.Primitives.ClientConnection.CredentialKind" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.ClientModel.Primitives.CredentialKind</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the kind of connection used by the client.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Id">
      <MemberSignature Language="C#" Value="public string Id { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Id" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.ClientConnection.Id" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Id As String" />
      <MemberSignature Language="F#" Value="member this.Id : string" Usage="System.ClientModel.Primitives.ClientConnection.Id" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the connection identifier.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Locator">
      <MemberSignature Language="C#" Value="public string Locator { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Locator" />
      <MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.ClientConnection.Locator" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Locator As String" />
      <MemberSignature Language="F#" Value="member this.Locator : string" Usage="System.ClientModel.Primitives.ClientConnection.Locator" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            This is either URI, name, or something similar.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ToString">
      <MemberSignature Language="C#" Value="public override string ToString ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.ClientConnection.ToString" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
      <MemberSignature Language="F#" Value="override this.ToString : unit -&gt; string" Usage="clientConnection.ToString " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Returns a string representation of the connection.
            </summary>
        <returns>A string in the format 'Id =&gt; Locator'.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="TryGetLocatorAsUri">
      <MemberSignature Language="C#" Value="public bool TryGetLocatorAsUri (out Uri? uri);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryGetLocatorAsUri([out] class System.Uri&amp; uri) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.ClientConnection.TryGetLocatorAsUri(System.Uri@)" />
      <MemberSignature Language="VB.NET" Value="Public Function TryGetLocatorAsUri (ByRef uri As Uri) As Boolean" />
      <MemberSignature Language="F#" Value="member this.TryGetLocatorAsUri : Uri -&gt; bool" Usage="clientConnection.TryGetLocatorAsUri uri" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.ClientModel</AssemblyName>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="uri" Type="System.Uri" RefType="out" />
      </Parameters>
      <Docs>
        <param name="uri">When this method returns, contains the URI representation of the connection if the conversion succeeded; otherwise, null.</param>
        <summary>
            Tries to convert the connection locator to a URI.
            </summary>
        <returns>
          <c>true</c> if the conversion was successful; otherwise, <c>false</c>.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>