The specifics of this connection
The specifics of this connection will calls create methods in the constructor. This property will exist for backward compatibility. If you want to construct connection and call create methods within async, you can use await Actionhero.Connection.createAsync(details) for construction.
Can this connection use the chat system?
The timestamp of when this connection was created
OptionalerrorIf there's a local error
OptionalextensionIf there's a local extension to the request
A unique string identifer for this connection, but common among subsequent requests. For example, all web requests from the same client have the same fingerprint, but not the same id
A unique string identifer for this connection.
OptionalmatchedThe Id of the latest message this connection has sent to the server.
Optionalmessagesfor specHelper
Any params this connection has saved for use in subsequent Actions.
How many actions are currently running for this connection? Most server types have a limit
OptionalpipeAny connection-specific properties. For, example, the HTTP res and req objects for web connections are here
The remote connection's IP address (as best as we can tell). May be either IPv4 or IPv6.
The remote connection's port. Related to connection.remoteIP
Optionalresponsestorage for a response payload
Any rooms this connection is a member of, it it can chat
Optionalsessionstorage for session data
OptionalsetOptionalsetHow many actions has this connection run since it connected.
The type of this connection (web, websocket, etc) as defined by the name of the server which created it
Destroys the connection. If the type/sever of the connection has a goodbye message, it will be sent. The connection will be removed from all rooms. The connection's socket will be closed when possible.
Send a file to a connection (usually in the context of an Action). Be sure to set data.toRender = false in the action!
Uses Server#processFile and will set connection.params.file = path
Send a message to a connection. Uses Server#sendMessage.
Optionalverb: stringTry to run a verb command for a connection
StaticcreateThe specifics of this connection
The generic representation of a connection for all server types is an Actionhero.Connection. You will never be creating these yourself via an action or task, but you will find them in your Actions and Action Middleware.