ActionResponse

  • View Struct in FismoTypes.sol
  • View Class ActionResponse.js
  • The details of a successful State transition.
  • May include messages from Enter and/or Exit guard code.

Constructor

Signature 

constructor (
    machineName, 
    action, 
    priorStateName, 
    nextStateName,
    exitMessage, 
    enterMessage
)

Parameters

Name Description Type
machineName name of machine string
action name of action that triggered the transition string
priorStateName name of prior state string
nextStateName name of new state string
exitMessage response from the prior state’s exit guard string
enterMessage response from the new state’s enter guard string

Static Members

Methods

🦠 fromObject

Get a new ActionResponse instance from an object representation.

Signature 

ActionResponse.fromObject(o)

Parameters

Name Description Type
o the plain object object

Returns

Description Type
the instance ActionResponse

🦠 fromStruct

Get a new ActionResponse instance from a struct representation.

Signature 

ActionResponse.fromStruct(struct)

Parameters

Name Description Type
struct the struct Array

Returns

Description Type
the instance ActionResponse

Instance Members

Properties

  • machineName
  • action
  • priorStateName
  • nextStateName
  • exitMessage
  • enterMessage

Methods

🦠 toObject

Get a plain object representation of this ActionResponse instance.

Signature 

instance.toObject()

Returns

Description Type
the plain object object

🦠 toString

Get a string representation of this ActionResponse instance.

Signature 

instance.toString()

Returns

Description Type
the JSON representation string

🦠 toStruct

Get a struct representation of this ActionResponse instance.

Signature 

instance.toStruct()

Returns

Description Type
the struct Array

🦠 clone

Clone this ActionResponse instance.

Signature 

instance.clone()

Returns

Description Type
the instance ActionResponse

🦠 isValid

Is this ActionResponse instance valid?

Signature 

instance.isValid()

Returns

Description Type
true if the instance is valid boolean