Class APIProperty
Use this class to interact with the AntFarm Category Element Property.
The APIProperty class does not provide public constructors.
Please refer to:
// type as APIPropertyType, value as System.Object
APIProperty property = AntFarmAPI.NewProperty(yourClientId, "yourPropertyName", type, value);Inheritance
System.Object
APIProperty
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: AntFarm.API
Assembly: AntFarm.dll
Syntax
[Serializable]
public class APIPropertyProperties
Id
Declaration
public Guid Id { get; }Property Value
| Type | Description |
|---|---|
| System. |
Property id |
Name
Declaration
public string Name { get; }Property Value
| Type | Description |
|---|---|
| System. |
Property name |
Type
Declaration
public APIPropertyType Type { get; }Property Value
| Type | Description |
|---|---|
| APIProperty |
Property type (see APIProperty |
Value
Declaration
public object Value { get; }Property Value
| Type | Description |
|---|---|
| System. |
Methods
ChangeValue(Object)
Change the value of the property
Declaration
public void ChangeValue(object newValue)Parameters
| Type | Name | Description |
|---|---|---|
| System. |
newValue | New value to write to property |
TryGetValueString()
Get property value as string
Declaration
public string TryGetValueString()Returns
| Type | Description |
|---|---|
| System. |
If successful a string based on property value will be returned |
Exceptions
| Type | Condition |
|---|---|
| APIException | Check APIException |