Class: Migration

Help4.engine.ur.Migration()

Selector Migration handling for UR harmonization hotspots previously assigned in same-origin-iframe applications can be migrated in cross-origin-iframe applications or forced to be migrated using Help4.Feature.MigrateUrInSameOrigin - collect selectors to be migrated - send migration request and handle response from application - keep track of migrated selectors

Constructor

new Migration()

Source:

Methods

(static) addSelector(engine, selector) → {boolean}

Add a selector to the list of selectors to be migrated
Parameters:
Name Type Description
engine Help4.engine.ur.UrHarmonizationEngine
selector Help4.engine.ur.UrHarmonizationEngine.UrMigrationRequest
Source:
Returns:
- true if selector was added, false if it already existed
Type
boolean

(static) handleMigration(engine, migrated)

Update map of migrated selectors
Parameters:
Name Type Description
engine Help4.engine.ur.UrHarmonizationEngine
migrated Array.<Help4.engine.ur.UrHarmonizationEngine.UrMigrationResponse>
Source:

(async, static) requestSelectorMigration(engine)

Request migration of selectors previously recorded in this context / app frame The app is expected to send v2.fromSelector message containing either be hotspotIds, if the selector maps to an existing help element, or the current position of the element found using the selector.
Parameters:
Name Type Description
engine Help4.engine.ur.UrHarmonizationEngine
Source:

(static) selectorToUrHotspot(engine, selector) → (nullable) {Help4.engine.ur.UrHarmonizationEngine.UrMigrationResponse}

Parameters:
Name Type Description
engine Help4.engine.ur.UrHarmonizationEngine
selector Help4.engine.ur.UrHarmonizationEngine.UrMigrationRequest
Source:
Returns:
Type
Help4.engine.ur.UrHarmonizationEngine.UrMigrationResponse