Class ErrorStatus

The body that will be returned for any failing request. We are using the RFC 7807 Error Format.

Inheritance

object

ErrorStatus

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.Lobbies.Models

Assembly: Unity.Services.Multiplayer.dll

Syntax

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

Constructors

ErrorStatus(string, int, string, string, int, List<Detail>)

The body that will be returned for any failing request. We are using the RFC 7807 Error Format.

Declaration

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

Parameters

Type	Name	Description
string	type	A URI that identifies the problem type and should provide documentation for the problem.
int	status	The HTTP status code of the response.
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.
string	detail	A human-readable explanation specific to this occurrence of the problem.
int	code	An integer in the range 16000-16999 that uniquely identifies an error type. This can be used to programatically identify the type of error.
List<Detail>	details	A list of additional details about specific errors.

Properties

Code

An integer in the range 16000-16999 that uniquely identifies an error type. This can be used to programatically identify the type of error.

Declaration

[Preserve]
[DataMember(Name = "code", EmitDefaultValue = false)]
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", EmitDefaultValue = false)]
public string Detail { get; }

Property Value

Type	Description
string

Details

A list of additional details about specific errors.

Declaration

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

Property Value

Type	Description
List<Detail>

Status

The HTTP status code of the response.

Declaration

[Preserve]
[DataMember(Name = "status", EmitDefaultValue = false)]
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.

Declaration

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

Property Value

Type	Description
string

Type

A URI that identifies the problem type and should provide documentation for the problem.

Declaration

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

Property Value

Type	Description
string