Module: eventHandler

Members

inner,constantemitter

The event emitter singleton

Methods

innerapiError(operation, error)

infra/eventHandler/index.js, line 97

Emits a ApiError event with metadata:

{
  operation: string,
  error: string
}

Name	Type	Description
operation	string	The API operation that resulted in error
error	number

innerapiOutage(satelliteGatewayName, timestamp, source)

infra/eventHandler/index.js, line 114

Emits a ApiOutage event with metadata:

{
  satelliteGatewayName: string,
  timestamp: string,
  verbose: string
}

Name	Type	Description
satelliteGatewayName	string	The gateway name
timestamp	string	The ISO datetime of the outage
source	string	The API operation that was non-responsive

innerapiRecovery(satelliteGatewayName, timestamp, source)

infra/eventHandler/index.js, line 132

Emits a ApiRecovery event with metadata

{
  satelliteGatewayName: string,
  timestamp: string,
  verbose: string
}

Name	Type	Description
satelliteGatewayName	string	The gateway name
timestamp	string	The ISO datetime of the outage
source	string	The API operation that was non-responsive

innerforwardMessageStateChange(messageId, newState, reason, stateTimeUtc, mobileId)

infra/eventHandler/index.js, line 59

Emits a ForwardMessageStateChange event with metadata:

{
  messageId: number,
  mobileId: (string|undefined),
  newState: string,
  reason: string,
  verbose: string
}

mobileId may not be known if the message was submitted by another client; ideally other client submissions trigger a different event

Name	Type	Description
messageId	number	Unique forward message ID from the Status
newState	string	The new state human-readable
reason	string	The reason for the new state, human-readable
stateTimeUtc	string	The time of the state change
mobileId	string	optional The mobile ID if known

innernewForwardMessage(message)

infra/eventHandler/index.js, line 35

Emits a NewForwardMessage event with MessageForward model metadata:

Name	Type	Description
message	Object	Uses MessageForward model

innernewMobile(mobile)

infra/eventHandler/index.js, line 18

Emits a NewMobile event with Mobile model metadata.

Name	Type	Description
mobile	Object	Uses Mobile model

innernewReturnMessage(message)

infra/eventHandler/index.js, line 26

Emits a NewReturnMessage event with MessageReturn model metadata.

Name	Type	Description
message	Object	Uses MessageReturn model

innerotherClientForwardSubmission(messageId, mailboxId)

infra/eventHandler/index.js, line 80

Emits a OtherClientForwardSubmission event with metadata to be used for message retrieval:

{
  messageId: number,
  mailboxId: (number|string),
  verbose: string
}

Name	Type	Description
messageId	number	Unique forward message ID from the Status
mailboxId	string | number	Unique mailbox ID