IHA Integration Framework

Module: modes/iha

This module manages IHA (iHealth Assist) Mode functionality.

Source:

Requires

  • module:common/view
  • module:modes/iha-services
  • module:managers/mappedin-manager
  • module:managers/timer-manager
  • module:managers/prsonas-manager
  • module:managers/connection-manager

Methods

init()

Initializes class

Source:

onModelReady()

Called when project.json is loaded

Source:
Fires:
  • event:initIha()
  • event:assignListeners()
  • event:initMappedIn()

initIha()

Sets up persistent page elements

Source:

assignListeners()

Assigns listeners to events used in this class.

Source:
Listens to Events:
  • event:EVENT_ADMIN_GOT_MANIFEST
  • event:EVENT_TEMPLATE_LOADED
  • event:EVENT_IHA_UPDATE_QR_CODE
  • event:EVENT_PAGE_IHA_SEARCH_LOCATION
  • event:EVENT_PAGE_IHA_SEARCH_LOCATION_STOP_ANIM
  • event:EVENT_IHA_LOCATION_CLICK
  • event:EVENT_PAGE_IHA_MAP
  • event:EVENT_PAGE_IHA_MAP_STOP_ANIM
  • event:EVENT_IHA_SEARCH_CLEAR
  • event:EVENT_IHA_PRESENTATION_HOME
  • event:EVENT_IHA_PRESENTATION_NEXT
  • event:EVENT_IHA_PRESENTATION_BACK
  • event:EVENT_PAGE_IHA_SEARCH_LOCATION_NAME
  • event:EVENT_IHA_RELOAD_BROWSER
  • avatar.eventTypes.event:"CC"
  • avatar.eventTypes.event:"END_CC"
  • event:UX qrBtn
  • event:UX searchInput

initMappedIn()

Initializes MappedIn

Source:

showSearchResults(locList, titleName)

Shows the search results based on a list of buttons and title to UX

Parameters:
Name Type Description
locList Array

List of buttons
titleName String

Title of search
Source:

findCategoriesAndLocations( [findId])

Gets MappedIn category(s) and location(s) based on an ID

Parameters:
Name Type Argument Default Description
findId String <optional>
 findloc

If an ID is provided then a target category or location will be defined. If not, then a list of all categories and locations will be provided.
Source:
Fires:
  • showSearchResults(results)

updateQrCode(url)

Updates the QR Code graphic

Parameters:
Name Type Description
url String

Url of the MappedIn WebApp
Source:

initPresentation(presData)

Initializes a presentation

Parameters:
Name Type Description
presData Object

Configuration data of the presentation
Source:
Fires:
  • event:showPresPage()
Example
{
      "pageCount": 10,
      "folder": "content/images/Pres1/",
      "filePrefix": "slide_",
      "pageConfig": {
          "slide_5": {
              "id": "m-string",
              "class": "slide5",
              "copy": "Just a reminder that this is slide 5"
          }
      }
  }

showPresPage()

Shows the current page of the presentation

Source:
Fires:
  • event:EVENT_IHA_PRESENTATION_SHOW

presAutoNav()

Auto navigates presentation

Source:
Fires:
  • event:EVENT_IHA_PRESENTATION_NEXT

getProjectId()

Returns the project ID. First trying the commandline then falling back to project JSON prsonas.projectId

Source:
Returns:

Returns the project ID

Type
String

onCcEvent(data)

Receives closed caption event

Parameters:
Name Type Description
data Object

Message object
Source:
Fires:
  • event:showCC()

onEndCcEvent(data)

Receives end closed caption event

Parameters:
Name Type Description
data Object

Message object
Source:

onPresHome()

Presentation home btn clicked

Source:
Fires:
  • event:showPresPage()
  • event:EVENT_IHA_PRESENTATION_HOME

onPresNext()

Presentation next btn clicked

Source:
Fires:
  • event:showPresPage()
  • event:EVENT_IHA_PRESENTATION_NEXT

onPresBack()

Presentation back btn clicked

Source:
Fires:
  • event:showPresPage()
  • event:EVENT_IHA_PRESENTATION_BACK

onToggleQrCode()

Toggles the QR Code graphic on/off

Source:

onMap(locationName)

Update MappedIn iframe web app with chosen location

Parameters:
Name Type Description
locationName String

Location name or ID of the location to show
Source:

onFindLocation(locationName)

Find result for location by name or ID

Parameters:
Name Type Description
locationName String

Location name or ID of the location to show
Source:

onShowMap(state)

Toggle the map display on and off

Parameters:
Name Type Description
state Boolean

True is on. False is off.
Source:

onPageLoad(eventId, data)

Called when a page is loaded

Parameters:
Name Type Description
eventId String

Event ID
data Object

Event data
Source: