Class CurrencyItemResponse

CurrencyItemResponse

Inheritance

object

CurrencyItemResponse

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.Apis.Admin.Economy

Assembly: Unity.Services.Apis.dll

Syntax

[DataContract(Name = "currency-item-response")]
[Preserve]
public class CurrencyItemResponse

Constructors

CurrencyItemResponse(string, string, TypeEnum, int, int, object, ModifiedMetadata, ModifiedMetadata)

Initializes a new instance of the CurrencyItemResponse class.

Declaration

[Preserve]
public CurrencyItemResponse(string id = null, string name = null, CurrencyItemResponse.TypeEnum type = (CurrencyItemResponse.TypeEnum)0, int initial = 0, int max = 0, object customData = null, ModifiedMetadata created = null, ModifiedMetadata modified = null)

Parameters

Type	Name	Description
string	id	ID of the item. (required).
string	name	A descriptive name for the item. (required).
CurrencyItemResponse.TypeEnum	type	type (required).
int	initial	The initial amount of currency that a player is credited with upon first interaction. When `max` is used, `initial` must be less than `max`. (required).
int	max	The maximum currency balance that a player can have. Calls that would result in the maximum being exceeded return an error. (required).
object	customData	Max size when serialised 5 kilobits. (required).
ModifiedMetadata	created	created (required).
ModifiedMetadata	modified	modified (required).

Properties

Created

Gets or Sets Created

Declaration

[DataMember(Name = "created", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public ModifiedMetadata Created { get; set; }

Property Value

Type	Description
ModifiedMetadata

CustomData

Max size when serialised 5 kilobits.

Declaration

[DataMember(Name = "customData", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public object CustomData { get; set; }

Property Value

Type	Description
object	Max size when serialised 5 kilobits.

Id

ID of the item.

Declaration

[DataMember(Name = "id", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public string Id { get; set; }

Property Value

Type	Description
string	ID of the item.

Initial

The initial amount of currency that a player is credited with upon first interaction. When max is used, initial must be less than max.

Declaration

[DataMember(Name = "initial", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public int Initial { get; set; }

Property Value

Type	Description
int	The initial amount of currency that a player is credited with upon first interaction. When `max` is used, `initial` must be less than `max`.

Max

The maximum currency balance that a player can have. Calls that would result in the maximum being exceeded return an error.

Declaration

[DataMember(Name = "max", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public int Max { get; set; }

Property Value

Type	Description
int	The maximum currency balance that a player can have. Calls that would result in the maximum being exceeded return an error.

Modified

Gets or Sets Modified

Declaration

[DataMember(Name = "modified", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public ModifiedMetadata Modified { get; set; }

Property Value

Type	Description
ModifiedMetadata

Name

A descriptive name for the item.

Declaration

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

Property Value

Type	Description
string	A descriptive name for the item.

Type

Gets or Sets Type

Declaration

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

Property Value

Type	Description
CurrencyItemResponse.TypeEnum