Class DataStorageElement
- Namespace
- Archipelago.MultiClient.Net.Models
- Assembly
- Archipelago.MultiClient.Net.dll
An entry in the DataStorage
public class DataStorageElement
- Inheritance
-
DataStorageElement
- Inherited Members
Methods
GetAsync(Action<JToken>)
Retrieves the value of a certain key from server side data storage.
public void GetAsync(Action<JToken> callback)
Parameters
callbackAction<JToken>The callback that will be called when the value is retrieved
GetAsync<T>(Action<T>)
Retrieves the value of a certain key from server side data storage.
public void GetAsync<T>(Action<T> callback)
Parameters
callbackAction<T>The callback that will be called when the value is retrieved
Type Parameters
T
Initialize(JToken)
Initializes a value in the server side data storage Will not override any existing value, only set the default value if none existed
public void Initialize(JToken value)
Parameters
valueJTokenThe default value for the key
Initialize(IEnumerable)
Initializes a value in the server side data storage Will not override any existing value, only set the default value if none existed
public void Initialize(IEnumerable value)
Parameters
valueIEnumerableThe default value for the key
ToString()
Returns a string that represents the current object.
public override string ToString()
Returns
- string
A string that represents the current object.
To<T>()
Retrieves the value from the server and casts it to the given type Cannot be used in combination with other operators
public T To<T>()
Returns
- T
The value from server as the given type
Type Parameters
T
Exceptions
- InvalidOperationException
DataStorageElement.To() cannot be used together with other operations on the DataStorageElement Other operations include =, +=, /=, + etc
- ArchipelagoSocketClosedException
The websocket connection is not alive
Events
OnValueChanged
Event handler will be called when the server side value for this key changes
public event DataStorageHelper.DataStorageUpdatedHandler OnValueChanged
Event Type
Operators
operator +(DataStorageElement, AdditionalArgument)
public static DataStorageElement operator +(DataStorageElement a, AdditionalArgument arg)
Parameters
Returns
operator +(DataStorageElement, Callback)
public static DataStorageElement operator +(DataStorageElement a, Callback c)
Parameters
Returns
operator +(DataStorageElement, OperationSpecification)
public static DataStorageElement operator +(DataStorageElement a, OperationSpecification s)
Parameters
Returns
operator +(DataStorageElement, JToken)
public static DataStorageElement operator +(DataStorageElement a, JToken b)
Parameters
aDataStorageElementbJToken
Returns
operator +(DataStorageElement, IEnumerable)
public static DataStorageElement operator +(DataStorageElement a, IEnumerable b)
Parameters
Returns
operator +(DataStorageElement, decimal)
public static DataStorageElement operator +(DataStorageElement a, decimal b)
Parameters
Returns
operator +(DataStorageElement, double)
public static DataStorageElement operator +(DataStorageElement a, double b)
Parameters
Returns
operator +(DataStorageElement, int)
public static DataStorageElement operator +(DataStorageElement a, int b)
Parameters
Returns
operator +(DataStorageElement, long)
public static DataStorageElement operator +(DataStorageElement a, long b)
Parameters
Returns
operator +(DataStorageElement, float)
public static DataStorageElement operator +(DataStorageElement a, float b)
Parameters
Returns
operator +(DataStorageElement, string)
public static DataStorageElement operator +(DataStorageElement a, string b)
Parameters
Returns
operator --(DataStorageElement)
public static DataStorageElement operator --(DataStorageElement a)
Parameters
Returns
operator /(DataStorageElement, decimal)
public static DataStorageElement operator /(DataStorageElement a, decimal b)
Parameters
Returns
operator /(DataStorageElement, double)
public static DataStorageElement operator /(DataStorageElement a, double b)
Parameters
Returns
operator /(DataStorageElement, int)
public static DataStorageElement operator /(DataStorageElement a, int b)
Parameters
Returns
operator /(DataStorageElement, long)
public static DataStorageElement operator /(DataStorageElement a, long b)
Parameters
Returns
operator /(DataStorageElement, float)
public static DataStorageElement operator /(DataStorageElement a, float b)
Parameters
Returns
operator ^(DataStorageElement, decimal)
public static DataStorageElement operator ^(DataStorageElement a, decimal b)
Parameters
Returns
operator ^(DataStorageElement, double)
public static DataStorageElement operator ^(DataStorageElement a, double b)
Parameters
Returns
operator ^(DataStorageElement, int)
public static DataStorageElement operator ^(DataStorageElement a, int b)
Parameters
Returns
operator ^(DataStorageElement, long)
public static DataStorageElement operator ^(DataStorageElement a, long b)
Parameters
Returns
operator ^(DataStorageElement, float)
public static DataStorageElement operator ^(DataStorageElement a, float b)
Parameters
Returns
implicit operator JArray(DataStorageElement)
public static implicit operator JArray(DataStorageElement e)
Parameters
Returns
- JArray
implicit operator JToken(DataStorageElement)
public static implicit operator JToken(DataStorageElement e)
Parameters
Returns
- JToken
implicit operator Array(DataStorageElement)
public static implicit operator Array(DataStorageElement e)
Parameters
Returns
implicit operator bool(DataStorageElement)
public static implicit operator bool(DataStorageElement e)
Parameters
Returns
implicit operator bool[](DataStorageElement)
public static implicit operator bool[](DataStorageElement e)
Parameters
Returns
- bool[]
implicit operator List<bool>(DataStorageElement)
public static implicit operator List<bool>(DataStorageElement e)
Parameters
Returns
implicit operator List<decimal>(DataStorageElement)
public static implicit operator List<decimal>(DataStorageElement e)
Parameters
Returns
implicit operator List<double>(DataStorageElement)
public static implicit operator List<double>(DataStorageElement e)
Parameters
Returns
implicit operator List<int>(DataStorageElement)
public static implicit operator List<int>(DataStorageElement e)
Parameters
Returns
implicit operator List<long>(DataStorageElement)
public static implicit operator List<long>(DataStorageElement e)
Parameters
Returns
implicit operator List<object>(DataStorageElement)
public static implicit operator List<object>(DataStorageElement e)
Parameters
Returns
implicit operator List<float>(DataStorageElement)
public static implicit operator List<float>(DataStorageElement e)
Parameters
Returns
implicit operator List<string>(DataStorageElement)
public static implicit operator List<string>(DataStorageElement e)
Parameters
Returns
implicit operator decimal(DataStorageElement)
public static implicit operator decimal(DataStorageElement e)
Parameters
Returns
implicit operator decimal[](DataStorageElement)
public static implicit operator decimal[](DataStorageElement e)
Parameters
Returns
- decimal[]
implicit operator double(DataStorageElement)
public static implicit operator double(DataStorageElement e)
Parameters
Returns
implicit operator double[](DataStorageElement)
public static implicit operator double[](DataStorageElement e)
Parameters
Returns
- double[]
implicit operator int(DataStorageElement)
public static implicit operator int(DataStorageElement e)
Parameters
Returns
implicit operator int[](DataStorageElement)
public static implicit operator int[](DataStorageElement e)
Parameters
Returns
- int[]
implicit operator long(DataStorageElement)
public static implicit operator long(DataStorageElement e)
Parameters
Returns
implicit operator long[](DataStorageElement)
public static implicit operator long[](DataStorageElement e)
Parameters
Returns
- long[]
implicit operator bool?(DataStorageElement)
public static implicit operator bool?(DataStorageElement e)
Parameters
Returns
- bool?
implicit operator decimal?(DataStorageElement)
public static implicit operator decimal?(DataStorageElement e)
Parameters
Returns
implicit operator double?(DataStorageElement)
public static implicit operator double?(DataStorageElement e)
Parameters
Returns
implicit operator int?(DataStorageElement)
public static implicit operator int?(DataStorageElement e)
Parameters
Returns
- int?
implicit operator long?(DataStorageElement)
public static implicit operator long?(DataStorageElement e)
Parameters
Returns
- long?
implicit operator float?(DataStorageElement)
public static implicit operator float?(DataStorageElement e)
Parameters
Returns
implicit operator object[](DataStorageElement)
public static implicit operator object[](DataStorageElement e)
Parameters
Returns
- object[]
implicit operator float(DataStorageElement)
public static implicit operator float(DataStorageElement e)
Parameters
Returns
implicit operator float[](DataStorageElement)
public static implicit operator float[](DataStorageElement e)
Parameters
Returns
- float[]
implicit operator string(DataStorageElement)
public static implicit operator string(DataStorageElement e)
Parameters
Returns
implicit operator string[](DataStorageElement)
public static implicit operator string[](DataStorageElement e)
Parameters
Returns
- string[]
implicit operator DataStorageElement(JToken)
public static implicit operator DataStorageElement(JToken o)
Parameters
oJToken
Returns
implicit operator DataStorageElement(Array)
public static implicit operator DataStorageElement(Array a)
Parameters
aArray
Returns
implicit operator DataStorageElement(bool)
public static implicit operator DataStorageElement(bool b)
Parameters
bbool
Returns
implicit operator DataStorageElement(List<bool>)
public static implicit operator DataStorageElement(List<bool> l)
Parameters
Returns
implicit operator DataStorageElement(List<decimal>)
public static implicit operator DataStorageElement(List<decimal> l)
Parameters
Returns
implicit operator DataStorageElement(List<double>)
public static implicit operator DataStorageElement(List<double> l)
Parameters
Returns
implicit operator DataStorageElement(List<int>)
public static implicit operator DataStorageElement(List<int> l)
Parameters
Returns
implicit operator DataStorageElement(List<long>)
public static implicit operator DataStorageElement(List<long> l)
Parameters
Returns
implicit operator DataStorageElement(List<object>)
public static implicit operator DataStorageElement(List<object> l)
Parameters
Returns
implicit operator DataStorageElement(List<float>)
public static implicit operator DataStorageElement(List<float> l)
Parameters
Returns
implicit operator DataStorageElement(List<string>)
public static implicit operator DataStorageElement(List<string> l)
Parameters
Returns
implicit operator DataStorageElement(decimal)
public static implicit operator DataStorageElement(decimal m)
Parameters
mdecimal
Returns
implicit operator DataStorageElement(double)
public static implicit operator DataStorageElement(double d)
Parameters
ddouble
Returns
implicit operator DataStorageElement(int)
public static implicit operator DataStorageElement(int i)
Parameters
iint
Returns
implicit operator DataStorageElement(long)
public static implicit operator DataStorageElement(long l)
Parameters
llong
Returns
implicit operator DataStorageElement(float)
public static implicit operator DataStorageElement(float f)
Parameters
ffloat
Returns
implicit operator DataStorageElement(string)
public static implicit operator DataStorageElement(string s)
Parameters
sstring
Returns
operator ++(DataStorageElement)
public static DataStorageElement operator ++(DataStorageElement a)
Parameters
Returns
operator %(DataStorageElement, decimal)
public static DataStorageElement operator %(DataStorageElement a, decimal b)
Parameters
Returns
operator %(DataStorageElement, double)
public static DataStorageElement operator %(DataStorageElement a, double b)
Parameters
Returns
operator %(DataStorageElement, int)
public static DataStorageElement operator %(DataStorageElement a, int b)
Parameters
Returns
operator %(DataStorageElement, long)
public static DataStorageElement operator %(DataStorageElement a, long b)
Parameters
Returns
operator %(DataStorageElement, float)
public static DataStorageElement operator %(DataStorageElement a, float b)
Parameters
Returns
operator *(DataStorageElement, decimal)
public static DataStorageElement operator *(DataStorageElement a, decimal b)
Parameters
Returns
operator *(DataStorageElement, double)
public static DataStorageElement operator *(DataStorageElement a, double b)
Parameters
Returns
operator *(DataStorageElement, int)
public static DataStorageElement operator *(DataStorageElement a, int b)
Parameters
Returns
operator *(DataStorageElement, long)
public static DataStorageElement operator *(DataStorageElement a, long b)
Parameters
Returns
operator *(DataStorageElement, float)
public static DataStorageElement operator *(DataStorageElement a, float b)
Parameters
Returns
operator -(DataStorageElement, decimal)
public static DataStorageElement operator -(DataStorageElement a, decimal b)
Parameters
Returns
operator -(DataStorageElement, double)
public static DataStorageElement operator -(DataStorageElement a, double b)
Parameters
Returns
operator -(DataStorageElement, int)
public static DataStorageElement operator -(DataStorageElement a, int b)
Parameters
Returns
operator -(DataStorageElement, long)
public static DataStorageElement operator -(DataStorageElement a, long b)
Parameters
Returns
operator -(DataStorageElement, float)
public static DataStorageElement operator -(DataStorageElement a, float b)