Class ErrorResponseBody

ErrorResponseBody model

Inheritance

object

ErrorResponseBody

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.Relay.Models

Assembly: Unity.Services.Multiplayer.dll

Syntax

[Preserve]
[DataContract(Name = "ErrorResponseBody")]
public class ErrorResponseBody

Constructors

ErrorResponseBody(int, string, string, string, int, List<KeyValuePair>)

Creates an instance of ErrorResponseBody.

Declaration

[Preserve]
public ErrorResponseBody(int status, string detail, string title, string type, int code, List<KeyValuePair> details = null)

Parameters

Type	Name	Description
int	status	The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
string	detail	A human-readable explanation specific to this occurrence of the problem.
string	title	A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
string	type	A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank".
int	code	A service-specific error code.
List<KeyValuePair>	details	An array of machine-readable service-specific errors.

Properties

Code

A service-specific error code.

Declaration

[Preserve]
[DataMember(Name = "code", IsRequired = true, EmitDefaultValue = true)]
public int Code { get; }

Property Value

Type	Description
int

Detail

A human-readable explanation specific to this occurrence of the problem.

Declaration

[Preserve]
[DataMember(Name = "detail", IsRequired = true, EmitDefaultValue = true)]
public string Detail { get; }

Property Value

Type	Description
string

Details

An array of machine-readable service-specific errors.

Declaration

[Preserve]
[DataMember(Name = "details", EmitDefaultValue = false)]
public List<KeyValuePair> Details { get; }

Property Value

Type	Description
List<KeyValuePair>

Status

The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.

Declaration

[Preserve]
[DataMember(Name = "status", IsRequired = true, EmitDefaultValue = true)]
public int Status { get; }

Property Value

Type	Description
int

Title

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).

Declaration

[Preserve]
[DataMember(Name = "title", IsRequired = true, EmitDefaultValue = true)]
public string Title { get; }

Property Value

Type	Description
string

Type

A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank".

Declaration

[Preserve]
[DataMember(Name = "type", IsRequired = true, EmitDefaultValue = true)]
public string Type { get; }

Property Value

Type	Description
string