Class FailedRequestDetail

Detail to return to a user when a controller action fails.

Inheritance

System.Object

FailedRequestDetail

Namespace: Microsoft.XboxStudios.SQTech.Roster

Assembly: Microsoft.GNS.Roster.Common.dll

Syntax

public class FailedRequestDetail : object

Fields

Empty

Empty FailedRequestDetail.

Declaration

public static readonly FailedRequestDetail Empty

Field Value

Type	Description
FailedRequestDetail

Properties

AdditionalInfo

Gets additional information to share about the failure.

Declaration

public Dictionary<string, string> AdditionalInfo { get; }

Property Value

Type	Description
Dictionary<System.String, System.String>

AuthenticationType

Gets or sets the type of authentication used by the UserPrincipal.

Declaration

public string AuthenticationType { get; set; }

Property Value

Type	Description
System.String

Environment

Gets or sets the environment in which the failure occurred.

Declaration

public string Environment { get; set; }

Property Value

Type	Description
System.String

ExceptionDetail

Gets or sets the exception raised that caused the failure.

Declaration

public string ExceptionDetail { get; set; }

Property Value

Type	Description
System.String

Reason

Gets or sets the reason from the Roster server.

Declaration

public ResponseReason Reason { get; set; }

Property Value

Type	Description
ResponseReason

TrackingId

Gets or sets a unique ID for a failure. This is required for DiagnosticMessage() to function.

Declaration

public Guid TrackingId { get; set; }

Property Value

Type	Description
Guid

UserPrincipal

Gets or sets the user email formatted principal name that triggered the failure.

Declaration

public string UserPrincipal { get; set; }

Property Value

Type	Description
System.String

Methods

DiagnosticMessage()

Generates a diagnostic message if TrackingId is set.

Declaration

public string DiagnosticMessage()

Returns

Type	Description
System.String	A diagnostic message string.

IsValid()

Determines if the object has basic properties.

Declaration

public bool IsValid()

Returns

Type	Description
System.Boolean	True if valid. Otherwise, false.