equo-comm

Classes

EquoComm

== Objects

EquoCommService : object

Comm API for usage within the Equo Framework.

This document specifies the usage methods for equo-comm.

Functions

create()EquoService.<EquoComm>

Creates an EquoCommService instance.

get()EquoComm

Obtains existing EquoComm service instance or else create a new one.

EquoComm

Kind: global class

equoComm.send(actionId, [payload], [args]) ⇒ void

Sends an action to execute in Framework.

Kind: instance method of EquoComm

Param Type Description

actionId

string

[payload]

Payload

Optional

[args]

Args

Extra framework arguments - Optional

equoComm.on(userEventId, callback) ⇒ void

Listens for an event with the given name.

Kind: instance method of EquoComm

Param Type

userEventId

string

callback

UserEventCallback

equoComm.call(userEvent) ⇒ Promise.<(T\|void)>

Sends a user event to the Framework. Returns a promise that resolves with the response’s payload as argument.

Kind: instance method of EquoComm

Param

userEvent

EquoCommService : object

Comm API for usage within the Equo Framework.

This document specifies the usage methods for equo-comm.

Kind: global namespace

create() ⇒ EquoService.<EquoComm>

Creates an EquoCommService instance.

Kind: global function

get() ⇒ EquoComm

Obtains existing EquoComm service instance or else create a new one.

Kind: global function