Class CurrencyItemRequest
CurrencyItemRequest
Inherited Members
Namespace: Unity.Services.Apis.Admin.Economy
Assembly: Unity.Services.Apis.dll
Syntax
[DataContract(Name = "currency-item-request")]
[Preserve]
public class CurrencyItemRequest
Constructors
CurrencyItemRequest(string, string, TypeEnum, decimal, decimal, object)
Initializes a new instance of the Currency
Declaration
[Preserve]
public CurrencyItemRequest(string id = null, string name = null, CurrencyItemRequest.TypeEnum type = (CurrencyItemRequest.TypeEnum)0, decimal initial = 0, decimal max = 0, object customData = null)
Parameters
Type | Name | Description |
---|---|---|
string | id | ID of the item. (required). |
string | name | A descriptive name for the item. (required). |
Currency |
type | type (required). |
decimal | initial | The initial amount of currency that a player is credited upon first interaction. When |
decimal | max | The maximum currency balance that a player can have. Calls that would result in the maximum being exceeded return an error.. |
object | customData | Max size when serialized 5 kilobits.. |
Properties
CustomData
Max size when serialized 5 kilobits.
Declaration
[DataMember(Name = "customData", EmitDefaultValue = true)]
[Preserve]
public object CustomData { get; set; }
Property Value
Type | Description |
---|---|
object | Max size when serialized 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 upon first interaction. When max
is used, initial
must be less than max
.
Declaration
[DataMember(Name = "initial", EmitDefaultValue = false)]
[Preserve]
public decimal Initial { get; set; }
Property Value
Type | Description |
---|---|
decimal | The initial amount of currency that a player is credited upon first interaction. When |
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", EmitDefaultValue = false)]
[Preserve]
public decimal Max { get; set; }
Property Value
Type | Description |
---|---|
decimal | The maximum currency balance that a player can have. Calls that would result in the maximum being exceeded return an error. |
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 CurrencyItemRequest.TypeEnum Type { get; set; }
Property Value
Type | Description |
---|---|
Currency |