View on GitHub
Structures Reference
Structures
The following structures are available globally.
-
Information about the populate call in the cache
This is issued in a few situations:
- To initially populate the cache value for the first to-the-cache subscription
- To update the value when reconnecting after having been disconnected
- When a subscribe handler says that it needs to re-execute the populate to get a newer value
Declaration
Swift
public struct HACachePopulateInfo<OutgoingType> -
Information about the subscriptions used to keep the cache up-to-date
See moreDeclaration
Swift
public struct HACacheSubscribeInfo<OutgoingType> -
Information about a state change which needs transform
See moreDeclaration
Swift
public struct HACacheTransformInfo<IncomingType, OutgoingType> -
Cached version of all entity states
See moreDeclaration
Swift
public struct HACachedStates -
A request which has a strongly-typed response format
See moreDeclaration
Swift
public struct HATypedRequest<ResponseType> where ResponseType : HADataDecodable -
The current user
See moreDeclaration
Swift
public struct HAResponseCurrentUser : HADataDecodable -
A subscription request which has a strongly-typed handler
See moreDeclaration
Swift
public struct HATypedSubscription<ResponseType> where ResponseType : HADataDecodable -
The type of the event
See moreDeclaration
Swift
public struct HAEventType : RawRepresentable, Hashable, ExpressibleByStringLiteral, ExpressibleByNilLiteral -
An event fired on the event bus
See moreDeclaration
Swift
public struct HAResponseEvent : HADataDecodable -
Template rendered event
See moreDeclaration
Swift
public struct HAResponseRenderTemplate : HADataDecodable -
A service definition
See moreDeclaration
Swift
public struct HAServiceDefinition -
The services available
See moreDeclaration
Swift
public struct HAResponseServices : HADataDecodable -
State changed event
See moreDeclaration
Swift
public struct HAResponseEventStateChanged : HADataDecodable -
Undocumented
See moreDeclaration
Swift
public struct HACompressedStatesUpdates : HADataDecodable -
Undocumented
See moreDeclaration
Swift
public struct HACompressedEntityState : HADataDecodable -
Undocumented
See moreDeclaration
Swift
public struct HACompressedEntityStateRemove : HADataDecodable -
Undocumented
See moreDeclaration
Swift
public struct HACompressedEntityDiff : HADataDecodable -
An entity in Home Assistant
See moreDeclaration
Swift
public struct HAEntity : HADataDecodable, Hashable -
The attributes of the entity’s state
See moreDeclaration
Swift
public struct HAEntityAttributes -
Entity attributes for Zones
See moreDeclaration
Swift
public struct HAEntityAttributesZone : HADataDecodable -
Declaration
Swift
public struct HAServicesDomain : RawRepresentable, Hashable, ExpressibleByStringLiteral -
The service itself in a service call
Many services can be used on multiple domains, but you should consult the full results to see which are available.
For example,
See moreturn_oninlight.turn_onis the service.Declaration
Swift
public struct HAServicesService : RawRepresentable, Hashable, ExpressibleByStringLiteral -
Configuration of the connection
See moreDeclaration
Swift
public struct HAConnectionConfiguration -
Information for connecting to the server
See moreDeclaration
Swift
public struct HAConnectionInfo : Equatable -
Undocumented
See moreDeclaration
Swift
public struct HAHTTPMethod : RawRepresentable, Hashable, ExpressibleByStringLiteral -
A request, with data, to be issued
See moreDeclaration
Swift
public struct HARequest -
Type representing a response type that we do not care about
Think of this like
Void– you don’t care about it.See moreTodo
can we somehow get Void to work with the type system? it can’t conform to decodable itself :/Declaration
Swift
public struct HAResponseVoid : HADataDecodable -
Write audio data to websocket, sttBinaryHandlerId is provided by run-start in Assist pipeline
See moreDeclaration
Swift
public struct HASttHandlerId : Hashable