/azure-docs-sdk-dotnet

Permalink
Switch branches/tags
Nothing to show
Find file
azure-docs-sdk-dotnet/xml/Microsoft.Azure.Graphs/GraphException.xml
Fetching contributors…
Cannot retrieve contributors at this time
Raw Blame History
195 lines (195 sloc) 9.17 KB
<Type Name="GraphException" FullName="Microsoft.Azure.Graphs.GraphException">
<TypeSignature Language="C#" Value="public class GraphException : Exception" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi serializable beforefieldinit GraphException extends System.Exception" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Graphs.GraphException" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Graphs</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Exception</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Base class for any graph library-focused exceptions
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public GraphException (Microsoft.Azure.Graphs.GraphException innerException, string message);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.Azure.Graphs.GraphException innerException, string message) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Graphs.GraphException.#ctor(Microsoft.Azure.Graphs.GraphException,System.String)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Graphs</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="innerException" Type="Microsoft.Azure.Graphs.GraphException" />
<Parameter Name="message" Type="System.String" />
</Parameters>
<Docs>
<param name="innerException"></param>
<param name="message"></param>
<summary>
Constructor. Use it for server side issues when an inner exception was caught and we need to wrap it.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public GraphException (Microsoft.Azure.Graphs.GraphStatusCode errorCode, string message);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Microsoft.Azure.Graphs.GraphStatusCode errorCode, string message) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Graphs.GraphException.#ctor(Microsoft.Azure.Graphs.GraphStatusCode,System.String)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Graphs</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="errorCode" Type="Microsoft.Azure.Graphs.GraphStatusCode" />
<Parameter Name="message" Type="System.String" />
</Parameters>
<Docs>
<param name="errorCode">error code, matches HTTP RFC 2616</param>
<param name="message"></param>
<summary>
Constructor. Use it when no inner (e.g. external) exception is available.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public GraphException (Microsoft.Azure.Graphs.GraphStatusCode errorCode, Exception innerException, string message);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Microsoft.Azure.Graphs.GraphStatusCode errorCode, class System.Exception innerException, string message) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Graphs.GraphException.#ctor(Microsoft.Azure.Graphs.GraphStatusCode,System.Exception,System.String)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Graphs</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="errorCode" Type="Microsoft.Azure.Graphs.GraphStatusCode" />
<Parameter Name="innerException" Type="System.Exception" />
<Parameter Name="message" Type="System.String" />
</Parameters>
<Docs>
<param name="errorCode">error code, matches HTTP RFC 2616</param>
<param name="innerException"></param>
<param name="message"></param>
<summary>
Constructor. Use it when an inner exception was caught and we need to wrap it.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Context">
<MemberSignature Language="C#" Value="public string Context { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Context" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Graphs.GraphException.Context" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Graphs</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Current external connection (or external execution context) name, as set by the caller
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ErrorCode">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Graphs.GraphStatusCode ErrorCode { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Graphs.GraphStatusCode ErrorCode" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Graphs.GraphException.ErrorCode" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Graphs</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Graphs.GraphStatusCode</ReturnType>
</ReturnValue>
<Docs>
<summary>
Error code associated with the exception.
Semantic for graph error codes is described in tinkerpop's provider documentation:
http://tinkerpop.apache.org/docs/current/dev/provider/#_graph_driver_provider_requirements
General detail regarding HTTP Error codes as described by RFC 2615:
http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Frame">
<MemberSignature Language="C#" Value="public string Frame { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Frame" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Graphs.GraphException.Frame" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Graphs</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Current logical frame (name of innermost execution scope)
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RequestId">
<MemberSignature Language="C#" Value="public Guid RequestId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Guid RequestId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Graphs.GraphException.RequestId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Graphs</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Guid</ReturnType>
</ReturnValue>
<Docs>
<summary>
Unique identifier (optionally provided by the client caller code) for the
request associated with the execution at the moment when the exception was created/thrown.
</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:Microsoft.Azure.Graphs.GraphException.ToString" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Graphs</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Converts an exception to a display string.
</summary>
<returns />
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>