Actions

Actions

Source:
Properties:
Name Type Description
Connect Actions~Connect
Disconnect Actions~Disconnect
Scheduled Actions~Scheduled

Actions are the default objects and fields expected by the Reducer function.

Members

(static) Connect

Source:

Connect is dispatched when a Plugin makes a successful socket connection.

(static) Disconnect

Source:

Disconnect is dispatched when a Plugin disconnects from the server.

(static) Scheduled

Source:

Scheduled is dispatched in pairs when a Plugin has an onscheduled call. The first dispatch will have scheduled=timeout-in-milliseconds indicating when Socket.connect() will next be attempted. The second dispatch will have scheduled=0 indicating Socket.connect() is no longer scheduled.

(static) Types :Object

Source:
Properties:
Name Type Description
Connect string

The Connect action string.
Disconnect string

The Disconnect action string.
Scheduled string

The Scheduled action string.

Types are the strings for action.type when using a reducer.

Type:
  • Object

Type Definitions

Connect

Source:
Properties:
Name Type Description
type string
socket Socket

The Socket that connected.

Connect is dispatched when a Plugin makes a successful socket connection.

Type:
  • Object

Disconnect

Source:
Properties:
Name Type Description
type string
socket Socket

The Socket that disconnected.

Disconnect is dispatched when a Plugin disconnects from the server.

Type:
  • Object

Scheduled

Source:
Properties:
Name Type Description
type string
socket Socket

The Socket that scheduled.
scheduled number

The timeout in milliseconds for the `Socket.connect(). reschedule.

Scheduled is dispatched in pairs when a Plugin has an onscheduled call. The first dispatch will have scheduled=timeout-in-milliseconds indicating when Socket.connect() will next be attempted. The second dispatch will have scheduled=0 indicating Socket.connect() is no longer scheduled.

Type:
  • Object