Classes
- Aggregation
- AuthTokenStatus
- AuthTokenType
- DatumFilter
- GeneralMetadata
- InstructionState
- Location
- LocationPrecision
- Pagination
- SecurityPolicy
- SecurityPolicyBuilder
- SortDescriptor
Members
-
<inner, constant> Aggregations :module:domain~Aggregation
-
The enumeration of supported Aggregation values.
Type:
Properties:
Name Type Description Minute
module:domain~Aggregation minute
FiveMinute
module:domain~Aggregation 5 minutes
TenMinute
module:domain~Aggregation 10 minutes
FifeteenMinute
module:domain~Aggregation 15 minutes
ThirtyMinute
module:domain~Aggregation 30 minutes
Hour
module:domain~Aggregation an hour
HourOfDay
module:domain~Aggregation an hour of a day, e.g. 1-24
SeasonalHourOfDay
module:domain~Aggregation an hour of a day, further grouped into 4 seasons
Day
module:domain~Aggregation a day
DayOfWeek
module:domain~Aggregation a day of the week, e.g. Monday - Sunday
SeasonalDayOfWeek
module:domain~Aggregation a day of the week, further grouped into 4 seasons
Week
module:domain~Aggregation a week
WeekOfYear
module:domain~Aggregation the week within a year, e.g. 1 - 52
Month
module:domain~Aggregation a month
RunningTotal
module:domain~Aggregation a complete running total over a time span
-
<inner, constant> AuthTokenStatuses :module:domain~AuthTokenStatus
-
The enumeration of supported AuthTokenStatus values.
Type:
Properties:
Name Type Description Active
module:domain~AuthTokenStatus the token is active and usable
Disabled
module:domain~AuthTokenStatus the token is disabled and not usable
-
<inner, constant> AuthTokenTypes :module:domain~AuthTokenType
-
The enumeration of supported AuthTokenType values.
Type:
Properties:
Name Type Description ReadNodeData
module:domain~AuthTokenType a read-only token for reading SolarNode data
User
module:domain~AuthTokenType full access as the user that owns the token
-
<inner, constant> InstructionStates :module:domain~InstructionState
-
The enumeration of supported InstructionState values.
Type:
Properties:
Name Type Description Unknown
module:domain~InstructionState an unknown state
Queued
module:domain~InstructionState the instruction has been received by SolarNet but not yet delivered to its destination
Received
module:domain~InstructionState the instruction has been delivered to its destination but not yet acted upon
Executed
module:domain~InstructionState the instruction is currently being acted upon
Declined
module:domain~InstructionState the destination has declined to execute the instruction, or the execution failed
Completed
module:domain~InstructionState the destination has executed successfully
-
<inner, constant> LocationPrecisions :module:domain~LocationPrecision
-
The enumeration of supported LocationPrecision values.
Type:
Properties:
Name Type Description LatLong
module:domain~LocationPrecision GPS coordinates
Block
module:domain~LocationPrecision a city block
Street
module:domain~LocationPrecision a street
PostalCode
module:domain~LocationPrecision a postal code (or "zip code")
Locality
module:domain~LocationPrecision a town or city
StateOrProvince
module:domain~LocationPrecision a state or province
Region
module:domain~LocationPrecision a large region
TimeZone
module:domain~LocationPrecision a time zone
Country
module:domain~LocationPrecision a country
Methods
-
<inner> objectToStringMap(obj)
-
Convert a simple object into a
Map
instance.Property values that are themselves objects will be converted into
Map
instances as well.Parameters:
Name Type Description obj
object a simple object
- See:
-
module:domain~stringMapToObject
for the reverse conversion
Returns:
a Map with string keys; nested Map objects are also handled
- Type
- Map.<string, *>
-
<inner> stringMapToObject(strMap)
-
Convert a
Map
into a simple object.The keys are assumed to be strings. Values that are themselves
Map
instances will be converted to simple objects as well.Parameters:
Name Type Description strMap
Map.<string, *> a Map with string keys; nested Map objects are also handled
- See:
-
objectToStringMap
for the reverse conversion
Returns:
a simple object
- Type
- object