Class: Connection

Help4.engine.ur.Connection()

Connection handling for UR harmonization

Constructor

new Connection()

Source:

Members

(readonly) APP_TYPE :string

Which app is currently running in FLP
Type:
  • string
Source:

COMPONENT_NAME :string

UI5 component name
Type:
  • string
Source:

(readonly) LOG_LEVEL :number

Logging levels, matching those in UI5
Type:
  • number
Source:

Methods

(static) connect(engine)

Connect; sending start message to frame will repeat until update message is received and connection is confirmed
Parameters:
Name Type Description
engine Help4.engine.ur.UrHarmonizationEngine
Source:

(static) disconnect(engine)

Disconnect; sending stop message to frame
Parameters:
Name Type Description
engine Help4.engine.ur.UrHarmonizationEngine
Source:

(static) getTargetOrigin(engine) → {string}

try to limit the number of windows we send our messages to by finding the app frame origin
Parameters:
Name Type Description
engine Help4.engine.ur.UrHarmonizationEngine
Source:
Returns:
Type
string

(static) getUI5AppType(engine) → (nullable) {string}

determine the type of app currently running, this does not return UI5 for the main shell, when no app is open
Parameters:
Name Type Description
engine Help4.engine.ur.UrHarmonizationEngine
Source:
Returns:
Type
string

(static) messageAppFrame(engine, service, isAssignModeopt, nullable, startMessageopt, nullable)

Post a message to the app frame
Parameters:
Name Type Attributes Description
engine Help4.engine.ur.UrHarmonizationEngine
service string
isAssignMode boolean <optional>
<nullable>
startMessage boolean <optional>
<nullable>
Source:

(static) onMessage(engine, event)

Handle UR message events
Parameters:
Name Type Description
engine Help4.engine.ur.UrHarmonizationEngine
event Object
Properties
Name Type Description
data string message data
source Window of the event
Source: