Class LocalizationBucket.ResponseBodyDto<T>

If Items is not null or empty, it means that the request was successful.

Failed requests should return the correct HTTP status code, but (if applicable) still return one or more errors inside Errors.

Inheritance
System.Object
LocalizationBucket.ResponseBodyDto<T>
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: GlitchedPolygons.Localization
Assembly: UnityGlitchedLocaleClientDocs.dll
Syntax
protected sealed class ResponseBodyDto<T>
Type Parameters
Name Description
T

Constructors

| Improve this Doc View Source

ResponseBodyDto()

Parameterless ctor.

Declaration
public ResponseBodyDto()
| Improve this Doc View Source

ResponseBodyDto(LocalizationBucket.Error[])

Spawn an error response.

Declaration
public ResponseBodyDto(params LocalizationBucket.Error[] errors)
Parameters
Type Name Description
LocalizationBucket.Error[] errors

One or more errors.
See Also

Properties

| Improve this Doc View Source

Count

The total amount of items potentially available to fetch.

Declaration
public long Count { get; set; }
Property Value
Type Description
System.Int64
| Improve this Doc View Source

Errors

If the request failed, one or potentially more errors CAN be written into this array for the client to handle.

Declaration
public LocalizationBucket.Error[] Errors { get; set; }
Property Value
Type Description
LocalizationBucket.Error[]
| Improve this Doc View Source

Items

This and Errors are mutually exclusive: if this is set, Errors should be null and vice-versa!

This can be null if the request succeeded and there are no items to return.

Declaration
public T[] Items { get; set; }
Property Value
Type Description
T[]
| Improve this Doc View Source

Type

The type of the items returned. Can be null if the request was successful but nothing's returned (e.g. a status 201).

Declaration
public string Type { get; set; }
Property Value
Type Description
System.String