Skip to main content

Uniphore Customer Portal

Using Extensions to Override Elements: A Guide

Here is a reference guide to Extension points that can be overridden when using Application Extensions, along with the Extension methods which are available.

Extension Points for Default Applications

The following table lists Extension points in Agent, Web Self-Service and Mobile Web applications that can be overridden using an Application Extension:

Extension Point

Use/Description

agentPopupRenderer

Answers and Flow tabs of the History Flow page

autocompleteRenderer

Auto complete dropdown list

breadcrumbRenderer

Breadcrumbs portion of the screen

callbackPageRenderer

Page for entering a phone number for call return

callPageRenderer

Call Now page

choiceSwitchRenderer

Switch element

clickToContinueCategoryRenderer

Two level click to continue element

clickToContinueMatrixLayoutRenderer

Click to continue matrix

clickToContinueRenderer

Click to continue button

collectionRenderer

Collection list

contactUsPageRenderer

Contact Us page

contactSectionsRenderer

Header, label, choices and footer

headerFooterRenderer

Header and footer of a page or a section

InteractionsListPageRenderer

List of Interactions page

longTextInputRenderer

Multiline input element

pageContentRenderer

Header, content and footer of a page (most basic page layout)

pageFooterRenderer

Page footer, including the menu buttons

pageHeaderRenderer

Page header, including the navigation buttons (Back and Next)

pageRenderer

Root renderer

Note

This Extension point is not supported in the Agent (History Only) application. Use the agentPopupRenderer Extension point instead.

radioButtonRenderer

Radio button element

sectionChoicesRenderer

One renderer above the leafs

sectionLabelRenderer

Label just before the question

selectFromListRenderer

Dropdown list

sendEmailPageRenderer

Email Us page

shortTextInputRenderer

Input element

uploadPhotosMatrixRenderer

Upload page matrix of thumbnails

uploadPhotosRenderer

Upload photos question

viewFullSizePhotoRenderer

Full screen of uploaded photos

Extension Methods

The following table lists methods that are available for use in context-based (i.e., ctx) calls:

Note

To see usage examples of Extension method variables, click here.

Method and Arguments

Use/Description

getVariable(varName, success, fail)

Get the value of a specific variable by name.

  • varName {String} - variable name to get

  • success {Function} - success callback, gets the variable value as a parameter

  • fail {Function} - fail callback

getVariables(varNames, success, fail)

Get the values of a multiple variables by their names.

  • varNames {Array} - array of variable names to get

  • success {Function} - success callback, get map of variable values as a parameter

  • fail {Function} - fail callback

setVariable(varName, value)

Get the value of a specific variable by name.

  • varName {String} - variable name to set

  • value {String} - new value for varName

setVariable(varName, value)

Set the value of a specific variable by name.

  • varName {String} - variable name to set

  • value {String} - new value for varName

setVariablesAsync(vars, success, fail)

Set the value of a specific variable by name.

  • vars {String} - variable name or names to set (simple types, objects, collections and Enum types are supported)

  • success {String} - new value(s) for vars

  • fail {Function} - fail callback

getInteractionId()

Get the root Interaction ID.

getPage()

Get the page object.

getEnvironmentName()

Get the name of the current Environment.

getApplicationName()

Get the name of the running Application.

getFlowName()

Get the name of the currently running Flow.

If the context of the current Flow step is in a Sub-flow, this function will return the name of the Sub- flow.

Special Extension Points

The following table lists some special Extension points:

Extension Point

Description

loaded

Called when a page is finished rendering. You can use this event to modify the completed page and find elements using reference names.

Note: This Extension point is not supported in the Agent (History Only) Application.

onError

Called just before displaying the default server error.

In this section: