UserWise Unity SDK  3.0.0
Public Member Functions | List of all members
UserWiseSDK.Variables.Types.DateTimeVariable Class Reference

UserWise LiveOps in-game datetime variable. More...

Inheritance diagram for UserWiseSDK.Variables.Types.DateTimeVariable:
UserWiseSDK.Variables.Types.Variable< DateTime >

Public Member Functions

 DateTimeVariable (string name, DateTime defaultValue)
 
override object GetDefaultValue ()
 Getter access for a formatted variant of the DefaultValue. Overridden in some variable types. More...
 
override object GetValueForCache ()
 Overridable method used for retrieving the CurrentValue as a cacheable value. More...
 
override void UpdateValueFromAPI (object newValue)
 Attempts to update the CurrentValue with the provided, abstract, newValue through proper type conversion. More...
 
- Public Member Functions inherited from UserWiseSDK.Variables.Types.Variable< DateTime >
virtual string GetName ()
 Getter access for the Name field. More...
 
virtual void SetValueFromCache (object newValue)
 Acts as an overridable path for variable types that need to do different things during the set value from cache, that would not happen in UpdateValueFromAPI(object). More...
 
virtual void ResetToDefault ()
 Results the CurrentValue to the DefaultValue More...
 
GetCurrentOrDefaultValue ()
 Returns the CurrentValue, if present, otherwise returns the DefaultValue. More...
 
void SetCurrentValue (T newValue)
 Sets the CurrentValue to the provided newValue. Also emits the OnValueChange event. More...
 
string GetLowercaseVariableType ()
 Retrieves the Type (VariableType enum value) as a lowercase format string that the API-layer can ingest. More...
 

Additional Inherited Members

- Public Attributes inherited from UserWiseSDK.Variables.Types.Variable< DateTime >
readonly string Name
 
readonly T DefaultValue
 
- Properties inherited from UserWiseSDK.Variables.Types.Variable< DateTime >
CurrentValue [get, protected set]
 The current value of the Variable; in abstract typing. CurrentValue can be null, if there is no override. Generally, accessing the underlying value is done through GetCurrentOrDefaultValue(). More...
 
- Events inherited from UserWiseSDK.Variables.Types.Variable< DateTime >
EventHandler< OnValueChangeEventArgsOnValueChange
 

Detailed Description

UserWise LiveOps in-game datetime variable.

Data stored within this variable, and data transmitted to/from the UserWise servers are UTC-based.

Member Function Documentation

◆ GetDefaultValue()

override object UserWiseSDK.Variables.Types.DateTimeVariable.GetDefaultValue ( )
inlinevirtual

Getter access for a formatted variant of the DefaultValue. Overridden in some variable types.

Reimplemented from UserWiseSDK.Variables.Types.Variable< DateTime >.

◆ GetValueForCache()

override object UserWiseSDK.Variables.Types.DateTimeVariable.GetValueForCache ( )
inlinevirtual

Overridable method used for retrieving the CurrentValue as a cacheable value.

Returns

Reimplemented from UserWiseSDK.Variables.Types.Variable< DateTime >.

◆ UpdateValueFromAPI()

override void UserWiseSDK.Variables.Types.DateTimeVariable.UpdateValueFromAPI ( object  newValue)
inlinevirtual

Attempts to update the CurrentValue with the provided, abstract, newValue through proper type conversion.

Implements UserWiseSDK.Variables.Types.Variable< DateTime >.


The documentation for this class was generated from the following file: