Global

Members

API_ERROR_CODES

The API response Error Codes.

Source:

APIS

The Apis.

Source:

CHANNELS

The accepted channels.

Source:

RESPONSE_CODES

The Api response codes.

Source:

Methods

_addEventListeners()

Remove the event listeners.

Source:

_addFilterWidget()

AddFilterWidget to the page layout event.

Source:

_backToTop()

Aligns the carousels back to the top to the first carousel.

Source:

_build()

Builds the widget.

Source:

_build(data)

Builds elements.

Parameters:
Name Type Description
data Object

The detail data.
Source:

_build()

Builds the widget.

Source:

_build(config)

Builds the info block.

Parameters:
Name Type Description
config Object

The config for text and icon.
Source:

_build()

Builds the widget.

Source:

_buildButtonsList()

Builds the buttons list.

Source:

_buildButtonsList()

Builds the buttons list.

Source:

_buildCastLabel(text)

Builds presenter label element.

Parameters:
Name Type Description
text string

Cast label.
Source:

_buildCastNames(names)

Builds presenter name element.

Parameters:
Name Type Description
names string

Presenter name.
Source:

Builds the logo.

Source:

_buildConfirmButton()

Builds tip bar.

Source:

_buildContentMessage()

Builds the container for forbidden playback message.

Source:

_buildDescription()

Builds the description.

Source:

_buildDuration()

Builds the duratio.

Source:

_buildEpisodesList(episodes)

Builds element.

Parameters:
Name Type Description
episodes Array

The episodes to append.
Source:

_buildFirstRow()

Builds the container for logo and subtitle.

Source:

_buildImage()

Builds icon's container.

Source:

_buildImage(config)

Builds confiramtion button.

Parameters:
Name Type Description
config Object

Config.
Source:

_buildImdbRating()

Builds the rating scale. (IMDB).

Source:

_buildImdbRating()

Builds the rating scale. (IMDB).

Source:

Builds the logo.

Source:

_buildProgamInfo()

Builds the program detail info.

Source:

_buildProgressBar()

Builds the progressbar.

Source:

_buildRowsList()

Builds the list for rows.

Source:

_buildSeasonsList(mockdata)

Builds element.

Parameters:
Name Type Description
mockdata Object

Mocked data.
Source:

_buildSecondRow()

Builds the container for title and duration.

Source:

_buildSubtitle()

Builds the subtitle.

Source:

_buildSubtitle()

Builds the subtitle.

Source:

_buildTitle()

Builds the title.

Source:

_buildTitle()

Builds the title.

Source:

_buildTitle()

Builds the title.

Source:

_buildTwoButtonHorizontalList(text1, text2, screenType)

Builds horizontall list of buttons.

Parameters:
Name Type Description
text1 string

The text for first button.
text2 string

The text for second button.
screenType string

The type of the screen - username / pin.
Source:

_buildVideoRatings()

Builds the icons list.

Source:

_buildVideoRatings()

Builds the icons list.

Source:

_buildVideoRatings()

Builds the icons list.

Source:

_buildVideoRatings()

Builds the icons list.

Source:

_canReplay(item) → {boolean}

Returns true if the video can be played.

Parameters:
Name Type Description
item Object

Item to check catchup availability.
Source:
Returns:
  • True if the video can be played.
Type
boolean

_clearChannelInput()

Clears the channel input widget.

Source:

_create()

Creates warning box.

Source:

_createAsset(item)

Creates and appends the given asset item to the carousel.

Parameters:
Name Type Description
item Object

The vod or program object to add to the carousel.
Source:

_createButtons(config)

Builds confiramtion button.

Parameters:
Name Type Description
config Object

Config.
Source:

_createButtons(event)

Creates modal component based on passed options with one button.

Parameters:
Name Type Description
event Event

Event.
Source:

_createDetailsList(episodes)

Creates modal content list based on passed options and data.

Parameters:
Name Type Description
episodes Array

The episodes to append.
Source:

_createInfoNotAvailable(channel, data) → {Object}

Creates epgData when missing.

Parameters:
Name Type Description
channel Object

The channel the epg item belongs to.
data Object

The data.
Source:
Returns:
  • Epg item metadata.
Type
Object

_createModal()

Creates modal component based on passed options with one button.

Source:

_createModal()

Creates modal component based on passed options with one button.

Source:

_createModal()

Creates modal component based on passed options with one button.

Source:

_createModal()

Creates modal component based on passed options with one button.

Source:

_createModal()

Creates modal component based on passed options with one button.

Source:

_fillMissingPrevs(time, items) → {Promise}

Tries to fill in the blanks, retrieved from the prev time span.

Parameters:
Name Type Description
time number

The time to check for.
items Object

The original item to check against.
Source:
Returns:

Load promise.

Type
Promise

_fillMissingPrevsInCurrentTime(time, items) → {Promise}

Tries to fill in the blanks, retrieved from the prev time span.

Parameters:
Name Type Description
time number

The time to check for.
items Object

The original item to check against.
Source:
Returns:

Load promise.

Type
Promise

_getMenuItemIndex(callingComponent) → {Object}

Returns the index object of the given callingComponent.

Parameters:
Name Type Description
callingComponent string

The menu component to be focused.
Source:
Returns:
  • The index to set selection.
Type
Object

_getWidgetParams(widgetLayout) → {Object}

Returns the widgets params for the type of layout.

Parameters:
Name Type Description
widgetLayout string

The type of layout of the widget.
Source:
Returns:
  • The widget's params.
Type
Object

_handleChannelKey(e, activeElementId) → {boolean}

Determines if Samsung's channel key will be handled by the main app or the component.

Parameters:
Name Type Description
e Object

The keyEvent data.
activeElementId string

The active component ID.
Source:
Returns:
  • True if the channel key will be handled by main app instead of component.
Type
boolean

_handleChannelKey(e) → {boolean}

Determines if Samsung's channel key will be handled by the main app or the component.

Parameters:
Name Type Description
e Object

The keyEvent data.
Source:
Returns:
  • True if the channel key will be handled by main app instead of component.
Type
boolean

_handleChannelKey(e) → {boolean}

Determines if Samsung's channel key will be handled by the main app or the component.

Parameters:
Name Type Description
e Object

The keyEvent data.
Source:
Returns:
  • True if the channel key will be handled by main app instead of component.
Type
boolean

_isLocked() → {boolean}

Checks whether asset is child protected.

Source:
Returns:
  • True if is child protected.
Type
boolean

_isUpdateableCarousel(carouselLayout) → {boolean}

Checks carousels with EPG layout that can be updated with new data. i.e. live carousels in home or sports page.

Parameters:
Name Type Description
carouselLayout string

The carousel layout.
Source:
Returns:
  • True if the carousel can be updated.
Type
boolean

_launchBingeWatch()

Launches bingewatching overlay.

Source:

_manageOnCloseClick(ev)

Manages the click behaviour from menu to the background page.

Parameters:
Name Type Description
ev Object

The click event.
Source:

_modifyTime(time, hh, mm, ss, ms) → {Date}

Modify time for the given date.

Parameters:
Name Type Description
time Date

Date time.
hh number

Hours.
mm number

Minutes.
ss number

Seconds.
ms number

Milliseconds.
Source:
Returns:
  • Modified time.
Type
Date

_onClose()

Executes the close functionality.

Source:

_onClose()

Executes the close functionality.

Source:

_onClose()

Executes the close functionality.

Source:

_onCloseApp()

Closes the app.

Source:

_onFailedAppstart()

Failed app start handler.

Source:

_onKeyDown(event)

OnKeyDownEvent.

Parameters:
Name Type Description
event Event

The event data.
Source:

_onKeyDown(e)

KeyDown event.

Parameters:
Name Type Description
e event

Passed onKeyDown event.
Source:

_onKeyDown(e)

Triggers on key down event for navigation keys to show player ui if hidden.

Parameters:
Name Type Description
e KeyEvent

The event data.
Source:

_onKeyDown(event)

OnKeyDownEvent.

Parameters:
Name Type Description
event Event

The event data.
Source:

_onKeyDown(event)

OnKeyDownEvent.

Parameters:
Name Type Description
event Event

The event data.
Source:

_onLive()

Returns to live broadcast.

Source:

_onLive()

Prepares playback of live broadcast.

Source:

_onMiniEPG()

Shows or hides the miniEPG.

Source:

_onMouseEnterHandler()

Handles the mouse over event.

Source:

_onMouseLeaveHandler()

Handles the mouse leave event.

Source:

_onNextEpisode(nextEpisode)

On Next episode button pressed.

Parameters:
Name Type Description
nextEpisode Object

The episode to watch.
Source:

_onParentalControlChangedEvent(e)

On parental control event changed.

Parameters:
Name Type Description
e Object

Parental control event.

Properties
Name Type Description
status boolean

Parental control status (on or off).
Source:

_onPointerOffHandler()

Handles pointer off event.

Source:

_onSelect(ev)

On select event.

Parameters:
Name Type Description
ev Object

Select event.
Source:

_onSelect()

Select event.

Source:

_onSelect(e)

On Select event.

Parameters:
Name Type Description
e Event

The event data.
Source:

_onSelect(e)

Select event.

Parameters:
Name Type Description
e event

Passed select event.
Source:

_onSelect(e)

Select event.

Parameters:
Name Type Description
e event

Passed select event.
Source:

_onSelect(e)

On select function.

Parameters:
Name Type Description
e event

Event passed on select.
Source:

_onSelect(e)

Select event handler. ,

Parameters:
Name Type Description
e Event

Select event.
Source:

_onSelect(e)

On Select event.

Parameters:
Name Type Description
e Event

The event data.
Source:

_onSelect(event)

Select event.

Parameters:
Name Type Description
event event

Passed select event.
Source:

_onSelect(e)

Select event.

Parameters:
Name Type Description
e event

Passed select event.
Source:

_onSelect(e)

Select event.

Parameters:
Name Type Description
e event

Passed select event.
Source:

_onSelect(event)

Select event.

Parameters:
Name Type Description
event event

Passed select event.
Source:

_onSelect()

Overrides pointerhorizontalcontainer's onSelect method so that detail series can manage the event.

Source:

_onSelect(event)

On select function describes buttons behaviour.

Parameters:
Name Type Description
event event

Event passed on select.
Source:

_onSelect(e)

Select event handler. ,

Parameters:
Name Type Description
e Event

Select event.
Source:

_onSelectedItemChange(e)

On selected item change event.

Parameters:
Name Type Description
e Object

Selected item change event.
Source:

_onSelectedItemChange(e)

On Selected item change event.

Parameters:
Name Type Description
e Event

The event data.
Source:

_onSelectedItemChange(e)

On selected item change event.

Parameters:
Name Type Description
e Object

Selected item change event.
Source:

_onSelectedItemChange(ev)

On selected item change event.

Parameters:
Name Type Description
ev Object

Selected item change event.
Source:

_onSuccessfulAppstart()

OnReadyHandler.

Source:

_onTextChange()

On text change bound. Hides error after every text change.

Source:

_onTextValidated()

On text validate bound.

Source:

_openDetail(dataItem)

Open detail page for the given content.

Parameters:
Name Type Description
dataItem Object

Data item to open its detail page.
Source:

_parseSections(pageSections) → {Object}

Transforms the sections.

Parameters:
Name Type Description
pageSections Array

The sections to transform.
Source:
Returns:
  • Returns an object with a collection of hero slider items and carousels.
Type
Object

_parseSections(pageSections) → {Object}

Transforms the sections.

Parameters:
Name Type Description
pageSections Array

The sections to transform.
Source:
Returns:
  • Returns an object with a collection of hero slider items and carousels.
Type
Object

_parseSections(pageSections) → {Object}

Transforms the sections.

Parameters:
Name Type Description
pageSections Array

The sections to transform.
Source:
Returns:
  • Returns an object with a collection of hero slider items and carousels.
Type
Object

_playNextEpisode(episode)

Attempts to play the next episode.

Parameters:
Name Type Description
episode Object

The episode to watch.
Source:

_prepareUser() → {Promise}

Prepares the user.

Source:
Returns:
  • Promise resolving with the user.
Type
Promise

_removeEventListeners()

Add the event listeners.

Source:

_removeListeners()

Set the listeners for the carousel.

Source:

_removeListeners()

Set the listeners for the carousel.

Source:

_removeTizenMultitaskHandler()

Removes the tizen multitask handler.

Source:

_removeTizenMultitaskHandler()

Removes the tizen multitask handler.

Source:

_removeTizenMultitaskHandler()

Removes the tizen multitask handler.

Source:

_requestStream(playbackData) → {Object}

Requests the content's stream data.

Parameters:
Name Type Description
playbackData Object

Playback content data.
Source:
Returns:
  • Stream data.
Type
Object

_requestStream() → {Object}

Requests the content's stream data.

Source:
Returns:
  • Stream data.
Type
Object

_requestStream(playbackData) → {Object}

Requests the content's stream data.

Parameters:
Name Type Description
playbackData Object

The playback data needed to request the stream.
Source:
Returns:
  • Stream data.
Type
Object

_requestStream(program) → {Object}

Requests the content's stream data.

Parameters:
Name Type Description
program Object

The requested program.
Source:
Returns:
  • Stream data.
Type
Object

_requestStream(playbackData) → {Object}

Requests the content's stream data.

Parameters:
Name Type Description
playbackData Object

Playback content data.
Source:
Returns:
  • Stream data.
Type
Object

_resetModal()

Reset modal window.

Source:

_resetModal()

Reset modal window.

Source:

_resetToSelectedIndex()

Resets focus to the selected index menu item.

Source:

_routeToDetails(routeParams)

Routes to the details page of the content.

Parameters:
Name Type Description
routeParams Object

The route params.
Source:

_sendNextEpisodeAnalytics()

Sends analytics for next episode action.

Source:

_sendOpenInfoAnalytics()

Sends analytics after showing info details.

Source:

_sendPauseAnalytics()

Sends analytics on content paused.

Source:

_setData(item)

Sets the data item.

Parameters:
Name Type Description
item Array

The item.
Source:

_setFocus()

Sets focus for an element and bubles MouseFocusEvent.

Source:

_setKeyHoldData(e, keyHoldHandler)

Sets the keyHold data.

Parameters:
Name Type Description
e Object

The keyEvent data.
keyHoldHandler function

Function that handles the keyEvent.
Source:

_setKeyHoldData(e, keyHoldHandler, activeComponent)

Sets the keyHold data.

Parameters:
Name Type Description
e Object

The keyEvent data.
keyHoldHandler function

Function that handles the keyEvent.
activeComponent Object

Currently active component.
Source:

_setKeyHoldData(e, keyHoldHandler)

Sets the keyHold data.

Parameters:
Name Type Description
e Object

The keyEvent data.
keyHoldHandler function

Function that handles the keyEvent.
Source:

_setListeners()

Set the listeners for the carousel.

Source:

_setListeners()

Set the listeners for the carousel.

Source:

_setListeners()

Set the listeners for the carousel.

Source:

_setLiveProgram(program)

Sets the live program.

Parameters:
Name Type Description
program Object

The program data.
Source:

_setPaginationSettings(gridConfig)

Determines pagination settings. Requires: callback if pagination is set to manual or automatic. Throws error if callback is not defined but pagination is manual or automatic.

Parameters:
Name Type Description
gridConfig Object

The grid configuration.
Source:

_setProgram(program)

Requests the content's stream data.

Parameters:
Name Type Description
program Object

The requested program.
Source:

_setPromo(program)

Sets the Promo video.

Parameters:
Name Type Description
program Object

The program data.
Source:

_setTizenMultitaskHandler()

Sets the tizen multitask handler.

Source:

_setTizenMultitaskHandler()

Sets the tizen multitask handler.

Source:

_setTizenMultitaskHandler()

Sets the tizen multitask handler.

Source:

_setVODMovie(program)

Sets the VOD program.

Parameters:
Name Type Description
program Object

The program data.
Source:

_setVODProgram(program)

Sets the VOD program.

Parameters:
Name Type Description
program Object

The program data.
Source:

_showLoader(show)

Shows or hides loader.

Parameters:
Name Type Description
show boolean

True to show loader.
Source:

_updateProgressbars()

Starts the progressbars update interval.

Source:

_updateProgressbars()

Starts the progressbars update interval.

Source:

_updateProgressbars()

Starts the progressbars update interval.

Source:

_updateProgressbars()

Starts the progressbars update interval.

Source:

_zapChannel(ev)

Zaps next or previous channel depending on key event.

Parameters:
Name Type Description
ev Object

Key Event.
Source:

_zapChannel(ev)

Prepares to zap to next or previous channel depending on key event.

Parameters:
Name Type Description
ev Object

Key Event.
Source:

_zapToChannel(channel)

Zaps to the given channel.

Parameters:
Name Type Description
channel Object

Chanel to zap to..
Source:

activate(isActive)

Makes component visible.

Parameters:
Name Type Description
isActive boolean

True or false.
Source:

activateLast(animOptions)

Activates the last item in the row.

Parameters:
Name Type Description
animOptions Object

The animation options.
Source:

activateLast(animOptions)

Activates the last item in the row.

Parameters:
Name Type Description
animOptions Object

The animation options.
Source:

activateLast(animOptions)

Activates the last item in the row.

Parameters:
Name Type Description
animOptions Object

The animation options.
Source:

addEpisodeRecording(id) → {Promise}

Adds a recording.

Parameters:
Name Type Description
id number

The episode id.
Source:
Returns:
  • Promise resolving with an added recording.
Type
Promise

addItem(item)

Adds an item to the series display.

Parameters:
Name Type Description
item Object

The item.
Source:

addLastSearchedItem(newValue)

Updating last searched items.

Parameters:
Name Type Description
newValue string

New walue passed onSelect.
Source:

addMouseLeaveHandler()

Adds the mouse leave handler.

Source:

addMouseOverHandler()

Adds the mouse over handler.

Source:

addMouseOverHandler()

Adds the mouse over handler.

Source:

addSeriesRecording(id, channelId) → {Promise}

Adds a recording.

Parameters:
Name Type Description
id number | string

The series id.
channelId number | string

The channel id.
Source:
Returns:
  • Promise resolving with an added recording.
Type
Promise

align(item)

Aligns the component based on the given item.

Parameters:
Name Type Description
item Object

The item.
Source:

align(item)

Aligns the component based on the given item.

Parameters:
Name Type Description
item Object

The item.
Source:

align(item)

Aligns the component based on the given item.

Parameters:
Name Type Description
item Object

The item.
Source:

alignCarousel(indexopt, setActiveopt)

Aligns the carousel.

Parameters:
Name Type Attributes Description
index number <optional>

The index to align to. Optional.
setActive boolean <optional>

True if the active child widget should be set.
Source:

alignCarousels()

Aligns the carousels to force them to render items.

Source:

alignCarousels()

Aligns the carousels to force them to render items.

Source:

alignNext()

Aligns the carousel to the next item.

Source:

alignPrevious()

Aligns the carousel to the previous item.

Source:

alignToActiveIndex()

Aligns the grid to the active index.

Source:

alignToFirstItem()

Aligns to the first item.

Source:

alignToIndex(indexopt)

Aligns the carousel to a specific index, or 0 if not supplied.

Parameters:
Name Type Attributes Description
index number <optional>

The index. Optional.
Source:

alignToIndex(index, optionsopt)

Aligns the carousel to a specific index.

Parameters:
Name Type Attributes Description
index number

The index.
options Object <optional>

The alignment options.
Source:

alignToIndex(index, optionsopt)

Aligns the carousel to a specific index.

Parameters:
Name Type Attributes Description
index number

The index.
options Object <optional>

The alignment options.
Source:

alignToIndex(index, options)

Aligns to index.

Parameters:
Name Type Description
index number

The index.
options Object

The options.
Source:

alignToIndex(index, optionsopt)

Aligns the carousel to a specific index.

Parameters:
Name Type Attributes Description
index number

The index.
options Object <optional>

The alignment options.
Source:

alignToIndex(index, optionsopt)

Aligns the carousel to a specific index.

Parameters:
Name Type Attributes Description
index number

The index.
options Object <optional>

The alignment options.
Source:

alignToIndex(index, optionsopt)

Aligns the carousel to a specific index.

Parameters:
Name Type Attributes Description
index number

The index.
options Object <optional>

The alignment options.
Source:

alignToIndexFunc(index)

Aligns to proper index.

Parameters:
Name Type Description
index number

Index.
Source:

alignToLastIndex()

Aligns to the last index.

Source:

alignToPosition(position, optionsopt)

Aligns the carousel to a position.

Parameters:
Name Type Attributes Description
position number

Position 0 for the start, 1 for the end.
options Object <optional>

The alignment options.
Source:

alignToPosition(position, optionsopt)

Aligns the carousel to a position.

Parameters:
Name Type Attributes Description
position number

Position 0 for the start, 1 for the end.
options Object <optional>

The alignment options.
Source:

alignToPosition(position, optionsopt)

Aligns the carousel to a position.

Parameters:
Name Type Attributes Description
position number

Position 0 for the start, 1 for the end.
options Object <optional>

The alignment options.
Source:

alignToTimeOfDay(time, optionsopt, positionopt)

Aligns the carousel to a specific time of day.

Parameters:
Name Type Attributes Description
time string | number

The time.
options Object <optional>

The alignment options.
position number <optional>

The carousel position.
Source:

alignToTimeOfDay(time, optionsopt, positionopt)

Aligns the carousel to a specific time of day.

Parameters:
Name Type Attributes Description
time string | number

The time.
options Object <optional>

The alignment options.
position number <optional>

The carousel position.
Source:

alignToTop()

Aligns to proper index.

Source:

animateFocusBar()

Animates focusbar based on timeout.

Source:

animateFocusBar()

Animates focusbar based on timeout.

Source:

appDurationEvent()

Add GA tracking for application time.

Source:

appendChildWidget(widget, appendToMainContent) → {Object}

Appends widget to the component or modal content widget.

Parameters:
Name Type Description
widget Object

Widget to append.
appendToMainContent boolean

True if it should append to the base component.
Source:
Returns:
  • The appended child widget.
Type
Object

appendData(items, shouldFocusopt, shouldAlignopt)

Appends more data to the grid.

Parameters:
Name Type Attributes Description
items Array

The items.
shouldFocus boolean <optional>

If the new row should be focused.
shouldAlign boolean <optional>

If aligning should happen.
Source:

attachIndexedWidgets(indexArray)

Attaches the child widgets of the given indexes.

Parameters:
Name Type Description
indexArray Array

The indexes to attach.
Source:

backward(value)

Backward playback from value.

Parameters:
Name Type Description
value number

Value to go backwards.
Source:

backward(value)

Backward playback from value.

Parameters:
Name Type Description
value number

Value to go backwards.
Source:

buildWidget(widget)

Builds the individual widget.

Parameters:
Name Type Description
widget Object

The widget. See WIDGET_TYPES for available widgets.
Source:

buildWidgets(widgets)

Builds the widgets and appends them to the component.

Parameters:
Name Type Description
widgets Array

The widgets.
Source:

buildWidgets(pageSections, sectionParamsopt)

Builds the widgets and appends them to the component.

Parameters:
Name Type Attributes Description
pageSections Object

The sections that contains collections of widgets.
sectionParams Object <optional>

Specific params to use for the widgets. i.e. layouts.
Source:

buildWidgets(pageSections, sectionParamsopt)

Builds the widgets and appends them to the component.

Parameters:
Name Type Attributes Description
pageSections Object

The sections that contains collections of widgets.
sectionParams Object <optional>

Specific params to use for the widgets. i.e. layouts.
Source:

buildWidgets(pageSections, sectionParamsopt)

Builds the widgets and appends them to the component.

Parameters:
Name Type Attributes Description
pageSections Object

The sections that contains collections of widgets.
sectionParams Object <optional>

Specific params to use for the widgets. i.e. layouts.
Source:

canCatchup() → {boolean}

Returns true if the video can be caught up.

Source:
Returns:
  • True if can be caught up.
Type
boolean

canCatchup() → {boolean}

Returns true if the item can be played.

Source:
Returns:
  • True if the item can be played.
Type
boolean

cancelRecording()

Changes buttons icon and label to Cancel recording state.

Source:

canPlay() → {boolean}

Returns true if the video can be played.

Source:
Returns:
  • True if the video can be played.
Type
boolean

canPlay() → {boolean}

Returns true if the video can be played.

Source:
Returns:
  • True if the video can be played.
Type
boolean

canRecord() → {boolean}

Returns true if recording is allowed.

Source:
Returns:
  • True if recording is allowed.
Type
boolean

canRecord() → {boolean}

Returns true if the user can record.

Source:
Returns:
  • True if the user can record.
Type
boolean

canRecord() → {boolean}

Returns true if recording is allowed.

Source:
Returns:
  • True if recording is allowed.
Type
boolean

canSeek() → {boolean}

Returns true if seeking is allowed.

Source:
Returns:
  • True if seeking is allowed.
Type
boolean

canSeek() → {boolean}

Returns true if seeking is allowed.

Source:
Returns:
  • True if seeking is allowed.
Type
boolean

changeContent(content)

Change content function.

Parameters:
Name Type Description
content Object

Content to append.
Source:

checkLoadMore()

Check if we need to load more rows.

Source:

checkLoadMore(shouldPrepend)

Check if we need to load more rows.

Parameters:
Name Type Description
shouldPrepend boolean

True if items should prepending to the grid.
Source:

clear()

Clears the widget.

Source:

clear()

Clears the widget.

Source:

clear()

Clears the old elements.

Source:

clear()

Clears the widget.

Source:

clearInputField()

Clears the input field value.

Source:

clearInputField()

Clears the input field value.

Source:

clearInputField()

Clears the input field value.

Source:

clearLastSearchedItems()

Clears the last searched items.

Source:

clearRefreshSessionTimeout()

Clears the refresh session timeout.

Source:

clearUserLogin()

Clears the user login.

Source:

close(callEscape)

Global close function.

Parameters:
Name Type Description
callEscape boolean

True if escape function callback should execute.
Source:

closeExpandedContents()

Closes any expanded content (i.e. miniEPG or program's detail).

Source:

closeExpandedContents()

Closes any expanded content (i.e. miniEPG or program's detail).

Source:

closeMenu()

Hide menu.

Source:

closePlayer()

Close player.

Source:

closePlayer()

Close player.

Source:

closePlayer()

Close player.

Source:

completeAlignment()

Instantly completes any in-flight alignment animations, firing any callbacks that were provided. If several alignments have been queued, all will complete in order.

Source:

completeAlignment()

Instantly completes any in-flight alignment animations, firing any callbacks that were provided. If several alignments have been queued, all will complete in order.

Source:

create()

Creates the widget.

Source:

create(modelReference, opts, retryFulFilledopt, retryRejectedopt) → {Promise}

Returns a Promise with an instance of the Model being requested.

Parameters:
Name Type Attributes Description
modelReference string | ModelInterface

Reference to the model or instance.
opts Object

Options object.

Properties
Name Type Attributes Default Description
params Object

Parameters object which is used in the resolveEndpoint method of the requested Model.
data Object <optional>
 {}

Data to send as payload.
retryFulFilled * <optional>

Resolve function for repeating request after failure.
retryRejected * <optional>

Reject function for repeating request after failure.
Source:
Throws:

When the fetched model module isn't an instance of ModelInterface.

Type
Error
Returns:

Returns a Promise.

Type
Promise

createInfoNotAvailable(data, channelId) → {EpgItem}

Creates epgData when missing.

Parameters:
Name Type Description
data Object

The data.
channelId string

The channel ID.
Source:
Returns:
  • New EPGItem.
Type
EpgItem

createMissingEpgData(channelId) → {*}

Creates any missing information for missing epgData item.

Parameters:
Name Type Description
channelId number

ChannelId of the missing epgData item.
Source:
Returns:
  • The new epgItem created from channel.
Type
*

createPaginationButton()

Creates the pagination button.

Source:

createRow() → {Object}

Creates a row.

Source:
Returns:
  • A row.
Type
Object

createSkeleton()

Creates the skeleton.

Source:

createTitle()

Creates the name.

Source:

delay(f, duration, ctx) → {Object}

Delay the execution of a function.

Parameters:
Name Type Description
f Object

Reference to the function you want to delay.
duration Integer

The amount of time you with to delay. In milliseconds.
ctx Object

Context to apply.
Source:
Returns:
  • Function closure with setTimeout.
Type
Object

deleteEpisodeRecording(item) → {Promise}

Deletes an item recording.

Parameters:
Name Type Description
item Object

The item to remove from recordings.
Source:
Returns:
  • Promise resolving after deletion.
Type
Promise

deleteSeriesRecording(id) → {Promise}

Deletes a series recording.

Parameters:
Name Type Description
id string

The series id.
Source:
Returns:
  • Promise resolving with the series id.
Type
Promise

destroy(modelReference, opts, retryFulFilledopt, retryRejectedopt) → {Promise}

Returns a Promise with an instance of the Model being requested.

Parameters:
Name Type Attributes Description
modelReference string | ModelInterface

Reference to the model or instance.
opts Object

Options object.

Properties
Name Type Description
params Object

Parameters object which is used in the resolveEndpoint method of the requested Model.
retryFulFilled * <optional>

Resolve function for repeating request after failure.
retryRejected * <optional>

Reject function for repeating request after failure.
Source:
Throws:

When the fetched model module isn't an instance of ModelInterface.

Type
Error
Returns:

Returns a Promise.

Type
Promise

destroy()

Unloads and removes any event callbacks.

Source:

destroy()

Unloads and removes any event callbacks.

Source:

determinePointers(index)

Determines the pointers.

Parameters:
Name Type Description
index number

The new index.
Source:

determinePointers(index)

Determines the pointers.

Parameters:
Name Type Description
index number

The new index.
Source:

disable()

Disables the toggle.

Source:

disable()

Disables the buttons.

Source:

disable()

Disables the widget.

Source:

disableLiveButton(disable)

Disables live button.

Parameters:
Name Type Description
disable boolean

Disable flag.
Source:

disablePointerSupport()

Disable pointer support.

Source:

displayValue(value)

Displays the value.

Parameters:
Name Type Description
value Object

The value.
Source:

dispose()

Disposes the widget.

Source:

dispose()

Disposes the widget.

Source:

dispose()

Disposes of the button.

Source:

dispose()

Dispose the widgets.

Source:

dispose()

Disposes of the button.

Source:

dispose()

Disposes the widget.

Source:

dispose()

Disposes the widget.

Source:

dispose()

Disposes the widget.

Source:

dispose()

Cleanup routine. Removes registered event listeners.

Source:

dispose()

Dispose the widget.

Source:

dispose()

Disposes the widget.

Source:

dispose()

Disposes of the widget.

Source:

dispose()

Disposes of the button.

Source:

dispose()

Handles the menu's disposal.

Source:

dispose()

Disposes of the widget.

Source:

empty()

Empties the grid.

Source:

enable()

Enables the buttons.

Source:

enable()

Enables the toggle.

Source:

enable()

Enables the widget.

Source:

enablePointerSupport()

Enable pointer support.

Source:

focus()

Focus.

Source:

focus() → {boolean}

Focuses the widget.

Source:
Returns:
  • True if focus is set.
Type
boolean

focus()

Sets focus to the carousel.

Source:

focus()

Focus this widget.

Source:

focus()

Focuses the button.

Source:

focus() → {boolean}

Focuses the widget.

Source:
Returns:
  • True if focus is set.
Type
boolean

focus()

Sets the focus.

Source:

focus()

On focus event. Sets the focus on play pause button.

Source:

focus()

Focuses the carousel.

Source:

focus()

Sets focus to the view.

Source:

focus()

Focuses the view.

Source:

focusAction(index)

Sets focus to the action. Will set focus to the last focused button.

Parameters:
Name Type Description
index number

The index to focus.
Source:

focusFastForwardButton()

Focus fast forward button.

Source:

focusMenu(callingComponent)

Shows and focus the menu.

Parameters:
Name Type Description
callingComponent string

The calling component.
Source:

focusPlayPauseButton()

Focus play/pause button.

Source:

focusRewindButton()

Focus rewind button.

Source:

focusSelector()

Set focus on tab selector.

Source:

focusTab()

Set focus on tab container.

Source:

format(item) → {Object}

Formats the widget.

Parameters:
Name Type Description
item Object | Iterator

The item.
Source:
Returns:
  • The formatted widget.
Type
Object

format(item, formatParams) → {Object}

Formats the widget.

Parameters:
Name Type Description
item Object | Iterator

The item.
formatParams Object

Contains format params passed by child class.
Source:
Returns:
  • The formatted widget.
Type
Object

format(item, params) → {Object}

Formats the widget.

Parameters:
Name Type Description
item Object | Iterator

The item.
params Object

Contains format params passed by child class.
Source:
Returns:
  • The formatted widget.
Type
Object

format(item, params) → {Object}

Formats the widget.

Parameters:
Name Type Description
item Object | Iterator

The item.
params Object

Contains format params passed by child class.
Source:
Returns:
  • The formatted widget.
Type
Object

format(item, assetopt) → {Object}

Formats the widget.

Parameters:
Name Type Attributes Description
item Object | Iterator

The item.
asset Object <optional>

The asset item to be updated.
Source:
Returns:
  • The formatted widget.
Type
Object

format(item) → {Object}

Formats the widget.

Parameters:
Name Type Description
item Object | Iterator

The item.
Source:
Returns:
  • The formatted widget.
Type
Object

format(item) → {Object}

Formats the widget.

Parameters:
Name Type Description
item Object | Iterator

The item.
Source:
Returns:
  • The formatted widget.
Type
Object

format(item, assetopt) → {Object}

Formats the widget.

Parameters:
Name Type Attributes Description
item Object | Iterator

The item.
asset Object <optional>

The asset item to be updated.
Source:
Returns:
  • The formatted widget.
Type
Object

format(item) → {Object}

Formats the widget.

Parameters:
Name Type Description
item Object | Iterator

The item.
Source:
Returns:
  • The formatted widget.
Type
Object

format(item) → {Object}

Formats the widget.

Parameters:
Name Type Description
item Object | Iterator

The item.
Source:
Returns:
  • The formatted widget.
Type
Object

format(menuItem) → {MenuButton}

Formatter function for the menu items.

Parameters:
Name Type Description
menuItem Iterator | MenuItemModel

List or item to format.
Source:
Returns:
  • The formatted widget.
Type
MenuButton

format(item) → {Object}

Formats the widget.

Parameters:
Name Type Description
item Object | Iterator

The item.
Source:
Returns:
  • The formatted widget.
Type
Object

format(item, assetopt) → {Object}

Formats the widget.

Parameters:
Name Type Attributes Description
item Object | Iterator

The item.
asset Object <optional>

The asset item to be updated.
Source:
Returns:
  • The formatted widget.
Type
Object

format(item, assetopt) → {Object}

Formats the widget.

Parameters:
Name Type Attributes Description
item Object | Iterator

The item.
asset Object <optional>

The asset item to be updated.
Source:
Returns:
  • The formatted widget.
Type
Object

format(item, formatParams) → {Object}

Formats the widget.

Parameters:
Name Type Description
item Object | Iterator

The slider model.
formatParams Object

Formatter's configuration params.
Source:
Returns:
  • The formatted widget (slider item).
Type
Object

format(item, formatParams) → {Object}

Formats the widget.

Parameters:
Name Type Description
item Object | Iterator

The slider model.
formatParams Object

Formatter's configuration params.
Source:
Returns:
  • The formatted widget (slider item).
Type
Object

forward(value)

Forward playback from value.

Parameters:
Name Type Description
value number

Value to go forward.
Source:

forward(value)

Forward playback from value.

Parameters:
Name Type Description
value number

Value to go forward.
Source:

getAccountNumber() → {string}

Get username.

Source:
Returns:

Username.

Type
string

getAction() → {MenuAction}

Gets the action.

Source:
Returns:
  • The menu action.
Type
MenuAction

getActiveChildIndex() → {number}

Returns the active child index.

Source:
Returns:
  • The active child index.
Type
number

getActiveChildIndex() → {number}

Returns the active child index.

Source:
Returns:
  • The active child index.
Type
number

getActiveIndex() → {number}

Returns the index currently active widget.

Source:
Returns:
  • Currently active widget index.
Type
number

getActiveIndex() → {number}

Returns the index currently active widget.

Source:
Returns:
  • Currently active widget index.
Type
number

getActiveItemIndex() → {number}

Returns the active item index.

Source:
Returns:
  • The active item index.
Type
number

getActivePageId() → {string}

Returns the active page id.

Source:
Returns:
  • The page id.
Type
string

getActiveRow() → {Object}

Returns the active row.

Source:
Returns:
  • The active row.
Type
Object

getActors() → {Array}

Returns the actors.

Source:
Returns:
  • The actors.
Type
Array

getActors() → {Array}

Returns the actors.

Source:
Returns:
  • The actors.
Type
Array

getAgeRating() → {string}

Returns the age rating.

Source:
Returns:
  • The age rating.
Type
string

getAgeRating() → {string}

Returns the age rating.

Source:
Returns:
  • The age rating.
Type
string

getAgeRating() → {string}

Returns the age rating.

Source:
Returns:
  • The age rating.
Type
string

getAligner() → {Aligner}

Get the aligner used by the Carousel.

Source:
Returns:

Aligner - The aligner to use.

Type
Aligner

getAllItems() → {Array}

Returns all the items.

Source:
Returns:
  • The items.
Type
Array

getAnalyticsEventLabel(videoType) → {string}

Gets the analytics type for the given video type.

Parameters:
Name Type Description
videoType string

The video type for the analytics.
Source:
Returns:
  • The event label type.
Type
string

getApiErrorCodes() → {Object}

Returns API Error Codes.

Source:
Returns:
  • The API error codes.
Type
Object

getAPISetting() → {string}

Returns the api setting.

Source:
Returns:
  • The api setting.
Type
string

getArguments() → {Object}

The arguments passed along with the route.

Source:
Returns:
  • The arguments for the route.
Type
Object

getAssetId() → {number|null}

Get master asset id.

Source:
Returns:
  • The number or null if not set.
Type
number | null

getAssetId() → {number}

Returns the asset id.

Source:
Returns:
  • The asset id.
Type
number

getAssetId() → {number}

Returns the asset id.

Source:
Returns:
  • The asset id.
Type
number

getAssets() → {Array}

Returns the array with assets.

Source:
Returns:
  • An array with {{assetId: number, assetType: string}[]|*}.
Type
Array

getAttachedIndexes() → {Array}

Returns the attached indexes.

Source:
Returns:
  • The attached indexes.
Type
Array

getAVSSiteHeader() → {string}

Returns the AVSSite header.

Source:
Returns:
  • The AVSSite header value.
Type
string

getBackButton() → {Object}

Gets the back button.

Source:
Returns:
  • The back button.
Type
Object

getBackButton() → {*}

Returns back button element.

Source:
Returns:
  • Back button.
Type
*

getBookmark(contentId, contentType) → {number}

Gets the bookmark time (in seconds) for the given contentId and contentType.

Parameters:
Name Type Description
contentId number

The id of the content to retrieve bookmark.
contentType string

The type of the content.
Source:
Returns:
  • The bookmark time.
Type
number

getBroadcastAtTime(channelId, time) → {Promise}

Returns the broadcast at the given time.

Parameters:
Name Type Description
channelId string

The channel id.
time number

The time of the broadcast.
Source:
Returns:
  • Promise resolving with the broadcast item.
Type
Promise

getButton() → {Object}

Returns the button.

Source:
Returns:
  • The button.
Type
Object

getButtonCount() → {number}

Sets focus to the action. Will set focus to the last focused button.

Source:
Returns:

Returns the child widget count.

Type
number

getButtonListLength() → {number}

Returns the button list count.

Source:
Returns:
  • Number of widgets contained in button list.
Type
number

getCallingComponent() → {Object}

Retrieve the calling component that opened the menu.

Source:
Returns:
  • The calling component.
Type
Object

getCarousel() → {Object}

Returns the carousel.

Source:
Returns:
  • The carousel.
Type
Object

getCarousel() → {Object}

Returns the carousel.

Source:
Returns:
  • The carousel.
Type
Object

getCarousel() → {Object}

Returns carousel widget.

Source:
Returns:

Carousel widget.

Type
Object

getCarousel() → {Object}

Returns the carousel.

Source:
Returns:
  • The carousel.
Type
Object

getCarousel() → {Object}

Returns carousel widget.

Source:
Returns:

Carousel widget.

Type
Object

getCarousel() → {Object}

Returns the carousel.

Source:
Returns:
  • The carousel.
Type
Object

getCarouselActiveAsset() → {Object}

Returns active asset in carousel.

Source:
Returns:
  • Carousel widget.
Type
Object

getCarouselActiveAsset() → {Object}

Returns active asset in carousel.

Source:
Returns:

Active widget.

Type
Object

getCarouselActiveAsset() → {Object}

Returns active asset in carousel.

Source:
Returns:
  • Carousel widget.
Type
Object

getCarouselActiveAsset() → {Object}

Returns active asset in carousel.

Source:
Returns:

Active widget.

Type
Object

getCarouselItems() → {Array}

Gets the Grid carousel's items.

Source:
Returns:
  • The Grid Carousel's items.
Type
Array

getCarouselItems() → {Array}

Gets the Grid carousel's items.

Source:
Returns:
  • The Grid Carousel's items.
Type
Array

getCarouselLayout() → {string}

Returns the type of layout of the carousel. Reference layout on uibuilder's page model.

Source:
Returns:
  • The carousel layout.
Type
string

getCarousels() → {Array}

Gets all the carousels in the the content list.

Source:
Returns:

Array of carousels appended to this content list.

Type
Array

getCatchupDuration() → {number}

Returns the duration (catchup duration contains +5min at beginning and +15min at the end).

Source:
Returns:
  • The duration.
Type
number

getChannel() → {Object}

Returns the channel.

Source:
Returns:
  • The channel.
Type
Object

getChannelById(id) → {Object|null}

Gets a channel by ID.

Parameters:
Name Type Description
id string

The channel ID you want.
Source:
Returns:
  • The channel or null if not found.
Type
Object | null

getChannelByNumber(number) → {Object|null}

Returns the channel by number, or the closest channel.

Parameters:
Name Type Description
number number

The number.
Source:
Returns:
  • The channel or the closest channel or null if not found.
Type
Object | null

getChannelForId(id) → {string|number}

Gets the channel for the given id.

Parameters:
Name Type Description
id string | number

The id.
Source:
Returns:
  • The number.
Type
string | number

getChannelForNumber(number) → {string|number}

Gets the channel for the given number.

Parameters:
Name Type Description
number string | number

The number.
Source:
Returns:
  • The id.
Type
string | number

getChannelId() → {number}

Returns the channel id.

Source:
Returns:
  • The channel id.
Type
number

getChannelId() → {number}

Returns channel ID.

Source:
Returns:
  • ID of channel.
Type
number

getChannelId() → {string}

Returns the channel id.

Source:
Returns:
  • The channel id.
Type
string

getChannelId() → {number}

Returns the channel id.

Source:
Returns:
  • The channel id.
Type
number

getChannelIndex(channelId) → {number}

Returns the channel index for the given channel id.

Parameters:
Name Type Description
channelId number

The channel id.
Source:
Returns:
  • The channel index.
Type
number

Returns the channel logo.

Source:
Returns:
  • The channel logo.
Type
string

Returns the channel logo.

Source:
Returns:
  • The channel logo.
Type
string

Returns the program channels's logo.

Source:
Returns:
  • The program's title.
Type
string

Returns the channel logo.

Source:
Returns:
  • The channel logo.
Type
string

getChannelMap(startopt, endopt) → {Array}

Returns the channel map.

Parameters:
Name Type Attributes Description
start number <optional>

Optional start index.
end number <optional>

Optional end index.
Source:
Returns:
  • The channel map.
Type
Array

getChannelName() → {string}

Returns the channel name.

Source:
Returns:
  • The channel name.
Type
string

getChannelNumberForId(channelId) → {number}

Returns the channel number for the given channel id.

Parameters:
Name Type Description
channelId number

The channel id.
Source:
Returns:
  • The channel number.
Type
number

getChannelNumbers() → {Array}

Returns all channel numbers.

Source:
Returns:
  • The channel numbers.
Type
Array

getChannels() → {Array}

Returns the channels.

Source:
Returns:
  • The channels.
Type
Array

getChannels() → {Array}

Returns the channels.

Source:
Returns:
  • The channels.
Type
Array

getChannelSwitcher() → {Object}

Returns the channel switcher.

Source:
Returns:
  • The channel switcher.
Type
Object

getChildren() → {Array}

Gets the children.

Source:
Returns:
  • The children.
Type
Array

getClearButton() → {Object}

Gets clear button.

Source:
Returns:

Clear button.

Type
Object

getConfig() → {PromiseLike.<T>}

Requests & sets Halo configuration credentials and requests oAuth token with credentials.

Source:
Returns:
  • Promise.
Type
PromiseLike.<T>

getContainer() → {Object}

Returns main container.

Source:
Returns:
  • The container widget.
Type
Object

getContentCarousels() → {Object}

Source:
Returns:
  • The channels carousels.
Type
Object

getContentOptions() → {Object}

Returns the content options.

Source:
Returns:
  • The content options.
Type
Object

getContentSubtype() → {string}

Returns the content type.

Source:
Returns:
  • The content type.
Type
string

getContentSubtype() → {string}

Returns the content subtype.

Source:
Returns:
  • The content subtype.
Type
string

getContentSubtype() → {string}

Returns the content subtype.

Source:
Returns:
  • The content subtype.
Type
string

getContentType() → {string}

Returns the content type.

Source:
Returns:
  • The content type.
Type
string

getContentType() → {string}

Returns the content type.

Source:
Returns:
  • The content type.
Type
string

getContentType() → {string}

Returns the content type.

Source:
Returns:
  • The content type.
Type
string

getContentType() → {string}

Returns the content type.

Source:
Returns:
  • The content type.
Type
string

getContentType() → {string}

Returns the content type.

Source:
Returns:
  • The content type.
Type
string

getContentType() → {string}

Returns the content type.

Source:
Returns:
  • The content type.
Type
string

getContentVideoType(contentType, contentSubtype) → {string}

Returns the content video type for the given content type and subtype.

Parameters:
Name Type Description
contentType string

Content's type.
contentSubtype string

Content's subtype.
Source:
Returns:
  • The content's video type.
Type
string

getControlBar() → {Object}

Returns the control bar that contians each control.

Source:
Returns:
  • The control bar.
Type
Object

getControls() → {Object}

Returns the controls.

Source:
Returns:
  • The controls.
Type
Object

getCurrentBroadcastForChannel(channelId) → {Promise}

Returns the current broadcast for the given channel.

Parameters:
Name Type Description
channelId number | string

The channel id.
Source:
Returns:
  • Promise resolving with the current item.
Type
Promise

getCurrentInput() → {string}

Returns the current input.

Source:
Returns:
  • The current input.
Type
string

getCurrentRecordings(optsopt) → {Promise}

Returns the current recordings.

Parameters:
Name Type Attributes Description
opts Object <optional>

The retrieval options.
Source:
Returns:
  • Promise resolving with the current recordings.
Type
Promise

getCurrentSeriesRecordings(optsopt) → {Promise}

Returns the current recordings formatted by series.

Parameters:
Name Type Attributes Description
opts Object <optional>

The retrieval options.
Source:
Returns:
  • Promise resolving with the current recordings.
Type
Promise

getCurrentTime() → {number}

Gets the currents time from media player.

Source:
Returns:
  • The media player's current playback time.
Type
number

getCurrentTime() → {number}

Gets the currents time from media player.

Source:
Returns:
  • The media player's current playback time.
Type
number

getCurrentTime() → {number}

Returns the player's current time.

Source:
Returns:
  • Player current time.
Type
number

getCursor() → {Object}

Returns cursor.

Source:
Returns:
  • Cursor object.
Type
Object

getCursor() → {Object}

Returns cursor.

Source:
Returns:
  • Cursor object.
Type
Object

getCursor() → {Object}

Returns the cursor.

Source:
Returns:
  • The cursor.
Type
Object

getData(genreKey, date) → {Promise}

Retrieve the data for the given genre key and date.

Parameters:
Name Type Description
genreKey string

The genre key to retrieve the data for.
date Date

The date to retrieve the data for.
Source:
Returns:
  • Promise resolving with the data for the given genre key and date.
Type
Promise

getDate() → {Date}

Returns the date.

Source:
Returns:
  • The current date/time.
Type
Date

getDefaultText(text) → {Object}

Returns default text for date that was not found.

Parameters:
Name Type Description
text string

Text value.
Source:
Returns:
  • Returns default text.
Type
Object

getDescription() → {string}

Returns editorial block's description.

Source:
Returns:

The description text for the editorial block.

Type
string

getDescription() → {string}

Returns the description.

Source:
Returns:
  • The description.
Type
string

getDescription() → {string}

Returns the description.

Source:
Returns:
  • The description.
Type
string

getDescription() → {string}

Returns the description.

Source:
Returns:
  • The description.
Type
string

getDetailsAction() → {string}

Returns the details action.

Source:
Returns:
  • The details action url.
Type
string

getDetailsAction() → {string}

Returns the details action.

Source:
Returns:
  • The details action url.
Type
string

getDetailsAction() → {string}

Returns the details action.

Source:
Returns:
  • The details action url.
Type
string

getDirection() → {number}

Get the direction.

Source:
Returns:

Direction - The direction Aligner.directions.FORWARD or Aligner.directions.BACKWARD.

Type
number

getDirection() → {string}

Returns the direction.

Source:
Returns:
  • The direction.
Type
string

getDirectors() → {Array}

Returns the directors.

Source:
Returns:
  • The directors.
Type
Array

getDirectors() → {Array}

Returns the directors.

Source:
Returns:
  • The directors.
Type
Array

getDownPointerContainer() → {Object}

Returns down pointer button.

Source:
Returns:

Down pointer button.

Type
Object

getDuration() → {number}

Returns the duration.

Source:
Returns:
  • The duration.
Type
number

getDuration() → {number}

Gets the duration of the playback content.

Source:
Returns:
  • The content's duration.
Type
number

getDuration() → {number}

Gets the duration of the playback content.

Source:
Returns:
  • The content's duration.
Type
number

getDuration() → {number}

Returns the duration.

Source:
Returns:
  • The duration.
Type
number

getEditorialBlocks(options) → {Object}

Returns the item.

Parameters:
Name Type Description
options Object

Options to retrieve editorial blocks.

Properties
Name Type Description
hasContent Object

True returns blocks with content, false returns blocks with or without content.
Source:
Returns:
  • The actual hero item.
Type
Object

getEndIndex() → {number}

Gets the current end index.

Source:
Returns:
  • The end index.
Type
number

getEndTime() → {Date}

Returns the end time.

Source:
Returns:
  • The end time.
Type
Date

getEndTime() → {number}

Returns the end time.

Source:
Returns:
  • The end time.
Type
number

getEndTime() → {number}

Returns the current program's end time.

Source:
Returns:
  • Current program's end time.
Type
number

getEpisodeList() → {Object}

Returns episodes.

Source:
Returns:

Episodes.

Type
Object

getEpisodeNumber() → {number}

Returns the episode number.

Source:
Returns:
  • The episode number.
Type
number

getExternalId() → {number|string|null}

Gets the external identifier.

Source:
Returns:
  • The ID or null if not set.
Type
number | string | null

getFeatureSupport() → {Object}

Gives a report about which features are supported & unsupported for this device.

Source:
Returns:

Returns a report of supported & unsupported features.

Type
Object

getFilterButton() → {Object}

Get the common filter button.

Source:
Returns:
  • Commong filter button widget.
Type
Object

getFocusBar() → {Object}

Returns cursor.

Source:
Returns:
  • Cursor object.
Type
Object

getFocusBar() → {Object}

Returns cursor.

Source:
Returns:
  • Cursor object.
Type
Object

getFormattedDuration() → {string}

Returns the formatted duration text.

Source:
Returns:
  • The formatted duration text.
Type
string

getFromLeftIndex() → {number}

Returns the index from left.

Source:
Returns:
  • The left index.
Type
number

getFromLeftIndex() → {number}

Returns the index from left.

Source:
Returns:
  • The left index.
Type
number

getFromLeftIndex() → {number}

Returns the index from left.

Source:
Returns:
  • The left index.
Type
number

getFutureRecordings(optsopt) → {Promise}

Returns the future recordings.

Parameters:
Name Type Attributes Description
opts Object <optional>

The retrieval options.
Source:
Returns:
  • Promise resolving with the future recordings.
Type
Promise

getGenreButton() → {Object}

Get the genre filter button.

Source:
Returns:
  • Genre filter button widget.
Type
Object

getGenres() → {Array}

Returns the genres.

Source:
Returns:
  • The genres.
Type
Array

getGenres() → {Array}

Returns the genres.

Source:
Returns:
  • The genres.
Type
Array

getGenres() → {Array}

Returns the genres.

Source:
Returns:
  • The genres.
Type
Array

getGosChannels() → {Array}

Gets the GOS channels.

Source:
Returns:
  • The array of the GOS IDs.
Type
Array

getHaloAPI() → {Object}

Returns the Halo api, for the given api setting.

Source:
Returns:
  • The endpoint based on the api setting.
Type
Object

getHero() → {Array}

Returns the Hero model of the page.

Source:
Returns:
  • The Hero model.
Type
Array

getIcon() → {string}

Returns the menu item icon.

Source:
Returns:
  • The menu item icon.
Type
string

getId() → {string}

Return id of the broadcast.

Source:
Returns:
  • The id.
Type
string

getId() → {string}

Return id of the broadcast.

Source:
Returns:
  • The id.
Type
string

getId() → {number}

Returns the id.

Source:
Returns:
  • The id.
Type
number

getId() → {number|string|null}

Gets the identifier.

Source:
Returns:
  • The ID or null if not set.
Type
number | string | null

getId() → {string/number}

Returns the menu item id.

Source:
Returns:
  • The menu item id.
Type
string/number

getId() → {number}

Returns the id.

Source:
Returns:
  • The series id.
Type
number

getId() → {string}

Return id of the broadcast.

Source:
Returns:
  • The id.
Type
string

getImage(sizeopt) → {string}

Gets the image.

Parameters:
Name Type Attributes Description
size string <optional>

The image size. Optional. Possible values: 128, 256, 384 and 512.
Source:
Returns:
  • The image url.
Type
string

getImageAPI(path) → {string}

Returns the image api.

Parameters:
Name Type Description
path string

Path to append to base url. Possible values: 'vod','epg','logo'...
Source:
Returns:
  • The image api url.
Type
string

getImageUrl(size) → {string}

Returns the image url.

Parameters:
Name Type Description
size string

The image size.
Source:
Returns:
  • The image url.
Type
string

getImageUrl(size) → {string}

Returns URL of preview image.

Parameters:
Name Type Description
size string

Size of the image.
Source:
Returns:
  • URL of preview image.
Type
string

getImageUrl(size) → {string}

Returns URL of preview image.

Parameters:
Name Type Description
size string

Size of the image.
Source:
Returns:
  • URL of preview image.
Type
string

getImageUrl(size) → {string}

Returns URL of preview image.

Parameters:
Name Type Description
size string

Size of the image.
Source:
Returns:
  • URL of preview image.
Type
string

getImageUrl(size) → {string}

Returns URL of preview image.

Parameters:
Name Type Description
size string

Size of the image.
Source:
Returns:
  • URL of preview image.
Type
string

getImageUrl() → {string}

Returns editorial block's image url.

Source:
Returns:

The image URL for the editorial block.

Type
string

getImdbRating() → {number|null}

Returns the user rating scale of the content. (IMDB).

Source:
Returns:
  • The user rating scale.
Type
number | null

getImdbRating() → {number|null}

Returns the user rating scale of the content. (IMDB).

Source:
Returns:
  • The user rating scale.
Type
number | null

getInputField() → {Object}

Returns inputfield object.

Source:
Returns:
  • Inputfield Object.
Type
Object

getInputField() → {Object}

Returns inputfield object.

Source:
Returns:
  • Inputfield Object.
Type
Object

getInputField() → {Object}

Returns inputfield object.

Source:
Returns:
  • Inputfield Object.
Type
Object

getInRowIndex() → {number}

Gets the current item index in the row.

Source:
Returns:
  • The item index in the row.
Type
number

getInstance() → {Object}

Returns the instance.

Source:
Returns:
  • The instance.
Type
Object

getInstance() → {Object}

Returns the channel manager instance.

Source:
Returns:
  • The channel manager instance.
Type
Object

getInstance() → {Object}

Returns the instance.

Source:
Returns:
  • The instance.
Type
Object

getInstance() → {Object}

Returns an instance of the epg manager.

Source:
Returns:
  • The epg manager instance.
Type
Object

getInstance() → {RecordingManager}

Returns the instance.

Source:
Returns:
  • The recording manager.
Type
RecordingManager

getInstance(key) → {Object}

Returns an Api instance.

Parameters:
Name Type Description
key string

Api config key.
Source:
Returns:

Api object.

Type
Object

getInstance() → {Object}

Returns the instance.

Source:
Returns:
  • The instance.
Type
Object

getItem() → {Object}

Returns the module item.

Source:
Returns:
  • The module content.
Type
Object

getItem() → {Object}

Returns the item.

Source:
Returns:
  • The actual hero item.
Type
Object

getItem() → {Object}

Returns the item.

Source:
Returns:
  • The actual hero item.
Type
Object

getItemCount() → {number}

Returns the item count.

Source:
Returns:
  • The item count.
Type
number

getItems() → {Object}

Returns the item.

Source:
Returns:
  • The actual hero items.
Type
Object

getItems() → {Array}

Returns the items.

Source:
Returns:
  • The carousel items to be appended.
Type
Array

getItems() → {Array}

Returns the formatted items.

Source:
Returns:
  • The items.
Type
Array

getItems() → {Array}

Returns the items.

Source:
Returns:
  • The items to be appended.
Type
Array

getItems() → {Array}

Returns the items.

Source:
Returns:
  • The carousel items to be appended.
Type
Array

getKeyboard() → {Object}

Returns the keyboard.

Source:
Returns:
  • The keyboard.
Type
Object

getKeyboard() → {Object}

Returns the keyboard.

Source:
Returns:
  • The keyboard.
Type
Object

getKeyboard() → {Object}

Returns the keyboard.

Source:
Returns:
  • The keyboard.
Type
Object

getKeyboard() → {Object}

Returns the keyboard.

Source:
Returns:
  • The numeric keyboard.
Type
Object

getKPNAPI() → {Object}

Returns the kpn api, for the given api setting.

Source:
Returns:
  • The endpoint based on the api setting.
Type
Object

getLabel() → {string}

Returns the menu item label.

Source:
Returns:
  • The menu item label.
Type
string

getLabel() → {Label}

Return button label.

Source:
Returns:

Label of this button.

Type
Label

getLabel() → {Label}

Return button label.

Source:
Returns:

Label of this button.

Type
Label

getLabelIcon() → {Label}

Return button label icon.

Source:
Returns:

Label of this button.

Type
Label

getLastSearchedItems() → {Array}

Returns last searched Items.

Source:
Returns:
  • The 10 last searched items.
Type
Array

getLastServiceMessageShown() → {Date}

Returns the last service message number.

Source:
Returns:
  • The last service message.
Type
Date

getLastWatchedChannel() → {number}

Returns the last watched channel id.

Source:
Returns:
  • The last watched channel id.
Type
number

getLayout() → {string}

The carousel layout type. See page model for available layouts.

Source:
Returns:
  • The layout type. e.g. 'EPG_LARGE', 'VOD_SMALL'.
Type
string

getLeftPointerContainer() → {Object}

Returns left pointer button.

Source:
Returns:

Left pointer button.

Type
Object

getLeftPointerContainer() → {Object}

Returns left pointer button.

Source:
Returns:

Left pointer button.

Type
Object

getLengthOfAssets() → {number}

Returns number of assets in carousel.

Source:
Returns:

Number of assets.

Type
number

getList() → {rofl.widgets.carousel}

Gets the Grid carousel.

Source:
Returns:
  • The Grid Carousel.
Type
rofl.widgets.carousel

getLivePlaybackPosition() → {number}

Returns the live playback position.

Source:
Returns:
  • The live playback position.
Type
number

getLiveProgressPercentage(startTime, endTime, pauseTime) → {Object}

Returns the live progress width.

Parameters:
Name Type Description
startTime Date

The start time.
endTime Date

The end time.
pauseTime number

The position behind head.
Source:
Returns:
  • The head and pause percentage.
Type
Object

getLiveProgressWidth(startTime, endTime, width, pauseTime) → {Object}

Returns the live progress width.

Parameters:
Name Type Description
startTime Date

The start time.
endTime Date

The end time.
width number

The progress bar width.
pauseTime number

The position behind head.
Source:
Returns:
  • The head and pause width.
Type
Object

getLocalData(opts) → {*}

Retrieves the local data if there is any.

Parameters:
Name Type Description
opts Object

Options object.
Source:
Returns:

Local response data.

Type
*

getLocalData() → {Array}

Return local data.

Source:
Returns:
  • Array of object with menu data.
Type
Array

getLocalData(opts) → {*}

Retrieves the local data if there is any.

Parameters:
Name Type Description
opts Object

Options object.
Source:
Returns:

Local response data.

Type
*

getMask() → {Object}

Returns the mask of the carousel.

Source:
Returns:
  • Carousel mask widget.
Type
Object

getMask() → {Object}

Returns the mask of the carousel.

Source:
Returns:
  • Carousel mask widget.
Type
Object

getMaxSeekValue() → {number}

Returns the maximum seek value.

Source:
Returns:
  • The max seek value.
Type
number

getMenuItem() → {MenuItem}

Gets the set menu item.

Source:
Returns:
  • The menu item.
Type
MenuItem

getMiniEPG() → {Object}

Returns the mini epg.

Source:
Returns:
  • The mini epg.
Type
Object

getMiniEPG() → {Object}

Returns the mini epg.

Source:
Returns:
  • The mini epg.
Type
Object

getModule(module, moduleName, byIdsopt) → {Promise}

Returns the Halo module.

Parameters:
Name Type Attributes Description
module string

The api module to be used.
moduleName string | Array

The name of the module or modules.
byIds boolean <optional>

True if the modules should be loaded by id.
Source:
Returns:
  • Promise resolving witht he module data.
Type
Promise

getName() → {string|null}

Gets the label.

Source:
Returns:
  • The name or null if not set.
Type
string | null

getName() → {string|null}

Gets the name.

Source:
Returns:

The name or null if not defined.

Type
string | null

getNextBroadcastAtTime(channelId, time) → {Promise}

Returns the next item of broadcast at the given time.

Parameters:
Name Type Description
channelId number

The channel id.
time number

The time of the broadcast.
Source:
Returns:
  • Promise resolving with the next item of broadcast item.
Type
Promise

getNextChannel(channel) → {Object|null}

Returns the next channel.

Parameters:
Name Type Description
channel Object

The channel to locate the next for.
Source:
Returns:
  • The next channel or null if not found.
Type
Object | null

getNowPrev(channelIds) → {Promise}

Get the current and prev EPG item for a channel ID.

Parameters:
Name Type Description
channelIds String | Number | Array

Channel ID's to load the data for.
Source:
Returns:

EPG data promise.

Type
Promise

getNumber() → {number|null}

Returns the channel number.

Source:
Returns:
  • The channel number or null if not set.
Type
number | null

getParentalGenres() → {Array}

Returns parental genres.

Source:
Returns:
  • Parental genres.
Type
Array

getParentalGenres() → {Array}

Returns parental genres.

Source:
Returns:
  • Parental genres.
Type
Array

getParentalGenres() → {Array}

Returns parental genres.

Source:
Returns:
  • Parental genres.
Type
Array

getParentalGenres() → {Array}

Returns parental genres.

Source:
Returns:
  • Parental genres.
Type
Array

getParentalWhitelisted() → {boolean}

Gets if program is whitelisted.

Source:
Returns:
  • If is whitelisted.
Type
boolean

getParentalWhitelisted() → {boolean}

Gets if program is whitelisted.

Source:
Returns:
  • If is whitelisted.
Type
boolean

getParentalWhitelisted() → {boolean}

Gets if program is whitelisted.

Source:
Returns:
  • If is whitelisted.
Type
boolean

getPCLevel() → {number}

Returns PC level.

Source:
Returns:
  • PC level.
Type
number

getPCLevel() → {number}

Returns PC level.

Source:
Returns:
  • PC level.
Type
number

getPCLevel() → {number}

Returns PC level.

Source:
Returns:
  • PC level.
Type
number

getPCLevel() → {number}

Returns parental control level.

Source:
Returns:
  • Parental control level.
Type
number

getPCLevel() → {*|number}

Returns parental control level.

Source:
Returns:
  • Parental control level.
Type
* | number

getPlannedSeriesRecordings(optsopt) → {Promise}

Returns the future recordings formatted by series.

Parameters:
Name Type Attributes Description
opts Object <optional>

The retrieval options.
Source:
Returns:
  • Promise resolving with the future recordings.
Type
Promise

getPlaybackInterface() → {Object}

Gets the playback interface.

Source:
Returns:
  • The playback interface.
Type
Object

getPlaybackInterface() → {Object}

Gets the playback interface.

Source:
Returns:
  • The playback interface.
Type
Object

getPlaybackInterface() → {Object}

Gets the playback interface.

Source:
Returns:
  • The playback interface.
Type
Object

getPlaybackStatus() → {Object}

Returns the value of playbackStatus property.

Source:
Returns:
  • Container properties regarding the current playback state.
Type
Object

getPlayer() → {Object}

Returns the mediaplayer.

Source:
Returns:
  • The player.
Type
Object

getPlayerManipulation() → {Object}

Returns the player manipulation decorator.

Source:
Returns:
  • Player manipulation decorator.
Type
Object

getPlayerManipulation() → {Object}

Returns the player manipulation decorator.

Source:
Returns:
  • Player manipulation decorator.
Type
Object

getPlayerManipulation() → {Object}

Returns the player manipulation decorator.

Source:
Returns:
  • Player manipulation decorator.
Type
Object

getPreviousChannel(channel) → {Object|null}

Returns the previous channel.

Parameters:
Name Type Description
channel Object

The channel to locate the previous for.
Source:
Returns:
  • The previous channel or null if not found.
Type
Object | null

getProfile() → {Promise}

Reads the profile model.

Source:
Returns:

Read profile.

Type
Promise

getProgram() → {Object|null}

Returns the current program.

Source:
Returns:
  • The current program or null if not set.
Type
Object | null

getProgramDetails() → {Object}

Returns the program details container.

Source:
Returns:
  • The program details container.
Type
Object

getProgramDetails() → {Object}

Returns the program details container.

Source:
Returns:
  • The program details container.
Type
Object

getProgramType() → {string}

Returns the program type.

Source:
Returns:
  • The program type.
Type
string

getProgress() → {Object}

Returns the progressbar.

Source:
Returns:
  • The progressbar.
Type
Object

getRecordingDuration() → {number}

Returns the duration.

Source:
Returns:
  • The duration.
Type
number

getRecordingId() → {string}

Returns the recording id.

Source:
Returns:
  • The recording id.
Type
string

getRecordingId() → {string}

Returns the recording id.

Source:
Returns:
  • The recording id.
Type
string

getRecordingId() → {number}

Returns the recording id.

Source:
Returns:
  • The recording id.
Type
number

getRecordings(options) → {Promise}

Returns the recordings.

Parameters:
Name Type Description
options Object

The options.
Source:
Returns:
  • Promise resolving with the recordings.
Type
Promise

getRelatedContent() → {Object}

Returns the related content model.

Source:
Returns:
  • The related content model.
Type
Object

getRestartProgressPercentage(startTime, endTime, restartDifference) → {Object}

Returns the live progress width.

Parameters:
Name Type Description
startTime Date

The start time.
endTime Date

The end time.
restartDifference number

The position behind head.
Source:
Returns:
  • The head and pause percentage.
Type
Object

getRightPointerContainer() → {Object}

Returns right pointer button.

Source:
Returns:

Right pointer button.

Type
Object

getRightPointerContainer() → {Object}

Returns right pointer button.

Source:
Returns:

Right pointer button.

Type
Object

getRights() → {string}

Returns the rights of the asset.

Source:
Returns:
  • The rights type. ie 'watch', 'buy'.
Type
string

getRoute() → {string}

The route the action will trigger.

Source:
Returns:
  • The route to trigger.
Type
string

getRoutingComponent(route) → {Object}

Return the whole route component.

Parameters:
Name Type Description
route string

The route name.
Source:
Returns:
  • The whole route component.
Type
Object

getRowChildWidgetCount() → {number}

Returns the number of rows.

Source:
Returns:
  • Gets count of the rows.
Type
number

getRowIndex() → {number}

Gets the current row index.

Source:
Returns:
  • The row index.
Type
number

getRowsTotal() → {number}

Get the total number of rows in the grid.

Source:
Returns:
  • The number of rows.
Type
number

getSeason() → {string}

Returns the season.

Source:
Returns:
  • The season.
Type
string

getSeason() → {string}

Returns the episode's season.

Source:
Returns:
  • The episode's season.
Type
string

getSeasons() → {Array}

Returns the seasons.

Source:
Returns:
  • The seasons.
Type
Array

getSections() → {Array}

Returns all the individual section models.

Source:
Returns:
  • The section models.
Type
Array

getSeriesId() → {number}

Returns the series id.

Source:
Returns:
  • The series id.
Type
number

getSeriesId() → {number}

Returns the series id.

Source:
Returns:
  • The series id.
Type
number

getSeriesId() → {number}

Returns a series id.

Source:
Returns:
  • The series id.
Type
number

getSeriesTitle() → {string}

Returns the series title.

Source:
Returns:
  • The series title.
Type
string

getServiceMessage() → {Promise}

Retrieves the service message.

Source:
Returns:
  • The service message promise.
Type
Promise

getServiceText() → {string}

Returns the service text.

Source:
Returns:
  • The service text.
Type
string

getServiceText() → {string}

Returns the service message text if it has been retrieved.

Source:
Returns:
  • The service message text.
Type
string

getServiceTitle() → {string}

Returns the service title.

Source:
Returns:
  • The service title.
Type
string

getServiceTitle() → {string}

Returns the service message title if it has been retrieved.

Source:
Returns:
  • The service message title.
Type
string

getSliderImageUrl(layout) → {string}

Builds and returns the image url from the item data given its width and height.

Parameters:
Name Type Description
layout Object

The slider item's layout.
Source:
Returns:
  • The image URL.
Type
string

getSliderSubtitle() → {string}

Returns the program's title.

Source:
Returns:
  • The program's title.
Type
string

getSliderTitle() → {string}

Returns the program's title.

Source:
Returns:
  • The program's title.
Type
string

getSortButton() → {Object}

Get the sort filter button.

Source:
Returns:
  • Sort filter button widget.
Type
Object

getSportsScreenData() → {Object}

Returns the sports screen data.

Source:
Returns:
  • The sports screen data.
Type
Object

getStartDeltaTime() → {number}

Returns the start delta time.

Source:
Returns:
  • The start delta time.
Type
number

getStartDeltaTime() → {number}

Returns the start delta time.

Source:
Returns:
  • The start delta time.
Type
number

getStartDeltaTime() → {number}

Returns the start delta time.

Source:
Returns:
  • The start delta time.
Type
number

getStartIndex() → {number}

Gets the current start index.

Source:
Returns:
  • The start index.
Type
number

getStartTime() → {Date}

Returns the start time.

Source:
Returns:
  • The start time.
Type
Date

getStartTime() → {number}

Returns the start time.

Source:
Returns:
  • The start time.
Type
number

getState() → {string}

Gets the playpause button state.

Source:
Returns:
  • The button's state.
Type
string

getStopDeltaTime() → {number}

Returns the stop delta time.

Source:
Returns:
  • The stop delta time.
Type
number

getStreamHeaders(program) → {Object}

Checks if the content requires pin to send as header.

Parameters:
Name Type Description
program Object

The program to check if headers are needed.
Source:
Returns:
  • Headers for the stream.
Type
Object

getStreamOffset() → {number|null}

Returns the recording starttime.

Source:
Returns:
  • The stream offset.
Type
number | null

getStreamOffset() → {number|null}

Returns the recording starttime.

Source:
Returns:
  • The stream offset.
Type
number | null

getStreamTime(startTime) → {string}

Returns the stream time.

Parameters:
Name Type Description
startTime Date

The start time.
Source:
Returns:
  • The stream time.
Type
string

getStreamType(videoType) → {Object}

Returns the stream type.

Parameters:
Name Type Description
videoType string

The video type.
Source:
Returns:
  • The streamtype.
Type
Object

getStreamUrl() → {string|null}

Returns the stream url.

Source:
Returns:
  • The stream url or null if not set.
Type
string | null

getText() → {string}

Returns string of date.

Source:
Returns:
  • Date in string form.
Type
string

getText() → {string}

Returns the text.

Source:
Returns:
  • The text.
Type
string

getText() → {string}

Returns string of date.

Source:
Returns:
  • Date in string form.
Type
string

getText() → {string}

Return button text.

Source:
Returns:

Text of this button.

Type
string

getText() → {string}

Returns the text.

Source:
Returns:
  • The text.
Type
string

getText() → {string}

Return button text.

Source:
Returns:

Text of this button.

Type
string

getTitle() → {string}

Returns title of the broadcast.

Source:
Returns:
  • The title.
Type
string

getTitle() → {string}

Returns the title.

Source:
Returns:
  • The title.
Type
string

getTitle() → {string}

Returns editorial block's title.

Source:
Returns:

The title for the editorial block.

Type
string

getTitle() → {string}

Returns the title.

Source:
Returns:
  • The title.
Type
string

getTitle() → {string}

Returns title of the broadcast.

Source:
Returns:
  • The title.
Type
string

getTitle() → {Object}

Returns the title.

Source:
Returns:
  • The title label.
Type
Object

getTitle() → {string}

The series title.

Source:
Returns:
  • The title.
Type
string

getTitle() → {string}

Returns the title.

Source:
Returns:
  • The title.
Type
string

getTitle() → {string}

Returns the title.

Source:
Returns:
  • The title.
Type
string

getTitle() → {string}

Returns title of the broadcast.

Source:
Returns:
  • The title.
Type
string

getTitle() → {string}

Returns the title.

Source:
Returns:
  • The title.
Type
string

getTitleBrief() → {string}

Returns the title brief (short title).

Source:
Returns:
  • The title brief.
Type
string

getTitleBrief() → {string}

Returns the title brief (short title).

Source:
Returns:
  • The title brief.
Type
string

getToken() → {MODELS.OAUTH}

Request & sets the authorization token data.

Source:
Returns:
  • Returns resolved endpoint data.
Type
MODELS.OAUTH

getTotal() → {number}

Get the total number of items in the grid.

Source:
Returns:
  • The number of items.
Type
number

getTotal() → {number}

Returns the items count.

Source:
Returns:
  • Total number of items available.
Type
number

getTrickplaySettings() → {Object|null}

Returns the trickplay settings.

Source:
Returns:
  • The trickplay settings or null if the program is not set.
Type
Object | null

getType() → {string|null}

Gets the type.

Source:
Returns:
  • The type or null if not set.
Type
string | null

getUpPointerContainer() → {Object}

Returns up pointer button.

Source:
Returns:

Up pointer button.

Type
Object

getUser() → {Object}

Returns the user.

Source:
Returns:
  • The user.
Type
Object

getUserPCParams() → {Object}

Returns parental controls user settings.

Source:
Returns:

ParentalSettings - Parental control settings.

Type
Object

getUserPin() → {string}

Returns the user pin.

Source:
Returns:
  • The user pin.
Type
string

getValidationMessage() → {Object}

Returns the validation message.

Source:
Returns:
  • The validation message.
Type
Object

getValue() → {string}

Returns value of the input.

Source:
Returns:
  • Value of the inupt.
Type
string

getValue() → {string}

Returns value of the input.

Source:
Returns:
  • Value of the inupt.
Type
string

getValue() → {string}

Returns value of the input.

Source:
Returns:
  • Value of the inupt.
Type
string

getValue() → {string}

Returns value of the input.

Source:
Returns:
  • Value of the inupt.
Type
string

getValue() → {string}

Returns value of the input.

Source:
Returns:
  • Value of the inupt.
Type
string

getValue() → {string}

Returns value of the input.

Source:
Returns:
  • Value of the inupt.
Type
string

getValue() → {string}

Returns value of the input.

Source:
Returns:
  • Value of the inupt.
Type
string

getValue() → {string}

Returns value of the input.

Source:
Returns:
  • Value of the inupt.
Type
string

getVersion() → {Promise}

Returns version from server.

Source:
Returns:

Promise of new version.

Type
Promise

getVideoRatings() → {Array}

Returns the video ratings.

Source:
Returns:
  • The video ratings.
Type
Array

getVideoRatings() → {Array}

Returns the video ratings.

Source:
Returns:
  • The video ratings.
Type
Array

getVideoRatings() → {Array}

Returns the video ratings.

Source:
Returns:
  • The video ratings.
Type
Array

getVideoRatings() → {Array}

Returns the video ratings.

Source:
Returns:
  • The video ratings.
Type
Array

getVideoType() → {Object}

Returns the video type.

Source:
Returns:
  • The video type.
Type
Object

getView() → {Object}

Return the current player view.

Source:
Returns:
  • The current player view.
Type
Object

getView() → {Object}

Returns the player view.

Source:
Returns:
  • The player view.
Type
Object

getWatchAll() → {Promise}

Returns the watch-all endpoint.

Source:
Returns:
  • The watchall endpoint.
Type
Promise

getWatchAll() → {Object}

Returns watchall model.

Source:
Returns:

The watchall model of the editorial block.

Type
Object

getWidgetType() → {string}

Returns the type of widget this model to be used with.

Source:
Returns:
  • The type of widget.
Type
string

getWidgetType() → {string}

Returns the type of widget this model to be used with.

Source:
Returns:
  • The type of widget.
Type
string

getWidgetType() → {string}

Returns the type of widget this model to be used with.

Source:
Returns:
  • The type of widget.
Type
string

getWidgetType() → {string}

Returns the type of widget this model to be used with.

Source:
Returns:
  • The type of widget.
Type
string

getWidgetType() → {string}

Returns the type of widget this model to be used with.

Source:
Returns:
  • The type of widget.
Type
string

getWidgetType() → {string}

Returns the type of widget this model to be used with.

Source:
Returns:
  • The type of widget.
Type
string

getYear() → {string}

Returns the year.

Source:
Returns:
  • The year.
Type
string

getYear() → {string}

Returns the year.

Source:
Returns:
  • The year.
Type
string

getYear() → {string}

Returns the year.

Source:
Returns:
  • The year.
Type
string

getZappbanner() → {Object}

Returns the zappbanner.

Source:
Returns:
  • The zappbanner.
Type
Object

goToWatchAll(watchAllItem)

Routes to watch all module.

Parameters:
Name Type Description
watchAllItem Promise

The watchall item.
Source:

handleCloseFocus()

Closes menu and focuses on the active component.

Source:

hasChannelRights() → {boolean}

Check if the item's channel is found in the channel list. Channels with no right have already been filtered out on live channels request.

Source:
Returns:

True if has rights to watch (channel not found) false if has no rights to watch.

Type
boolean

hasChildren() → {boolean}

Checks if this menu item has children.

Source:
Returns:
  • Whether it has children.
Type
boolean

hasEpgData() → {boolean}

Returns if EPG data is available.

Source:
Returns:
  • True if noEpgData is set.
Type
boolean

hasEpisodeRecording(id) → {boolean}

Returns true if there is a recording for the given item.

Parameters:
Name Type Description
id number | string

The episodes id.
Source:
Returns:
  • True if the episode is being recorded.
Type
boolean

hasHeroElement() → {boolean}

Returns true if the component has a hero element attached.

Source:
Returns:
  • True if the component has a hero element attached.
Type
boolean

hasLocalData(opts) → {boolean}

Check whether we have to use local data for this API model.

Parameters:
Name Type Description
opts Object

Options object.
Source:
Returns:

Whether the model needs to use local data.

Type
boolean

hasLocalData(opts) → {boolean}

Check whether we have to use local data for this API model.

Parameters:
Name Type Description
opts Object

Options object.
Source:
Returns:

Whether the model needs to use local data.

Type
boolean

hasLocalData() → {boolean}

Checks if model has local data.

Source:
Returns:
  • True or false if local data exists or not.
Type
boolean

hasMenuItem() → {boolean}

Checks for a menu item.

Source:
Returns:
  • Whether a menu item is set.
Type
boolean

hasRecording(id, seriesId) → {Promise}

Returns true if there is a recording for the given item.

Parameters:
Name Type Description
id number | string

The episodes id.
seriesId number | String

The series id.
Source:
Returns:
  • Promise resolving with recording status.
Type
Promise

hasRights() → {boolean}

Returns true if the user has rights.

Source:
Returns:
  • Returns true if the item has rights to be watched.
Type
boolean

hasSeriesRecording(id) → {boolean}

Returns true if there is a recording for the given item.

Parameters:
Name Type Description
id number | string

The series id.
Source:
Returns:
  • True if the series has a recording.
Type
boolean

hasSubmenu() → {boolean}

Checks if this menu item has children.

Source:
Returns:
  • Whether it has submenu.
Type
boolean

hide(e)

Hides the widget.

Parameters:
Name Type Description
e Object

The event data.
Source:

hide(opts)

Hides the widget.

Parameters:
Name Type Description
opts Object

The options.
Source:

hide(opts)

Hides widget.

Parameters:
Name Type Description
opts Object

Hide parameter options.
Source:

hide(opts)

Reset and hide decorator.

Parameters:
Name Type Description
opts Object

Hide options.
Source:

hideError()

Hides incorrect error message.

Source:

hideHero(skipAnimation)

Hides the Hero widget.

Parameters:
Name Type Description
skipAnimation boolean

Whether to skip animation.
Source:

hideLive()

Hides live button.

Source:

hideLoader(delayopt, optionsopt)

Hide the application loader.

Parameters:
Name Type Attributes Description
delay Integer <optional>

Specify whether or not to delay the unblocking of user input.
options Object <optional>

The options.
Source:

hideMenu()

Call hide menu.

Source:

hidePaginationButton()

Hides the pagination button.

Source:

hidePlayer(useLastActiveComponent)

Hide the player.

Parameters:
Name Type Description
useLastActiveComponent boolean

True if component to show should be the last active.
Source:

hideProgress(optionsopt)

Hide progress bar.

Parameters:
Name Type Attributes Description
options Object <optional>

Pass animation options if required.
Source:

hideProgress(optionsopt)

Hide progress bar.

Parameters:
Name Type Attributes Description
options Object <optional>

Pass animation options if required.
Source:

hideRecord()

Hides record button.

Source:

hideReplay()

Hides replay button.

Source:

hideUI(optsopt)

Hides the ui.

Parameters:
Name Type Attributes Description
opts Object <optional>

Options.
Source:

hideUI(optsopt)

Hides the ui.

Parameters:
Name Type Attributes Description
opts Object <optional>

Options.
Source:

hideWarningBox(skipAnimopt)

Hides the warning box.

Parameters:
Name Type Attributes Description
skipAnim boolean <optional>

True if should skip the animations.
Source:

hideWarningBox(skipAnimopt)

Hides the warning box.

Parameters:
Name Type Attributes Description
skipAnim boolean <optional>

True if should skip the animations.
Source:

hideWarningBox(skipAnimopt)

Hides the warning box.

Parameters:
Name Type Attributes Description
skipAnim boolean <optional>

True if should skip the animations.
Source:

hideWarningBox(skipAnimopt)

Hides the warning box.

Parameters:
Name Type Attributes Description
skipAnim boolean <optional>

True if should skip the animations.
Source:

hrsToMidnight() → {number}

Checks time to midnight.

Source:
Returns:
  • Hours left to midnight.
Type
number

increaseWarmWelcomeDisplayCount()

Saves amount of displayed welcome screen.

Source:

init()

Initialises the widget.

Source:

init(idopt)

Initialises the switch channel component.

Parameters:
Name Type Attributes Description
id string <optional>

Id of the channelswitcher. Optional.
Source:

init()

Initialises the onboarding component.

Source:

init()

Initialises the widget.

Source:

init(id, type)

Initialises the button.

Parameters:
Name Type Description
id string

The id of the button.
type string

The seek type.
Source:

init(id)

Initialises the widget.

Parameters:
Name Type Description
id string

The id.
Source:

init(id)

Initialises the widget.

Parameters:
Name Type Description
id string

The id.
Source:

init(data, heroParamsopt)

Initialises the widget.

Parameters:
Name Type Attributes Description
data Object

The Carousel model.
heroParams Object <optional>

Specific params to use for the carousel.

Properties
Name Type Attributes Description
layout Object <optional>

Asset layout.
formatter Object <optional>

Asset formatter.
numberOfVisibleItemsOnScreen Object <optional>

Max number of visible items.
Source:

init(id)

Initialises the widget.

Parameters:
Name Type Description
id string

The id.
Source:

init(id)

Initialises the widget.

Parameters:
Name Type Description
id string

The id.
Source:

init(id)

Initialises the widget.

Parameters:
Name Type Description
id string

The id.
Source:

init(id)

Initialises the widget.

Parameters:
Name Type Description
id string

The id.
Source:

init()

Initialises the component.

Source:

init()

Initialises the replay component.

Source:

init(id)

Initialises the widget.

Parameters:
Name Type Description
id string

The id.
Source:

init(id)

Initialises the widget.

Parameters:
Name Type Description
id string

The id.
Source:

init(response)

Initialises the search result model from API response object.

Parameters:
Name Type Description
response Object

API search result object.
Source:

init()

Initialises the component.

Source:

init(data)

Initialises the button.

Parameters:
Name Type Description
data Object

The data item.
Source:

init(items, day, filterData, daysArray)

Initialises the Container.

Parameters:
Name Type Description
items Object

Items.
day number

Selected day filter index.
filterData Date

Filter date object.
daysArray Array

Days array..
Source:

init()

Initialises the component.

Source:

init()

Initialises the EPG manager.

Source:

init()

Initialises the input widget.

Source:

init()

Initialises the component.

Source:

init(text, idopt)

Initialises the button.

Parameters:
Name Type Attributes Description
text string

The button text.
id string <optional>

The id. Optional.
Source:

init(text, idopt)

Initialises the button.

Parameters:
Name Type Attributes Description
text string

The button text.
id string <optional>

The id. Optional.
Source:

init(response)

Initialises the search result model from API response object.

Parameters:
Name Type Description
response Object

API search result object.
Source:

init()

Initialises the component.

Source:

init()

Initialises the component.

Source:

init(data)

Initialises the button.

Parameters:
Name Type Description
data Object

The filter data.
Source:

init(data, heroParamsopt)

Initialises the widget.

Parameters:
Name Type Attributes Description
data Object

The Carousel model.
heroParams Object <optional>

Specific params to use for the carousel.

Properties
Name Type Attributes Description
layout Object <optional>

Asset layout.
formatter Object <optional>

Asset formatter.
numberOfVisibleItemsOnScreen Object <optional>

Max number of visible items.
Source:

init()

Initialises the component.

Source:

init(response)

Initialises the search result model from API response object.

Parameters:
Name Type Description
response Object

API search result object.
Source:

init()

Initialises the modal.

Source:

init()

Initialises the component.

Source:

init()

Initialises the ZappBanner widget.

Source:

init(config)

Initialises the inputfield widget.

Parameters:
Name Type Description
config Object

The configuration.

Properties
Name Type Attributes Description
opts Object <optional>

The options. Optional.
Source:

init()

Initialises the recording button.

Source:

init()

Initialises the widget.

Source:

init()

Initialises the modal.

Source:

init(data)

Initialises the widget.

Parameters:
Name Type Description
data Object

The data.
Source:

init()

Initialises the component.

Source:

init(items, day, filterData, daysArray)

Initialises the button.

Parameters:
Name Type Description
items Object

Items.
day number

Selected day filter index.
filterData Date

Filter date object.
daysArray Array

Days array..
Source:

init()

Initialises the widget.

Source:

init(idopt, text, classname)

Initialises the button.

Parameters:
Name Type Attributes Description
id string <optional>

The id. Optional.
text string

The button text.
classname string | array

The icon classname to set.
Source:

init(data)

Initialises the progress widget.

Parameters:
Name Type Description
data Object

Passed as config to widget.
Source:

init()

Initialises the component.

Source:

init(idopt, params)

Initialises the button.

Parameters:
Name Type Attributes Description
id string <optional>

The id. Optional.
params Object

The params.
Source:

init()

Initialises the component.

Source:

init(idopt)

Initialises the button.

Parameters:
Name Type Attributes Description
id string <optional>

The id. Optional.
Source:

init()

Initialises the progress widget.

Source:

init(opt)

Initialises the widget.

Parameters:
Name Type Description
opt Object

The options.
Source:

init()

Initialises the genre manager.

Source:

init(data)

Initialises the user model.

Parameters:
Name Type Description
data Object

The data.
Source:

init(data)

Initialises the widget.

Parameters:
Name Type Description
data Object

The data.
Source:

init(sliderItemParams, idopt)

Initialises the button.

Parameters:
Name Type Attributes Description
sliderItemParams Object

The slider item configuration params.
id string <optional>

The id. Optional.
Source:

init()

Initialises the vertical carousel.

Source:

init(config)

Initialises the inputfield widget.

Parameters:
Name Type Description
config Object

The configuration.

Properties
Name Type Attributes Description
title string

The input title.
type string

The input type. TYPES.PASSWORD or TYPES.TEXT.
opts Object <optional>

The options. Optional.
Source:

init(data)

Initialises the model.

Parameters:
Name Type Description
data Object

The data.
Source:

init()

Initialises the button.

Source:

init()

Initialises the widget.

Source:

init()

Initialises the widget.

Source:

init()

Initialises the stream model.

Source:

init(dataopt)

Initialises the widget.

Parameters:
Name Type Attributes Description
data Object <optional>

The data to be set.
Source:

init()

Initialises the menu.

Source:

init(data)

Initalize data object, _route and _args.

Parameters:
Name Type Description
data Object

Data object.
Source:

init(config)

Initialises the input widget.

Parameters:
Name Type Description
config Object

The configuration.
Source:

init()

Initialises the Container.

Source:

init(config)

Initialises the replay component.

Parameters:
Name Type Description
config Object

Config.
Source:

init(initParams)

Initializes the Container.

Parameters:
Name Type Description
initParams Object

Initial params.
Source:

init(data)

Initialises the model.

Parameters:
Name Type Description
data Object

The API data.
Source:

init(episode)

Initialises the event.

Parameters:
Name Type Description
episode Object

The episode of the event.
Source:

init(data)

Initialises the Menu model.

Parameters:
Name Type Description
data Object

The data.
Source:

init(contentId, bookmarkTime)

Initialises the event. This will trigger an event for a specific listener in the form of _bookmark, so we can update any progress if an asset is listening for bookmark change.

Parameters:
Name Type Description
contentId number

The content ID.
bookmarkTime number

The new bookmark time to update.
Source:

init(opts)

Initializes the top menu widget.

Parameters:
Name Type Description
opts Object

The widget opts.
Source:

init(id)

Initialises the container widget.

Parameters:
Name Type Description
id string

The id.
Source:

init(target)

Initialises the event.

Parameters:
Name Type Description
target Object

The target of the event.
Source:

init(target)

Initialises the event.

Parameters:
Name Type Description
target Object

The target of the event.
Source:

init(percentage, seekFinishedopt)

Initialises the event.

Parameters:
Name Type Attributes Description
percentage number

The percentage of seeking.
seekFinished boolean <optional>

True if the seeking has finished.
Source:

init(episode)

Initialises the event.

Parameters:
Name Type Description
episode Object

The episode of the event.
Source:

init(config)

Initialises the input widget.

Parameters:
Name Type Description
config Object

The configuration.

Properties
Name Type Description
title string

The input title.
inputField Object

The inputfield options.

Properties
Name Type Attributes Description
title Object

The inputfield title.
type string

The input type. TYPES.PASSWORD or TYPES.TEXT.
opts Object <optional>

The options. Optional.
Source:

init(data)

Initialises the Hero model.

Parameters:
Name Type Description
data Object

The API data.
Source:

init(status)

Initialises the event.

Parameters:
Name Type Description
status boolean

True if parental control is on, false if not.
Source:

init(target, id)

Initialises the event.

Parameters:
Name Type Description
target string

The target. episode or series.
id string

The id of the series or episode.
Source:

init(target, id, deleted)

Initialises the event.

Parameters:
Name Type Description
target string

The target. episode or series.
id string

The id of the series or episode.
deleted boolean

True if the recording has been deleted.
Source:

init(opts)

Initializes the base menu widget.

Parameters:
Name Type Description
opts Object

The widget opts.
Source:

init(target)

Initialises the event.

Parameters:
Name Type Description
target Object

The target of the event.
Source:

init(dataopt)

Initialises the widget.

Parameters:
Name Type Attributes Description
data Object <optional>

The data to be set.
Source:

init(data)

Initialises the Hero model.

Parameters:
Name Type Description
data Object

The API data.
Source:

init(target)

Initialises the event.

Parameters:
Name Type Description
target Object

The target of the event.
Source:

init(idopt)

Initialises the button.

Parameters:
Name Type Attributes Description
id string <optional>

The id. Optional.
Source:

init()

Init function.

Source:

init()

Initialises the widget.

Source:

init()

Initialises the widget.

Source:

init(data, heroParams)

Initialises the Hero widget.

Parameters:
Name Type Description
data Object

The Hero model.
heroParams Object

Params for hero widget.
Source:

init(text, idopt)

Initialises the button.

Parameters:
Name Type Attributes Description
text string

The button text.
id string <optional>

The id. Optional.
Source:

init(data)

Initialises the model.

Parameters:
Name Type Description
data Object

The data.
Source:

init(item)

Initialises the widget.

Parameters:
Name Type Description
item Object

The Broadcast model.
Source:

init()

Initialises the component.

Source:

init(data, watchallParams)

Initialises the watch all button.

Parameters:
Name Type Description
data Object

The event data.
watchallParams Object

Watchall widget params.
Source:

init(data)

Initialises the Hero model.

Parameters:
Name Type Description
data Array

The slider data.
Source:

init()

Initialises the recording manager.

Source:

init(initParams)

Initialises the widget.

Parameters:
Name Type Description
initParams Object

Contains the carousel configuration.
Source:

init(data)

Initialises the model.

Parameters:
Name Type Description
data Object

The API data.
Source:

init(initParams)

Initialises the component.

Parameters:
Name Type Description
initParams Object

Params to initialize error modal.

Properties
Name Type Description
classNames Array

Error class names.
Source:

init()

Initialises the widget.

Source:

init(idopt)

Initialises the player component.

Parameters:
Name Type Attributes Description
id string <optional>

Id of the player. Optional.
Source:

init()

Initialises the watch all component.

Source:

init()

Initialises the component.

Source:

init()

Initialises the component.

Source:

init()

Initializes component.

Source:

init(data)

Initialises the channel model.

Parameters:
Name Type Description
data Object

Init data.
Source:

init()

Initialises the login component.

Source:

init(opts)

Initializes the base menu widget.

Parameters:
Name Type Description
opts Object

The widget opts.
Source:

init()

Initialises the component.

Source:

init(appDiv, styleDir, imgDir, callback)

The init method initializes the Application object, here it is only used to call the method on rofl/application, but can be used in your application for setting some initial application values.

Parameters:
Name Type Description
appDiv HTMLElement

The application element which should be handled as root element.
styleDir Object

The directory used for stylesheets.
imgDir Object

The directory used for images (can be used for preloading).
callback function

Function to call when application.ready() is called (usually used to destroy splash screens).
Source:

init()

Initialises the component.

Source:

init(data)

Initialises the Filter widget.

Parameters:
Name Type Description
data Object

The Filter model.
Source:

init()

Initialises the component.

Source:

init(detail)

Initialises the component.

Parameters:
Name Type Description
detail string

Detail type to create.
Source:

init()

Initialises the view.

Source:

init(idopt, classNamesopt, modalConfigopt)

Initialises the component.

Parameters:
Name Type Attributes Description
id string <optional>

The id.
classNames Array <optional>

The modal's class names.
modalConfig Object <optional>

Additional modal configuration params.
Source:

init(data)

Initialises the series model.

Parameters:
Name Type Description
data Object

The data.
Source:

init()

Initialises the component.

Source:

init()

Initialises the modal.

Source:

init(direction)

Initialises the pointer widget.

Parameters:
Name Type Description
direction string

The direction.
Source:

init()

Initialises the player view.

Source:

init(data, carouselParamsopt)

Initialises the widget.

Parameters:
Name Type Attributes Description
data Object

The Carousel model.
carouselParams Object <optional>

Specific params to use for the carousel.

Properties
Name Type Attributes Description
layout Object <optional>

Asset layout.
formatter Object <optional>

Asset formatter.
numberOfVisibleItemsOnScreen Object <optional>

Max number of visible items.
Source:

init()

Initialises the widget.

Source:

init()

Initialises the input widget.

Source:

init(dataopt, paramsopt)

Initialises the widget.

Parameters:
Name Type Attributes Description
data Object <optional>

The data. Optional.
params Object <optional>

Additional params.
Source:

init(id, config)

Initialises the grid.

Parameters:
Name Type Description
id string

The id.
config Object

The config.
Source:

init()

Initialises the widget.

Source:

init(config)

Initialises the MasonryGrid.

Parameters:
Name Type Description
config Object

The configuration.

Properties
Name Type Description
columns number

The columns needed.
types Array

The types of grid items.
Source:

init(data, channel)

Initialises the EPG Item.

Parameters:
Name Type Description
data Object

The data.
channel Object

The channel the epg item belongs to.
Source:

init(opts)

Initializes the component.

Parameters:
Name Type Description
opts Object

The options object.
Source:

init()

Initialises the session manager.

Source:

init(config)

Initialises the keyboard widget.

Parameters:
Name Type Description
config Object

The inputfield options.

Properties
Name Type Attributes Description
opts Object <optional>

The options. Optional.
Source:

init()

Initialises the component.

Source:

init(sliderItemParams, idopt)

Initialises the button.

Parameters:
Name Type Attributes Description
sliderItemParams Object

The slider item configuration params.
id string <optional>

The id. Optional.
Source:

init(data)

Initialises the widget.

Parameters:
Name Type Description
data Object

The detail data.
Source:

init()

Initialises the channel manager.

Source:

init()

Initialises the component.

Source:

init(text, idopt)

Initialises the button.

Parameters:
Name Type Attributes Description
text string

The button text.
id string <optional>

The id. Optional.
Source:

init(directionopt)

Gradient initialisation.

Parameters:
Name Type Attributes Description
direction string <optional>

The direction. Defaults to TOPDOWN.
Source:

init(config)

Initialises the inputfield widget.

Parameters:
Name Type Description
config Object

The configuration.

Properties
Name Type Attributes Description
title string

The input title.
type string

The input type. TYPES.PASSWORD or TYPES.TEXT.
opts Object <optional>

The options. Optional.
Source:

init()

Initialises the widget.

Source:

init()

Initialises the widget.

Source:

init(id)

Initialises the pointer widget.

Parameters:
Name Type Description
id string

The id.
Source:

init(data)

Initialises the widget.

Parameters:
Name Type Description
data Object

The data.

Properties
Name Type Attributes Description
item Object

Contains the model item.
title string

The title for this assset.
subtitle string

The subtitle for this asset.
lockedTitle string

The title for this asset when locked.
logo string <optional>

The logo url.
background string

The image url.
lockedBackground string <optional>

The locked image url.
startTime number <optional>

The content's start time.
endTime number <optional>

The content's end time.
topRightIcon string <optional>

The top right icon classname.
bottomRightIcon string <optional>

The bottom right icon classname.
topLeftText string <optional>

Top left text to show.
gradient boolean <optional>

True if the gradient should show.
progressbar boolean <optional>

True if the progressbar should show.
setBookmarkProgress boolean <optional>

True if the progressbar should be filled with bookmark time.
playOnSelect boolean <optional>

True if the asset should skip details and play after selected.
Source:

init(id, animationEnabled)

Initializes the button.

Parameters:
Name Type Description
id string

Button id.
animationEnabled boolean

Animations enabled or not.
Source:

init(config)

Initialises the button.

Parameters:
Name Type Description
config Object

The config objects.
Source:

init(text, idopt)

Initialises the button.

Parameters:
Name Type Attributes Description
text string

The button text.
id string <optional>

The id. Optional.
Source:

init(config)

Initialises the input widget.

Parameters:
Name Type Description
config Object

The configuration.

Properties
Name Type Description
inputField Object

The inputfield options.

Properties
Name Type Attributes Description
opts Object <optional>

The options. Optional.
Source:

init()

Initialises the replay component.

Source:

init()

Initialises the input widget.

Source:

init(id, animationEnabled)

Initializes the button.

Parameters:
Name Type Description
id string

Button id.
animationEnabled boolean

Animations enabled or not.
Source:

init()

Initialises the login component.

Source:

init(gridParams)

Initialize Grid.

Parameters:
Name Type Description
gridParams Object

Grid configuration params.
Source:

initialize()

Initialises the decorator.

Source:

initPlayer(playerProperties)

Initialises the widget.

Parameters:
Name Type Description
playerProperties * | PlayerProperties

The player properties.
Source:

initPlayer(playerProperties)

Initialises the widget.

Parameters:
Name Type Description
playerProperties * | PlayerProperties

The player properties.
Source:

isActive() → {boolean}

Returns true if the warm welcome is active.

Source:
Returns:
  • True if the warm welcome is active.
Type
boolean

isBookmarkLayout() → {boolean}

Returns true if the carousel's layout is Bookmark styled.

Source:
Returns:
  • True if matches the layout.
Type
boolean

isBrandingEnabled() → {boolean}

Returns true if the branding is enabled.

Source:
Returns:

Enabled.

Type
boolean

isBroadcastLocked(broadcast) → {boolean}

Returns true if the broadcast is locked.

Parameters:
Name Type Description
broadcast Object

The broadcast.
Source:
Returns:
  • True if the broadcast is locked.
Type
boolean

isBundles() → {boolean}

Returns true if the content is type group of bundles.

Source:
Returns:
  • True if the content is type group of bundles.
Type
boolean

isContentExpanded() → {boolean}

Checks if the bottom bar content is showing miniEPG or programInfo.

Source:
Returns:
  • True if there's expanded content, false if not.
Type
boolean

isContentExpanded() → {boolean}

Checks if there's come content currently expanded.

Source:
Returns:
  • True if there's expanded content, false if not.
Type
boolean

isEnabled() → {boolean}

Returns true if the service message is enabled and can be shown.

Source:
Returns:
  • True if the message can and should be shown.
Type
boolean

isEntryConfirmed() → {boolean}

Returns true if the entry is confirmed.

Source:
Returns:
  • True if the entry is confirmed.
Type
boolean

isEpgLayout() → {boolean}

Returns true if the carousel's layout is EPG styled.

Source:
Returns:
  • True for sports editorial block.
Type
boolean

isEpgLayout() → {boolean}

Returns true if the carousel's layout is EPG styled.

Source:
Returns:
  • True if matches the layout.
Type
boolean

isExpanded() → {boolean}

Checks if program details info is expanded.

Source:
Returns:
  • True if program details info is expanded.
Type
boolean

isExpanded() → {boolean}

Checks if miniEPG is expanded.

Source:
Returns:
  • True if miniEPG is expanded.
Type
boolean

isFocusable() → {boolean}

Returns if menu can be focused.

Source:
Returns:
  • Is focusable.
Type
boolean

isFocusable() → {boolean}

Determines if the widget is focusable.

Source:
Returns:
  • The focusable state.
Type
boolean

isFocusable() → {boolean}

Determines if the widget is focusable.

Source:
Returns:
  • True if the widget is focusable.
Type
boolean

isFocusable() → {boolean}

Determines if the widget is focusable.

Source:
Returns:
  • True if the widget is focusable.
Type
boolean

isFocusable() → {boolean}

Returns if menu can be focused.

Source:
Returns:
  • Is focusable.
Type
boolean

isFocusable() → {boolean}

Returns true if carousel is focusable.

Source:
Returns:
  • True if is focusable.
Type
boolean

isFocusable() → {boolean}

Returns true if carousel is focusable.

Source:
Returns:
  • True if bullets are focusable.
Type
boolean

isFocusable() → {boolean}

Determines if the widget is focusable.

Source:
Returns:
  • True if the widget is focusable.
Type
boolean

isFutureItem() → {boolean}

Returns true if broadcast is in the future.

Source:
Returns:
  • Is future item.
Type
boolean

isHomeEnabled() → {boolean}

Returns true if the home feature is enabled.

Source:
Returns:
  • True if home is enabled.
Type
boolean

isInt(n) → {boolean}

Checks if number is an integer.

Parameters:
Name Type Description
n number

Number.
Source:
Returns:
  • True or false.
Type
boolean

isLive() → {boolean}

Checks if the video is live type.

Source:
Returns:
  • True if the video type is live item.
Type
boolean

isLive() → {boolean}

Returns true if the video is currently playing.

Source:
Returns:
  • True if the video is currently playing.
Type
boolean

isLive() → {boolean}

Returns true if the video is currently playing.

Source:
Returns:
  • True if the video is currently playing.
Type
boolean

isLive() → {boolean}

Checks if the video is live type.

Source:
Returns:
  • True if the video type is live item.
Type
boolean

isLiveTrickplayEnabled() → {boolean}

Checks whether trickplay in live streams is allowed/enabled.

Source:
Returns:

Enabled.

Type
boolean

isLocked() → {boolean}

Checks whether asset is parental protected.

Source:
Returns:
  • True if is child protected.
Type
boolean

isLocked() → {boolean}

Returns true if the broadcast is locked.

Source:
Returns:
  • True if the broadcast is locked.
Type
boolean

isLocked() → {boolean}

Checks if the content item is locked.

Source:
Returns:
  • Returns true for locked items.
Type
boolean

isLocked() → {boolean}

Returns true if the broadcast is locked.

Source:
Returns:
  • True if the broadcast is locked.
Type
boolean

isLocked() → {boolean}

Checks if the content item is locked.

Source:
Returns:
  • Returns true for locked items.
Type
boolean

isLocked() → {boolean}

Returns true if the broadcast is locked.

Source:
Returns:
  • True if the broadcast is locked.
Type
boolean

isLocked(item) → {boolean}

Checks whether asset is child protected.

Parameters:
Name Type Description
item Object

The data item.
Source:
Returns:
  • True if is child protected.
Type
boolean

isLocked() → {boolean}

Checks if the slider item is locked.

Source:
Returns:
  • True if slider item content is locked.
Type
boolean

isLocked() → {boolean}

Checks whether asset is child protected.

Source:
Returns:
  • True if is child protected.
Type
boolean

isLocked() → {boolean}

Returns true if the broadcast is locked.

Source:
Returns:
  • True if the broadcast is locked.
Type
boolean

isLoggedIn() → {boolean}

Returns true if the user is logged in.

Source:
Returns:
  • Returns true if the user is logged in.
Type
boolean

isMoviesEnabled() → {boolean}

Returns true if the movies feature is enabled.

Source:
Returns:
  • True if movies is enabled.
Type
boolean

isOutOfHome() → {boolean}

Returns true if the user is out of home.

Source:
Returns:
  • True if the user is out of home.
Type
boolean

isOutOfHomeEnabled() → {boolean}

Returns true if out of home is enabled.

Source:
Returns:
  • True if out of home is enabled.
Type
boolean

isParentalEnabled() → {boolean}

Returns true if parental is enabled.

Source:
Returns:
  • True if parental is enabled.
Type
boolean

isParentalOn() → {boolean}

Returns true if parental is on.

Source:
Returns:
  • True if parental is on.
Type
boolean

isPaused() → {boolean}

Checks if the media player state is playing.

Source:
Returns:
  • True if the media player state is playing.
Type
boolean

isPaused() → {Object}

Gets the play pause button.

Source:
Returns:
  • The play pause button.
Type
Object

isPaused() → {boolean}

Checks if the media player state is playing.

Source:
Returns:
  • True if the media player state is playing.
Type
boolean

isPlayable() → {boolean}

Returns true if the item is playable.

Source:
Returns:
  • True if the item is playable.
Type
boolean

isPlayable() → {boolean}

Returns true if the item is playable.

Source:
Returns:
  • True if the item is playable.
Type
boolean

isPlaying() → {boolean}

Checks if the media player state is playing.

Source:
Returns:
  • True if the media player state is playing.
Type
boolean

isPlaying() → {boolean}

Checks if the media player state is playing.

Source:
Returns:
  • True if the media player state is playing.
Type
boolean

isRecording() → {boolean}

Returns true if the content type is a recording.

Source:
Returns:
  • Is recording.
Type
boolean

isRecordingEnabled() → {boolean}

Checks whether recordings are allowed/enabled.

Source:
Returns:

Enabled.

Type
boolean

isReplayEnabled() → {boolean}

Checks whether replay streams are allowed/enabled.

Source:
Returns:

Enabled.

Type
boolean

isReplayItem() → {boolean}

Returns true if the item is a replay item.

Source:
Returns:
  • True if the item is a replay item.
Type
boolean

isReplayItem() → {boolean}

Returns true if the item is a replay item.

Source:
Returns:
  • True if the item is a replay item.
Type
boolean

isRestart() → {boolean}

Checks if the video is restart type.

Source:
Returns:
  • True if the video type is restart item.
Type
boolean

isRestart() → {boolean}

Checks if the video is restart type.

Source:
Returns:
  • True if the video type is restart item.
Type
boolean

isRestartEnabled() → {boolean}

Checks whether restart streams are allowed/enabled.

Source:
Returns:

Enabled.

Type
boolean

isSeekActive() → {boolean}

Checks if seeking is active.

Source:
Returns:
  • Returns true if seeking is active.
Type
boolean

isSeriesEnabled() → {boolean}

Returns true if the series feature is enabled.

Source:
Returns:
  • True if series is enabled.
Type
boolean

isSessionLoggedIn() → {boolean}

Checks the session manager if user is logged in.

Source:
Returns:
  • True if logged in.
Type
boolean

isSessionLoggedIn() → {boolean}

Checks the session manager if user is logged in.

Source:
Returns:
  • True if logged in.
Type
boolean

isSportsEnabled() → {boolean}

Returns true if the sports feature is enabled.

Source:
Returns:
  • True if sports is enabled.
Type
boolean

isSubmenu() → {boolean}

Checks if the section is a submenu.

Source:
Returns:
  • Is submenu.
Type
boolean

isSubmenuVisible() → {boolean}

Checks if submenu is visible or not.

Source:
Returns:
  • Is submenu visible.
Type
boolean

isSubtitlesEnabled() → {boolean}

Returns true if subtitles is enabled.

Source:
Returns:
  • True if subtitles is enabled.
Type
boolean

isSurveyEnabled() → {boolean}

Returns true if the survey feature is enabled.

Source:
Returns:
  • True if survey is enabled.
Type
boolean

isTrickplayEnabled() → {boolean}

Returns true if the device supports trickplay.

Source:
Returns:
  • True if the device supports trickplay.
Type
boolean

isTrickplayEnabled() → {boolean}

Checks whether trickplay in streams is allowed/enabled.

Source:
Returns:

Enabled.

Type
boolean

isUIVisible() → {boolean}

Returns true if the UI is visible.

Source:
Returns:
  • True if the UI is visible.
Type
boolean

isUIVisible() → {boolean}

Checks if player ui is visible.

Source:
Returns:
  • True if ui is visible.
Type
boolean

isUIVisible() → {boolean}

Returns true if the UI is visible.

Source:
Returns:
  • True if the UI is visible.
Type
boolean

isVOD() → {boolean}

Returns true if the video is type VOD.

Source:
Returns:
  • True if the video is type VOD.
Type
boolean

isVodEpisode() → {boolean}

Returns true if the video is subtype EPISODE.

Source:
Returns:
  • True if the video is subtype EPISODE.
Type
boolean

listen(listener)

Sets a listener for mediaplayer events.

Parameters:
Name Type Description
listener function

Event listener for media player events.
Source:

listen(listener)

Sets a listener for mediaplayer events.

Parameters:
Name Type Description
listener function

Event listener for media player events.
Source:

load() → {*|Promise.<any>}

Loads the new media source.

Source:
Returns:
  • The prepared media source.
Type
* | Promise.<any>

load() → {Promise}

Loads the channels from API and sets them in the manager.

Source:
Returns:
  • Promise resolving with the channels.
Type
Promise

load(channelIds, time) → {Promise}

Loads the data for the given channel ids and time.

Parameters:
Name Type Description
channelIds Array

The channel ids.
time number

The time in seconds.
Source:
Returns:
  • Promise resolving with epg data.
Type
Promise

load() → {*|Promise.<any>}

Loads the new media source.

Source:
Returns:
  • The prepared media source.
Type
* | Promise.<any>

loadData(channelIds, time) → {Promise}

Initiator of the EPG data loading.

Parameters:
Name Type Description
channelIds Array

Channel ID's to fetch.
time number

Regulated time for fetching the correct time slot.
Source:
Returns:

The load promise.

Type
Promise

loadData(callbacks)

Retrieves the onboarding screens.

Parameters:
Name Type Description
callbacks Object

Returns array with onboarding screen items.
Source:

loadMore(prepend)

Loads more data.

Parameters:
Name Type Description
prepend boolean

True if the data should be prepended.
Source:

lock()

Locks the asset.

Source:

lock()

Locks the asset.

Source:

login(username, password) → {Promise}

Logs the user in.

Parameters:
Name Type Description
username string

The username.
password string

The password.
Source:
Returns:
  • Promise resolving after logging in.
Type
Promise

logout() → {Promise}

Logs the user out.

Source:
Returns:
  • Promise resolving after logging out.
Type
Promise

manualAlignToIndex(index, opts)

Executes a manual align to index.

Parameters:
Name Type Description
index number

The index.
opts Object

Options.
Source:

mouseLeaveHandler()

Handles the mouse leave event.

Source:

mouseOverHandler()

Handles the mouse over event.

Source:

mouseOverHandler()

Handles the mouse over event.

Source:

mouseOverHandler()

Handles the mouse over event.

Source:

next()

Goes to the next screen.

Source:

next()

Go to next onboarding screen.

Source:

onAfterShow()

AfterShow event.

Source:

onAfterShow()

AfterShow event.

Source:

onAfterShow()

AfterShow event.

Source:

onAfterShow()

After show event.

Source:

onAfterShow()

AfterShow event. Make sure the focus is always on the new version popup.

Source:

onAfterShow()

AfterShow event.

Source:

onAfterShow()

AfterShow event.

Source:

onAfterShow()

OnAfterShow event.

Source:

onAfterShow()

AfterShow event.

Source:

onBeforeHide()

BeforeHide event.

Source:

onBeforeHide()

BeforeHide event.

Source:

onBeforeHide()

BeforeHide event.

Source:

onBeforeHide()

BeforeHide event.

Source:

onBeforeHide()

BeforeHide event.

Source:

onBeforeHide()

BeforeHide event.

Source:

onBeforeHide()

OnBeforeHide event handler.

Source:

onBeforeHide()

BeforeHide event.

Source:

onBeforeHide()

BeforeHide event.

Source:

onBeforeHide()

BeforeHide event.

Source:

onBeforeHide()

On before hide event.

Source:

onBeforeHide()

BeforeHide event.

Source:

onBeforeHide(e)

On before hide event.

Parameters:
Name Type Description
e Object

The before show event.
Source:

onBeforeHide()

BeforeHide event.

Source:

onBeforeHide()

BeforeHide event.

Source:

onBeforeHide()

BeforeHide event.

Source:

onBeforeHide()

BeforeHide event.

Source:

onBeforeHide()

BeforeHide event.

Source:

onBeforeHide()

Reset the modal.

Source:

onBeforeHide()

Before hide event.

Source:

onBeforeHide()

OnBeforeHide event.

Source:

onBeforeHide()

BeforeHide event.

Source:

onBeforeHide()

Before hide event.

Source:

onBeforeHide()

BeforeHide event.

Source:

onBeforeHide()

OnBeforeHideEvent.

Source:

onBeforeHide()

BeforeHide event.

Source:

onBeforeRender()

BeforeRender event.

Source:

onBeforeRender()

BeforeRender event.

Source:

onBeforeRender()

BeforeRender event.

Source:

onBeforeRender()

BeforeRender event.

Source:

onBeforeRender()

BeforeRender event.

Source:

onBeforeRender()

BeforeRender event.

Source:

onBeforeRender()

BeforeRender event.

Source:

onBeforeRender()

BeforeRender event.

Source:

onBeforeRender()

BeforeRender event.

Source:

onBeforeRender()

OnBeforeRenderEvent.

Source:

onBeforeRender()

BeforeRender event.

Source:

onBeforeRender()

On before render event.

Source:

onBeforeShow(e)

On before show event.

Parameters:
Name Type Description
e Object

The before show event.
Source:

onBeforeShow()

BeforeShow event.

Source:

onBeforeShow(e)

BeforeShow event.

Parameters:
Name Type Description
e Object

The event parameters.
Source:

onBeforeShow(e)

BeforeShow event.

Parameters:
Name Type Description
e event

Passed event.
Source:

onBeforeShow(e)

BeforeShow event.

Parameters:
Name Type Description
e Event

Event.
Source:

onBeforeShow(e)

BeforeShow event.

Parameters:
Name Type Description
e Object

The event data.
Source:

onBeforeShow()

OnBeforeShow event handler.

Source:

onBeforeShow(e)

BeforeShow event.

Parameters:
Name Type Description
e Object

The event data.

Properties
Name Type Description
args Object

The event arguments.

Properties
Name Type Description
item Object

The record item.
callback function

The callback to execute once the modal has executed.
callingComponent string

The component that should receive focus after closing.
Source:

onBeforeShow(event)

Before show event.

Parameters:
Name Type Description
event event

Config.
Source:

onBeforeShow(e)

BeforeShow event.

Parameters:
Name Type Description
e Object

The event data.
Source:

onBeforeShow(e)

BeforeShow event.

Parameters:
Name Type Description
e Object

The event data.
Source:

onBeforeShow(e)

BeforeShow event.

Parameters:
Name Type Description
e Object

The event data.
Source:

onBeforeShow(e)

BeforeShow event.

Parameters:
Name Type Description
e Object

The event data.
Source:

onBeforeShow()

BeforeShow event.

Source:

onBeforeShow(e)

Before show event.

Parameters:
Name Type Description
e Object

The event data.
Source:

onBeforeShow(e)

BeforeShow event.

Parameters:
Name Type Description
e Object

The event data.
Source:

onBeforeShow(e)

Before show event.

Parameters:
Name Type Description
e Event

Event.
Source:

onBeforeShow(e)

Before show event.

Parameters:
Name Type Description
e Object

Event.
Source:

onBeforeShow(e)

BeforeShow event.

Parameters:
Name Type Description
e Object

The event data.
Source:

onBeforeShow()

BeforeShow event.

Source:

onBeforeShow()

Before show event.

Source:

onBeforeShow(event)

Before show event.

Parameters:
Name Type Description
event event

Config.
Source:

onBeforeShow(e)

BeforeShow event.

Parameters:
Name Type Description
e Object

The event data.
Source:

onBeforeShow(e)

BeforeRender event.

Parameters:
Name Type Description
e Object

Inherited data.
Source:

onBeforeShow(e)

BeforeShow event.

Parameters:
Name Type Description
e Object

The event data.
Source:

onBeforeShow(e)

BeforeShow event.

Parameters:
Name Type Description
e Object

The event data.
Source:

onBeforeShow(e)

On before show event.

Parameters:
Name Type Description
e Object

The on before show event data.
Source:

onBeforeShow()

BeforeShow event.

Source:

onBeforeShow(event)

OnBeforeShowEvent.

Parameters:
Name Type Description
event Event

Event.

Properties
Name Type Description
args.title string

The modal title.
args.text string

The modal text.
args.confirmButtonLabel string

The modal confirm button label.
args.callback function

The callback function, which focuses back on component which called modal component.
Source:

onBeforeShow()

BeforeShow event.

Source:

onBeforeShow(event)

BeforeShow event.

Parameters:
Name Type Description
event Event

Event.
Source:

onBeforeShow()

BeforeShow event.

Source:

onBeforeShow(e)

BeforeShow event.

Parameters:
Name Type Description
e Object

The event data.
Source:

onBlur(e)

Blur event.

Parameters:
Name Type Description
e Object

The event data.
Source:

onBlur()

Blur event.

Source:

onError(error)

Handles errors.

Parameters:
Name Type Description
error Object

An error event.
Source:

onError(error)

Handles errors.

Parameters:
Name Type Description
error Object

An error event.
Source:

onFastForward()

Focuses on ff.

Source:

onFastForward()

Focuses on ff.

Source:

onFocus(e)

Gets executed when the focus changes.

Parameters:
Name Type Description
e Object

The event data.
Source:

onFocus(e)

Gets executed when item is focussed.

Parameters:
Name Type Description
e Object

The event data.
Source:

onKeyDown(e)

OnKeyDown event for first vie.

Parameters:
Name Type Description
e Object

Event.
Source:

onKeyDown(e)

KeyDown event listener.

Parameters:
Name Type Description
e Object

The event params.
Source:

onMiniEPG(deselect)

Toggle miniEPG button.

Parameters:
Name Type Description
deselect boolean

True if the button should deselect.
Source:

onMouseFocus(e)

Gets executed on mouse focus.

Parameters:
Name Type Description
e Object

The event data.
Source:

onPause()

Marks a pause.

Source:

onPause(focusPlayPause)

Should be called when the video player pauses.

Parameters:
Name Type Description
focusPlayPause boolean

True if should focus on playpause button.
Source:

onPause()

Should be called when the video player pauses.

Source:

onPause(focusPlayPause)

Should be called when the video player pauses.

Parameters:
Name Type Description
focusPlayPause boolean

True if should focus on playpause button.
Source:

onPlay()

Should be called when the video player plays.

Source:

onPlay()

Should be called when the video player plays.

Source:

onPlay()

Should be called when the video player plays.

Source:

onPlayerEvent(e)

PlayerEvent.

Parameters:
Name Type Description
e Object

The event data.
Source:

onPlayerEvent(e)

PlayerEvent.

Parameters:
Name Type Description
e Object

The event data.
Source:

onPlayStart(contentId, contentType)

Marks a playstart.

Parameters:
Name Type Description
contentId string

The content id.
contentType string

The content type.
Source:

onProgramInfo(deselect)

Toggle info buttons.

Parameters:
Name Type Description
deselect boolean

True if the button should deselect.
Source:

onRecord()

Sets the record state.

Source:

onRecord()

Sets the record state.

Source:

onRecord()

Sets the record state.

Source:

onRecording()

Sets the recording state.

Source:

onRecording()

Sets the recording state.

Source:

onRecording()

Sets the recording state.

Source:

onResume()

Marks a resume.

Source:

onRewind()

Focuses on rewind.

Source:

onRewind()

Focuses on rewind.

Source:

onSelectedItemChange(e)

Gets executed when the selected item changes.

Parameters:
Name Type Description
e Object

The event data.
Source:

onSelectedItemChange(e)

Gets executed when the selected item changes.

Parameters:
Name Type Description
e Object

The event data.
Source:

onSelectPartialsButton()

On select partials button handler.

Source:

onStop(channelIdopt, timeopt)

Marks a stop.

Parameters:
Name Type Attributes Description
channelId number <optional>

Force call in any player state.
time number <optional>

Video time to set in bookmark.
Source:

openMenu(value, shouldBlockMenuopt)

Show menu.

Parameters:
Name Type Attributes Description
value string

Parent component name passed from component.
shouldBlockMenu boolean <optional>

True if the menu should be blocked. which called the function.
Source:

orderSeasons(order) → {Array}

Orders the seasons in ascending or descending mode.

Parameters:
Name Type Description
order string

ASC or DESC order for the seasons.
Source:
Returns:
  • The ordered seasons.
Type
Array

parentaleErrorCallback(error)

Handle behaviour on error in parental pin entry pop-up.

Parameters:
Name Type Description
error Object

Error object.
Source:

parentaleEscapeCallback(backToChannelList)

Handle behaviour when user escapes the Parental Control Entry pop-up.

Parameters:
Name Type Description
backToChannelList boolean

Got to Channel list on pop-up escape.
Source:

parsedBookmarkTime(data) → {number}

Parse the bookmark object and returns the bookmark time.

Parameters:
Name Type Description
data Object

The data.
Source:
Returns:
  • The retrieved startDeltaTime aka bookmarktime.
Type
number

pause()

Pauses current playback.

Source:

pause()

Pauses current playback.

Source:

play(playerProperties)

Attepmts to play the given player properties from media source.

Parameters:
Name Type Description
playerProperties Object

Contains player properties such as source..
Source:

play(playerProperties)

Attepmts to play the given player properties from media source.

Parameters:
Name Type Description
playerProperties Object

Contains player properties such as source..
Source:

play(playerProperties)

Attepmts to play the given player properties from media source.

Parameters:
Name Type Description
playerProperties Object

Contains player properties such as source..
Source:

play(playerProperties)

Attepmts to play the given player properties from media source.

Parameters:
Name Type Description
playerProperties Object

Contains player properties such as source..
Source:

playOnSelect() → {boolean}

Checks if asset should play after select.

Source:
Returns:
  • Returns true if asset should play after selecting.
Type
boolean

prepare() → {Promise}

Prepares the widget and loads all required data.

Source:
Returns:
  • Promise resolving with the carousel model.
Type
Promise

prepare() → {Promise}

Prepares the widget and loads all required data.

Source:
Returns:
  • Promise resolving with the carousel model.
Type
Promise

prepare() → {Promise}

Prepares the widget and loads all required data.

Source:
Returns:
  • Promise resolving with the carousel model.
Type
Promise

prepare() → {Promise}

Prepares the widget and loads all required data.

Source:
Returns:
  • Promise resolving with the carousel model.
Type
Promise

prepare() → {Promise}

Makes sure the routing is ready to perform.

Source:
Returns:
  • The prepare promise.
Type
Promise

prepare() → {Promise}

Prepares the widget and loads all required data.

Source:
Returns:
  • Promise resolving with the carousel model.
Type
Promise

prepareCarousels() → {Promise}

Prepares the widget and loads all required data.

Source:
Returns:
  • Promise resolving with the slider item model.
Type
Promise

prepareHero() → {Promise}

Prepares the widget and loads all required data.

Source:
Returns:
  • Promise resolving with the slider hero model.
Type
Promise

prepareUser() → {Promise}

Prepares the user.

Source:
Returns:
  • Promise resolving after logging in.
Type
Promise

prependData(items, shouldFocusopt, shouldAlignopt)

Prepends more data to the grid.

Parameters:
Name Type Attributes Description
items Array

The items.
shouldFocus boolean <optional>

If the new row should be focused.
shouldAlign boolean <optional>

If aligning should happen.
Source:

prev()

Go to previous onboarding screen.

Source:

randomiseArray(items) → {Array}

Randomises an array.

Parameters:
Name Type Description
items Array

The items to randomise.
Source:
Returns:
  • The items randomised.
Type
Array

reactivate()

Reactivates the player.

Source:

read(modelReference, optsopt, retryFulFilledopt, retryRejectedopt) → {Promise}

Returns a Promise with an instance of the Model being requested.

Parameters:
Name Type Attributes Default Description
modelReference string | ModelInterface

Reference to the model or instance.
opts Object <optional>
 {}

Options object.

Properties
Name Type Attributes Default Description
params Object <optional>
 {}

Parameters object which is used for the cache key and in the resolveEndpoint method of the requested Model.
headers Object <optional>
 {}

Headers object which is used for the cache key.
notFromCache boolean <optional>

Whether it should get the model from cache if possible.
retryFulFilled * <optional>

Resolve function for repeating request after failure.
retryRejected * <optional>

Reject function for repeating request after failure.
Source:
Throws:

When the fetched model module isn't an instance of ModelInterface.

Type
Error
Returns:

Returns a Promise.

Type
Promise

ready()

Application ready handler.

Source:

record()

Changes buttons label to Record state.

Source:

recording()

Changes buttons label to Recording state.

Source:

refreshSessionToken() → {Promise}

Attempts so refresh session token.

Source:
Returns:
  • Refresh token promise.
Type
Promise

refreshToken() → {Promise}

Manually refresh users token.

Source:
Returns:
  • Refresh token promise.
Type
Promise

removeAll()

Removes all the widgets.

Source:

removeAll()

Removes all data.

Source:

removeChildWidgets()

Removes the child widgets.

Source:

removeListeners()

Removes the event listeners.

Source:

removeMouseLeaveHandler()

Removes the mouse leave handler.

Source:

removeMouseOverHandler()

Removes the mouse over handler.

Source:

removeMouseOverHandler()

Removes the mouse over handler.

Source:

removeSubmenus()

Removes the submenus.

Source:

render(device) → {Object}

Renders the widget.

Parameters:
Name Type Description
device Object

The device.
Source:
Returns:
  • The output element.
Type
Object

render(device) → {Element}

Pointer handling needs to be inited after widget is rendered.

Parameters:
Name Type Description
device Device

The current device.
Source:
Returns:
  • The rendered element.
Type
Element

render(device) → {Object}

Renders the widget.

Parameters:
Name Type Description
device Object

The device.
Source:
Returns:
  • The output element.
Type
Object

render() → {Object}

Renders the button.

Source:
Returns:

DOM node.

Type
Object

render() → {Object}

Renders the button.

Source:
Returns:

DOM node.

Type
Object

render(device) → {Object}

Renders the widget.

Parameters:
Name Type Description
device Object

The device.
Source:
Returns:
  • The output element.
Type
Object

render(device) → {Object}

Renders the component.

Parameters:
Name Type Description
device Object

The device.
Source:
Returns:
  • The output element.
Type
Object

render(device) → {Object}

Renders the widget.

Parameters:
Name Type Description
device Object

The device.
Source:
Returns:
  • The output element.
Type
Object

render(device) → {Object}

Renders the button.

Parameters:
Name Type Description
device Object

Device.
Source:
Returns:

DOM node.

Type
Object

render(device) → {Object}

Renders the widget.

Parameters:
Name Type Description
device Object

The device.
Source:
Returns:
  • The output element.
Type
Object

render(device) → {Object}

Renders the widget.

Parameters:
Name Type Description
device Object

The device.
Source:
Returns:
  • The output element.
Type
Object

render(device) → {Object}

Renders the widget.

Parameters:
Name Type Description
device Object

The device.
Source:
Returns:
  • The output element.
Type
Object

render(device) → {Element}

Pointer handling needs to be inited after widget is rendered.

Parameters:
Name Type Description
device Device

The current device.
Source:
Returns:
  • The rendered element.
Type
Element

render(d) → {Object}

Renders the widget.

Parameters:
Name Type Description
d Object

The device.
Source:
Returns:
  • The output element.
Type
Object

reportMenuItem(name)

Report selected menu item to Google Analytics.

Parameters:
Name Type Description
name string

The name of the selected item.
Source:

reset()

Resets the recording manager.

Source:

reset()

Resets the direct dial.

Source:

reset()

Resets keyboard state.

Source:

reset()

Resets the vertical carousel.

Source:

reset()

Resets the seek button.

Source:

reset()

Reset input widget.

Source:

reset()

Resets the controls.

Source:

reset()

Resets the aligner.

Source:

reset()

Resets the widget.

Source:

reset()

Resets the playpause button.

Source:

resetChannel()

Resets channel to play.

Source:

resetControls()

Attempts to reset trickmode buttons. (set them to initial state).

Source:

resetControls()

Attempts to reset the controls.

Source:

resetControls()

Attempts to reset trickmode buttons.

Source:

resetEntry()

Resets the entry.

Source:

resetFocus()

Reset grid focus.

Source:

resetFocus()

Reset the focus to the confirmation button.

Source:

resetLiveLabels()

Resets live button and labels to default live state.

Source:

resetLiveLabels()

Resets live button and labels to default live state.

Source:

resetLoadmoreIndex()

Reset the loadmore index.

Source:

resetPause()

Resets the pause position.

Source:

resetPauseLabel()

Removes the label text and pointer starts from 0.

Source:

resetStartEndIndex()

Reset the start / end index.

Source:

resetWarmWelcome()

Resets the warm welcome display.

Source:

resolveEndpoint() → {string}

Resolves the endpoint.

Source:
Returns:
  • The endpoint.
Type
string

resolveEndpoint(params) → {string}

Resolves the endpoint.

Parameters:
Name Type Description
params Object

Search parameters.

Properties
Name Type Description
query string

Text to be searched for in the backend.
Source:
Returns:

Resolved endpoint.

Type
string

resolveEndpoint(params) → {string}

Resolves the endpoint.

Parameters:
Name Type Description
params Object

The parameters.
Source:
Returns:
  • The endpoint.
Type
string

resolveEndpoint(params) → {string}

This will create an URL to call on API.

Parameters:
Name Type Description
params Object

Parameters to determine the endpoint.

Properties
Name Type Description
type string

The type of promo video (promo or intro).
Source:
Returns:
  • The endpoint.
Type
string

resolveEndpoint(params) → {string}

Resolves the endpoint.

Parameters:
Name Type Description
params Object

The parameters.

Properties
Name Type Attributes Description
type string

The stream type. LIVE, RESTART or VOD.
contentId string

The content id.
assetId string

The asset id.
stop boolean <optional>

True if it should stop the stream. Optional.
Source:
Returns:
  • The endpoint.
Type
string

resolveEndpoint(params) → {string}

Resolves the endpoint.

Parameters:
Name Type Description
params Object

The parameters.
Source:
Returns:
  • The endpoint.
Type
string

resolveEndpoint() → {string}

Resolves the endpoint.

Source:
Returns:
  • Endpoint.
Type
string

resolveEndpoint() → {string}

Resolves the endpoint.

Source:
Returns:
  • Endpoint.
Type
string

resolveEndpoint(params) → {string}

Resolves the endpoint.

Parameters:
Name Type Description
params Object

The endpoint params.
Source:
Returns:
  • The endpoint.
Type
string

resolveEndpoint(params) → {string}

Parameters:
Name Type Description
params Object

Stream params.

Properties
Name Type Description
data Object

The content's data to request the url.
Source:
Returns:
  • The endpoint.
Type
string

resolveEndpoint(params) → {string}

Resolves the endpoint.

Parameters:
Name Type Description
params Object

Search parameters.

Properties
Name Type Description
query string

Text to be searched for in the backend.
Source:
Returns:
  • Resolved endpoint.
Type
string

resolveEndpoint() → {Object}

Resolves the endpoint.

Source:
Returns:
  • The endpoint.
Type
Object

resolveEndpoint(params) → {string}

Resolves the endpoint.

Parameters:
Name Type Description
params Object

The endpoint params.
Source:
Returns:
  • The endpoint.
Type
string

resolveEndpoint(params) → {string}

Parameters:
Name Type Description
params Object

Stream params.

Properties
Name Type Description
data Object

The content's data to request the url.
Source:
Returns:
  • The endpoint.
Type
string

resolveEndpoint(params) → {string}

Resolves the endpoint.

Parameters:
Name Type Description
params Object

Search parameters.

Properties
Name Type Description
query string

Text to be searched for in the backend.
Source:
Returns:

Resolved endpoint.

Type
string

resolveEndpoint(params) → {string}

Resolves the endpoint.

Parameters:
Name Type Description
params Object

The parameters.

Properties
Name Type Attributes Description
type string

The stream type. LIVE or VOD.
contentId string

The content id.
stop boolean <optional>

True if it should stop the stream. Optional.
Source:
Returns:
  • The endpoint.
Type
string

resolveEndpoint() → {string}

Resolves the endpoint.

Source:
Returns:
  • The endpoint.
Type
string

resolveEndpoint(params) → {string}

Resolves the endpoint.

Parameters:
Name Type Description
params Object

The parameters.

Properties
Name Type Attributes Description
type string

The stream type. LIVE or VOD.
contentId string

The content id.
stop boolean <optional>

True if it should stop the stream. Optional.
Source:
Returns:
  • The endpoint.
Type
string

resolveEndpoint() → {string}

Resolves the endpoint.

Source:
Returns:
  • The endpoint url.
Type
string

resolveEndpoint(paramsopt) → {string}

Resolves the endpoint.

Parameters:
Name Type Attributes Description
params Object <optional>

Parameters. Optional.

Properties
Name Type Attributes Description
channels Array <optional>

Channel identifiers. Optional.
Source:
Returns:
Type
string

resolveEndpoint() → {string}

Returns the api endpoint.

Source:
Returns:
  • The api endpoint.
Type
string

resolveEndpoint(params) → {string}

Resolves the endpoint.

Parameters:
Name Type Description
params Object

The parameters.
Source:
Returns:
  • The endpoint.
Type
string

resolveEndpoint(params) → {string}

Resolves the endpoint.

Parameters:
Name Type Description
params Object

Search parameters.

Properties
Name Type Description
query string

Text to be searched for in the backend.
Source:
Returns:

Resolved endpoint.

Type
string

resolveEndpoint() → {string}

Returns the api endpoint.

Source:
Returns:
  • The api endpoint.
Type
string

resolveEndpoint(params) → {string}

This will create an URL to call on API.

Parameters:
Name Type Description
params Object

Parameters to determine the endpoint.
Source:
Returns:
  • The endpoint.
Type
string

resolveEndpoint() → {string}

Returns the api endpoint.

Source:
Returns:
  • The api endpoint.
Type
string

resolveEndpoint(params) → {string}

Resolves the endpoint.

Parameters:
Name Type Description
params Object

The endpoint params.
Source:
Returns:
  • The endpoint.
Type
string

resolveEndpoint(params) → {string}

Resolves the endpoint.

Parameters:
Name Type Description
params Object

Stream params.

Properties
Name Type Description
data Object

The content's data to request the url.
Source:
Returns:
  • The endpoint.
Type
string

resolveEndpoint() → {string}

Resolves the endpoint.

Source:
Returns:
  • The endpoint.
Type
string

resolveEndpoint() → {string}

Resolves the endpoint.

Source:
Returns:
  • The endpoint in string.
Type
string

resolveEndpoint() → {string}

Returns the api endpoint.

Source:
Returns:
  • The api endpoint.
Type
string

resolveEndpoint(params) → {string}

Resolves the endpoint.

Parameters:
Name Type Description
params Object

The parameters.
Source:
Returns:
  • Endpoint.
Type
string

resolveEndpoint(params) → {string}

Resolves the endpoint.

Parameters:
Name Type Description
params Object

The parameters (optional).
Source:
Returns:
  • Endpoint.
Type
string

resolveEndpoint() → {string}

Returns the api endpoint.

Source:
Returns:
  • The api endpoint.
Type
string

resolveEndpoint(params) → {string}

Resolves the endpoint.

Parameters:
Name Type Description
params Object

The parameters.

Properties
Name Type Description
type string

The stream type. LIVE, RESTART or VOD.
contentId string

The content id.
assetId string

The asset id.
Source:
Returns:
  • The endpoint.
Type
string

resume()

Resumes the current playback.

Source:

resume()

Resumes the current playback.

Source:

route(path, opts)

The application route method, this is executed by the application on startup (_default route) and can be used to route to different screens within the application.

Parameters:
Name Type Description
path String | Array

The route you want to used, defined in the config. Can also be an array in the case of deeplinks.
opts Object

The options object can contain information you want to use in the route.
Source:

routeToPage(page, channelId)

Route to the specified page after player has been initialized.

Parameters:
Name Type Description
page string

The page to route.
channelId Number | undefined

The last channel ID.
Source:

run()

Run is the method used by the application after the application is initialized, here we create our root widget (onto which everything is added).

Source:

Send search request to the backend.

Parameters:
Name Type Description
query string

Phrase to look for ion the database.
startTime number

Start time to filter.
endTime number

End time to filter.
genre string

Genre.
Source:
Returns:

Returns Promise, that resolves to array of SearchResult objects.

Type
Promise

searchByGenre(genre, startTime, endTime, filterProgramTypeopt) → {Promise}

Searches api for content of genre.

Parameters:
Name Type Attributes Description
genre string

Genre.
startTime number

Start time to filter.
endTime number

End time to filter.
filterProgramType boolean <optional>

Should genre filtering happen in Program type.
Source:
Returns:
  • Returns Promise that resolves with search data.
Type
Promise

searchContent(searchData) → {Promise}

Executes search request to the backend.

Parameters:
Name Type Description
searchData string

Contains the search params to be requested.
Source:
Returns:

Returns Promise, that resolves to array of SearchResult objects.

Type
Promise

searchPlaceholders() → {Promise}

Requests placeholder content.

Source:
Returns:
  • Returns Promise that resolves with placeholders data.
Type
Promise

secondsHumanReadable(seconds) → {string}

Format time into human readable format.

Parameters:
Name Type Description
seconds Integer

The amount of seconds you want to convert.
Source:
Returns:
  • Hours left to midnight.
Type
string

secondsHumanReadableString(seconds) → {string}

Format time into human readable format.

Parameters:
Name Type Description
seconds Integer

The amount of seconds you want to convert.
Source:
Returns:
  • Hours left to midnight.
Type
string

seek(value)

Seeks to the given value.

Parameters:
Name Type Description
value number

The time that the media player should attempt to play from.
Source:

seek(value)

Seeks to the given value.

Parameters:
Name Type Description
value number

The time that the media player should attempt to play from.
Source:

seek(value)

Seeks to the given value. Available for restart type only.

Parameters:
Name Type Description
value number

The time that the media player should attempt to play from.
Source:

select()

Select function.

Source:

selectChildWidgetByIndex(selectedIndex)

Add selected class and activate the child widget in the specific index.

Parameters:
Name Type Description
selectedIndex number

Index to select and activate.
Source:

setAccountNumber(accountnumber)

Saves username.

Parameters:
Name Type Description
accountnumber Object

Account number.
Source:

setAPISettings()

Sets the API settings.

Source:

setBackground(url)

Sets the background image.

Parameters:
Name Type Description
url string

Url.
Source:

setBookmarkList(bookmarkList)

Sets a bookmark list.

Parameters:
Name Type Description
bookmarkList Object

The bookmark list.
Source:

setButtonActiveChildIndex(index)

Sets active child to the action.

Parameters:
Name Type Description
index number

The index to set active.
Source:

setButtonActiveChildIndex()

Sets carousel focus.

Source:

setButtonActiveChildIndex()

Sets carousel focus.

Source:

setChannel(index)

Sets the current channel index.

Parameters:
Name Type Description
index number

The channel index.
Source:

setChannel(channel) → {Object}

Sets the current channel.

Parameters:
Name Type Description
channel number

The current channel.
Source:
Returns:
  • Promise.
Type
Object

setChannelMap(id, number)

Sets the channel map.

Parameters:
Name Type Description
id string | number

The id.
number string | number

The number.
Source:

setChannels(channels)

Sets the channels.

Parameters:
Name Type Description
channels Array

The channels.
Source:

setChannelSwitcherLabel(channelNumberopt)

Sets the channel number into the switcher label.

Parameters:
Name Type Attributes Description
channelNumber string <optional>

The channel number to show.
Source:

setContent(contentData)

Creates the content for this list.

Parameters:
Name Type Description
contentData Object

Object that contais the info to build the carousels.
Source:

setControls(controls)

Sets the player ui controls.

Parameters:
Name Type Description
controls Array

Array with the control buttons to be set.
Source:

setControls(controls)

Sets the player ui controls.

Parameters:
Name Type Description
controls Array

Array with the control buttons to be set.
Source:

setData(data)

Sets data props to elements.

Parameters:
Name Type Description
data Object

Data.
Source:

setData()

Sets the data.

Source:

setData(item)

Sets the data item.

Parameters:
Name Type Description
item Object

The data item.
Source:

setData(data)

Sets model data options.

Parameters:
Name Type Description
data Object

The API data.
Source:

setData(item)

Sets the data item.

Parameters:
Name Type Description
item Object

The item.
Source:

setDataItem(items)

Sets the data item.

Parameters:
Name Type Description
items Array

The item data.
Source:

setDataItem(opts)

Sets the data item.

Parameters:
Name Type Description
opts Object

The data item.
Source:

setDataItem(opts)

Sets the data item.

Parameters:
Name Type Description
opts Object

The opts.
Source:

setDataItem(tabs)

Sets the data item.

Parameters:
Name Type Description
tabs Object

The tabs to set.
Source:

setDataItem(items)

Sets the data item.

Parameters:
Name Type Description
items Object

The items.
Source:

setDataItem(data, shouldFocusopt, shouldAlignopt)

Sets the data item.

Parameters:
Name Type Attributes Description
data Object

The data.

Properties
Name Type Description
name string

The name.
items Array

The items.
shouldFocus boolean <optional>

True to focus to the grid.
shouldAlign boolean <optional>

True if the grid should align.
Source:

setDataItem(e)

Before render event.

Parameters:
Name Type Description
e Object

The event data.
Source:

setDataItem(programDetails)

Sets the requested program details.

Parameters:
Name Type Description
programDetails Object

The requested program's details.
Source:

setDataItem(opts)

Sets the data item.

Parameters:
Name Type Description
opts Object

The opts.
Source:

setDataItem(item, seriesItem)

Sets the data item.

Parameters:
Name Type Description
item Object

The item.
seriesItem Object

The series item.
Source:

setDataItem(season)

Sets the data item.

Parameters:
Name Type Description
season Object

The season.
Source:

setDataItem(items)

Sets the data item.

Parameters:
Name Type Description
items Object

The items.
Source:

setDate(date)

Sets buttons date label.

Parameters:
Name Type Description
date string

Previous date string.
Source:

setDate(date)

Sets buttons date label.

Parameters:
Name Type Description
date string

Next date string.
Source:

setDescription(data)

Sets the description.

Parameters:
Name Type Description
data Object

The data.
Source:

setDrm(drmConfigopt)

Sets the media DRM if any.

Parameters:
Name Type Attributes Description
drmConfig Object <optional>

The media's DRM.
Source:

setDrm(drmConfigopt)

Sets the media DRM if any.

Parameters:
Name Type Attributes Description
drmConfig Object <optional>

The media's DRM.
Source:

setDuration(duration)

Sets the duration.

Parameters:
Name Type Description
duration number

The duration.
Source:

setEndIndex(value)

Sets the current end index.

Parameters:
Name Type Description
value number

Sets the current end index.
Source:

setEndTime(time)

Sets the end time.

Parameters:
Name Type Description
time string

The end time (in hh:mm).
Source:

setEntryConfirmed()

Sets the entry confirmed state.

Source:

setEpisode(episode)

Sets the episode.

Parameters:
Name Type Description
episode Object

The episode data.
Source:

setFocusable(focusable)

Set miniEPG as focusable or not.

Parameters:
Name Type Description
focusable boolean

True to set miniEPG focusable, false not focusable.
Source:

setFocusable(focusable)

Sets the focusable state for this widget.

Parameters:
Name Type Description
focusable boolean

True if the widget can be focused.
Source:

setFocusable(focusable)

Set miniEPG as focusable or not.

Parameters:
Name Type Description
focusable boolean

True to set miniEPG focusable, false not focusable.
Source:

setFormattedItems(items)

Sets the formatted items on the series instance.

Parameters:
Name Type Description
items Array

The items.
Source:

setIcon(icon)

Creates and returns an icon Label.

Parameters:
Name Type Description
icon string

Icon set from data.
Source:

setIcon(icon)

Sets icon on button.

Parameters:
Name Type Description
icon string

Icon.
Source:

setIcon(icon)

Sets icon on button.

Parameters:
Name Type Description
icon string

Icon.
Source:

setImage(src)

Set decorator image.

Parameters:
Name Type Description
src string

Image source.
Source:

setInRowIndex(value)

Sets the the current index of item in the row.

Parameters:
Name Type Description
value number

Current item index in the row.
Source:

setIsLive(isLive)

Sets the progress state to live if true.

Parameters:
Name Type Description
isLive boolean

True if the progress widget reports live progress.
Source:

setIsLive(isLive)

Sets the progress state to live if true.

Parameters:
Name Type Description
isLive boolean

True if the progress widget reports live progress.
Source:

setIsLive(isLive)

Sets the progress state to live if true.

Parameters:
Name Type Description
isLive boolean

True if the progress widget reports live progress.
Source:

setIsLive(isLive)

Sets the progress state to live if true.

Parameters:
Name Type Description
isLive boolean

True if the progress widget reports live progress.
Source:

setIsVodMovie(isVodMovie)

Sets the progress state to VOD_MOVIE if true.

Parameters:
Name Type Description
isVodMovie boolean

True if the progress widget reports live progress.
Source:

setKeyboard(keyboard)

Sets the keyboard to the input.

Parameters:
Name Type Description
keyboard Object

The keyboard.
Source:

setKeyboard(kbd)

Use given keyboard for editing.

Parameters:
Name Type Description
kbd Keyboard

The keyboard to use.
Source:

setKeyboard(keyboard)

Sets the keyboard to the input.

Parameters:
Name Type Description
keyboard Object

The keyboard.
Source:

setKeyInput(input)

Sets the key input.

Parameters:
Name Type Description
input string

The input value.
Source:

setLabel(textopt)

Builds the channel switcher.

Parameters:
Name Type Attributes Description
text string <optional>

Set the channelswitcher label.
Source:

setLastSearchedItems(searchedItems)

Sets the last searched items stringify array.

Parameters:
Name Type Description
searchedItems string

The last searched item.
Source:

setLastServiceMessageShown()

Sets the last service message date.

Source:

setLastWatchedChannel(channelId)

Sets the last watched channel.

Parameters:
Name Type Description
channelId number

The last watched channel id.
Source:

setListeners()

Sets the listeners.

Source:

setListeners()

Sets the event listeners.

Source:

setLivePlaybackPosition(position)

Sets the live video playback position.

Parameters:
Name Type Description
position number

The playback position.
Source:

setLiveProgress(progress)

Sets the video progress.

Parameters:
Name Type Description
progress Object

The video progress.

Properties
Name Type Description
head number

The current progress in percentages.
Source:

setLiveProgress(data)

Sets the progress.

Parameters:
Name Type Description
data Object

The data.
Source:

setLocalPC(parentalControlSwitch)

Sets local parental switch.

Parameters:
Name Type Description
parentalControlSwitch boolean

Parental control params.
Source:

setLockedBackground()

Sets locked background.

Source:

Sets the logo.

Parameters:
Name Type Description
image string

The image url.
Source:

Sets the logo.

Parameters:
Name Type Description
url string

The url.
Source:

setMenuItem(menuItem)

Sets the menu item.

Parameters:
Name Type Description
menuItem MenuItem

The menu item.
Source:

setNextEpisodeButton(show)

Shows/hides next episode button.

Parameters:
Name Type Description
show boolean

Boolean flag to show (true) or hide next episode button..
Source:

setNextEpisodeButton(show)

Shows/hides next episode button.

Parameters:
Name Type Description
show boolean

Boolean flag to show (true) or hide next episode button..
Source:

setOnboardingDataItem(dataItem)

Associate a data item with this widget.

Parameters:
Name Type Description
dataItem Object

The carousel's params.

Properties
Name Type Description
carousel Object

The carousel widget.
aligner Object

The carousel's aligner.
data Object

The carousel's data to populate.
Source:

setOnOffValue(onOff)

Sets onoff label.

Parameters:
Name Type Description
onOff boolean

On off.
Source:

setParentalWhitelisted()

Sets program to be parental whitelisted.

Source:

setParentalWhitelisted()

Sets program to be parental whitelisted.

Source:

setParentalWhitelisted()

Sets program to be parental whitelisted.

Source:

setPauseTime(args)

Sets the pause time label.

Parameters:
Name Type Description
args Object

The arguments.

Properties
Name Type Description
behind string

The number of minutes behind live (mm:ss).
position number

The position behind the live time (percentage).
Source:

setPlayerHiddenFlag(flag)

Sets flag whether the player is in hidden state.

Parameters:
Name Type Description
flag boolean

If is hidden.
Source:

setPlayerProperties(playerProperties)

Sets the player properties such as DRM and MediaSource.

Parameters:
Name Type Description
playerProperties Object

Object that contains different properties for the loading source.
Source:

setPlayerProperties(playerProperties)

Sets the player properties such as DRM and MediaSource.

Parameters:
Name Type Description
playerProperties Object

Object that contains different properties for the loading source.
Source:

setPointerListeners(widgetopt)

Sets the pointer listeners.

Parameters:
Name Type Attributes Description
widget Object <optional>

The widget to set the listener to. Optional.
Source:

setPointerSupport(support)

Enable/disable pointer support for this button.

Parameters:
Name Type Description
support boolean

Supported or not.
Source:

setPointerSupport(support)

Enable/disable pointer support for this button.

Parameters:
Name Type Description
support boolean

Supported or not.
Source:

setProgram(program)

Sets the program details.

Parameters:
Name Type Description
program Object

The program.
Source:

setProgram(programData)

Sets the program data to be displayed.

Parameters:
Name Type Description
programData Object

The program's data.
Source:

setProgram(programParams)

Attempts to set the program.

Parameters:
Name Type Description
programParams Object

Contains the params for setting the program.

Properties
Name Type Attributes Description
program Object

The program data to set.
type string

The type.
hasNextEpisode boolean | null <optional>

Flag whether it has next episode or not.
Source:

setProgram(program, type)

Sets the current program.

Parameters:
Name Type Description
program Object

The program.
type string

The program type.
Source:

setProgramInfoButton(show)

Shows/hides program info button.

Parameters:
Name Type Description
show boolean

True to show button.
Source:

setProgramInfoButton(show)

Should set or not program info button.

Parameters:
Name Type Description
show boolean

True to show button.
Source:

setProgramTitle(text)

Sets the program title.

Parameters:
Name Type Description
text string

The text to set.
Source:

setProgress(percentage)

Sets the progress percentage.

Parameters:
Name Type Description
percentage number

The percentage.
Source:

setProgress(progressData)

Updates the progress on zappbanner.

Parameters:
Name Type Description
progressData Object

Progress data.
Source:

setProgress(percentage)

Sets the progress percentage.

Parameters:
Name Type Description
percentage number

The percentage.
Source:

setProgress(progressData)

Sets the progressbar current position.

Parameters:
Name Type Description
progressData Object

The progress data needed to update progressbar.
Source:

setProgress(progressData)

Sets the progress to the progressbar.

Parameters:
Name Type Description
progressData Object

The progress data to be set.
Source:

setProgress(percentage)

Sets the progress percentage.

Parameters:
Name Type Description
percentage number

The percentage.
Source:

setProgress()

Sets the progress.

Source:

setProgress(percentage)

Sets the progress percentage.

Parameters:
Name Type Description
percentage number

The percentage.
Source:

setProgress(progressData)

Sets the progressbar current position.

Parameters:
Name Type Description
progressData Object

The progress data needed to update progressbar.
Source:

setProgressBar(startTime, endTime)

Sets the progress.

Parameters:
Name Type Description
startTime Date

The startTime.
endTime Date

The end time.
Source:

setProgressMaxPointerPosition()

Sets max pointer position.

Source:

setPromo(data, type)

Attempts to set the full promo video.

Parameters:
Name Type Description
data Object

The data to set.
type string

The type.
Source:

setReachedEnd(value)

Reset the loadmore index.

Parameters:
Name Type Description
value boolean

Is reached.
Source:

setReachedEnd(value)

Reset the loadmore index.

Parameters:
Name Type Description
value boolean

Is reached.
Source:

setRights(rights)

Sets the rights obtained from user data for this content.

Parameters:
Name Type Description
rights string

The rights for this content.
Source:

setRowIndex(value)

Sets the the current index of row.

Parameters:
Name Type Description
value number

Current row index.
Source:

setSelectedIndex(selectedIndexObject)

Set selected index in a section.

Parameters:
Name Type Description
selectedIndexObject Object

Selected index info.

Properties
Name Type Description
section string

Selected section.
index number

Selected index.
Source:

setSelectedItem(filter)

Sets the selected filter.

Parameters:
Name Type Description
filter Object

The filter.
Source:

setSettings(config)

Sets the grid settings.

Parameters:
Name Type Description
config Object

Config object.
Source:

setSpeed(speed)

Sets the speed.

Parameters:
Name Type Description
speed number

Speed number.
Source:

setSrc(source)

Sets the media source.

Parameters:
Name Type Description
source Object

The media source being loaded.
Source:

setSrc(source)

Sets the media source.

Parameters:
Name Type Description
source Object

The media source being loaded.
Source:

setStartBitrate(startBitrate)

Sets the starting bitrate.

Parameters:
Name Type Description
startBitrate Object

The starting bitrate.
Source:

setStartBitrate(startBitrate)

Sets the starting bitrate.

Parameters:
Name Type Description
startBitrate Object

The starting bitrate.
Source:

setStartIndex(value)

Sets the current start index.

Parameters:
Name Type Description
value number

Sets the current start index.
Source:

setStartTime(time)

Sets the start time.

Parameters:
Name Type Description
time string

The start time (in hh:mm).
Source:

setState(state)

Sets the state.

Parameters:
Name Type Description
state string

The current state.
Source:

setState(state)

Sets the state.

Parameters:
Name Type Description
state string

The state.
Source:

setSubtitle(startTime, endTime)

Sets the subtitle.

Parameters:
Name Type Description
startTime Date

The startTime.
endTime Date

The endTime.
Source:

setSubtitle(text)

Set decorator subtitle.

Parameters:
Name Type Description
text string

Decorator subtitle.
Source:

setSubtitle(text)

Sets the sub title text.

Parameters:
Name Type Description
text string

The text.
Source:

setText(text)

Sets the text.

Parameters:
Name Type Description
text string

The text.
Source:

setText(text)

Creates and returns an text Label.

Parameters:
Name Type Description
text string

Text set from data.
Source:

setText(text)

Sets text on button.

Parameters:
Name Type Description
text string

Text.
Source:

setText(text)

Sets the text of the button.

Parameters:
Name Type Description
text string

The text to set.
Source:

setTime()

Sets the current time.

Source:

setTitle(text)

Set decorator title.

Parameters:
Name Type Description
text string

Decorator title.
Source:

setTitle(title)

Sets the title.

Parameters:
Name Type Description
title string

The title.
Source:

setTopText(text)

Sets the top text.

Parameters:
Name Type Description
text string

The top text.
Source:

setTrickplaySettings()

Sets the trickplay settings.

Source:

setTrickplaySettings()

Sets the trickplay settings.

Source:

setUser(user)

Sets the user.

Parameters:
Name Type Description
user Object

The user.
Source:

setUserLogin(user)

Sets the user login.

Parameters:
Name Type Description
user Object

The user data.
Source:

setUserPCParams(parentalControlParams)

Sets the user PC parameters.

Parameters:
Name Type Description
parentalControlParams Object

Parental control params.
Source:

setUserPin(pin)

Sets the user pin.

Parameters:
Name Type Description
pin string | null

The user pin.
Source:

setValueObject(text)

Sets item object for button.

Parameters:
Name Type Description
text Object

Text for button.
Source:

setVideoRatings(ratings)

Sets the video ratings.

Parameters:
Name Type Description
ratings Array

The video ratings.
Source:

setVODProgress(data)

Sets the VOD progress.

Parameters:
Name Type Description
data Object

The video progress.
Source:

setVODProgress(data)

Sets the VOD progress.

Parameters:
Name Type Description
data Object

The data.
Source:

shouldRetry(response) → {boolean}

Return true in case failed request should be repeated.

Parameters:
Name Type Description
response Object

Response.
Source:
Returns:

True if retry.

Type
boolean

shouldRetry(response) → {boolean}

Return true in case failed request should be repeated.

Parameters:
Name Type Description
response Object

Response.
Source:
Returns:

True if retry.

Type
boolean

shouldShowWarmWelcome() → {boolean}

Returns true if should show warm welcome screen.

Source:
Returns:
  • True if should show warm welcome.
Type
boolean

show(config)

Shows the Warning Box and after 5s disappears.

Parameters:
Name Type Description
config Object

The display config. Contains icon and text.
Source:

show(opts)

Shows widget.

Parameters:
Name Type Description
opts Object

Show parameter options.
Source:

show(decoratorType, opts)

Shows decorator with the given decorator type.

Parameters:
Name Type Description
decoratorType string

Decorator type.
opts Object

Show options.

Properties
Name Type Attributes Description
query string <optional>

Query text for displaying.
Source:

show(opts)

Shows the widget.

Parameters:
Name Type Description
opts Object

The options.
Source:

show(e)

Shows the widget.

Parameters:
Name Type Description
e Object

The event data.
Source:

showCollapsed(callingComponent)

Show lint menu.

Parameters:
Name Type Description
callingComponent string

The calling component that opened the collapsed menu.
Source:

Shows and hides cursor based on timeout.

Source:

Shows and hides cursor based on timeout.

Source:

Shows and hides cursor based on timeout.

Source:

showError()

Shows incorrect error message.

Source:

showGoBackButton(show)

Enables or disables backbutton for the modal.

Parameters:
Name Type Description
show boolean

True if the modal should set the go back button.
Source:

showHero()

Shows the Hero widget.

Source:

showLive()

Shows live button.

Source:

showLoader(preventFocusopt, blockInputopt)

Show the application loader.

Parameters:
Name Type Attributes Description
preventFocus boolean <optional>

Prevents focus on the loader.
blockInput boolean <optional>

Prevents user input.
Source:

showLockedTitle() → {boolean}

Returns true if the locked title should be shown.

Source:
Returns:
  • True if the locked title should be shown.
Type
boolean

showMenu(value, blockedMenu, collapsed)

Call show menu.

Parameters:
Name Type Description
value string

Parent component name passed from component which called the function.
blockedMenu boolean

True if the menu should be blocked.
collapsed boolean

True if the menu should be shown collapsed (lint menu).
Source:

showMiniEPG(hide)

Shows the mini epg.

Parameters:
Name Type Description
hide boolean

True if the miniEPG should be hidden.
Source:

showMiniEPG(hide)

Shows or hides the mini epg.

Parameters:
Name Type Description
hide boolean

True if the miniEPG should be hidden.
Source:

showPaginationButton()

Displays the pagination button.

Source:

showPlayer()

Show the player.

Source:

showProgramInfo(show, programDetails)

Show/hide the program detail for the current live program.

Parameters:
Name Type Description
show boolean

True to show info detail, false to hide it.
programDetails Object

The program containing the details to show.
Source:

showProgramInfo(show, programDetails)

Show/hide the program detail for the current live program.

Parameters:
Name Type Description
show boolean

True to show info detail, false to hide it.
programDetails Object

The program containing the details to show.
Source:

showProgress()

Show progress bar.

Source:

showProgress()

Show progress bar.

Source:

showRecord()

Shows record button.

Source:

showReplay()

Shows replay button.

Source:

showUI(hideopt, hideClockopt)

Shows the ui.

Parameters:
Name Type Attributes Description
hide boolean <optional>

True if it should hide after 3 seconds.
hideClock boolean <optional>

True if clock should be hidden.
Source:

showUI(permanentopt, hideClockopt)

Shows the ui. Default behaviour hides after ZAPPBANNER_DISSAPPEAR_TIME seconds.

Parameters:
Name Type Attributes Description
permanent boolean <optional>

True if UI should show permanently.
hideClock boolean <optional>

True if clock should be hidden.
Source:

showUI()

Shows player UI.

Source:

showWarningBox(config)

Shows the warning box.

Parameters:
Name Type Description
config Object

The config.
Source:

showWarningBox(config)

Shows the warning box.

Parameters:
Name Type Description
config Object

The config.
Source:

showWarningBox(config)

Shows the warning box.

Parameters:
Name Type Description
config Object

The config.
Source:

showWarningBox(config)

Shows the warning box.

Parameters:
Name Type Description
config Object

The config.
Source:

start()

Starts the countdown.

Source:

startInitialTimeout()

Starts the initial timeout.

Source:

startInterval()

Starts the interval.

Source:

startRefreshSessionTimeout()

Starts the refresh session timeout.

Source:

stop()

Stops the countdown.

Source:

stop()

Stops the current playback.

Source:

stop()

Stops the current playback.

Source:

Clears timeouts and intervals.

Source:

Clears timeouts and intervals.

Source:

Clears timeouts and intervals.

Source:

stopFocusbarAnimation()

Stops the focusbar animation.

Source:

stopFocusbarAnimation()

Stops the focusbar animation.

Source:

storeBookmark()

No bookmark for this type.

Source:

storeBookmark()

Checks the bookmark threshold so bookmark can be stored.

Source:

streamRequiresPin() → {boolean}

Returns true if the stream requires to be requested with pin.

Source:
Returns:
  • True if stream requires pin.
Type
boolean

streamRequiresPin() → {boolean}

Returns true if the stream requires to be requested with pin.

Source:
Returns:
  • True if stream requires pin.
Type
boolean

timeAlignItem(timeframe, optionsopt)

Time aligns the items.

Parameters:
Name Type Attributes Description
timeframe string | number

The timeframe.
options Object <optional>

The alignment options.
Source:

timeAlignLastItem(optionsopt)

Aligns all assets in carousel to with the last item.

Parameters:
Name Type Attributes Description
options Object <optional>

Animation options.
Source:

timeAlignVisible(timeframe, optionsopt, positionopt)

Aligns assets in visible carousels depending on time they start.

Parameters:
Name Type Attributes Description
timeframe string | number

Timeframe of focused asset.
options Object <optional>

Animation options.
position number <optional>

The align position.
Source:

togglePlayers(show)

Toggle players with promo videos.

Parameters:
Name Type Description
show boolean

True if player should be visible.
Source:

transformFrom(response) → {Object}

Transforms the response.

Parameters:
Name Type Description
response Object

The response.
Source:
Returns:
  • The media source data to be built.
Type
Object

transformFrom(response) → {Object}

Transforms API data into the abstract model data.

Parameters:
Name Type Description
response Object

The data object gotten from the API.
Source:
Returns:
  • The filled model instance.
Type
Object

transformFrom(response) → {Array}

Transforms the response.

Parameters:
Name Type Description
response Object

The response.
Source:
Returns:
  • The formatted related items.
Type
Array

transformFrom(response) → {Object}

Transforms the response.

Parameters:
Name Type Description
response Object

The response.
Source:
Returns:

Result.

Type
Object

transformFrom(response) → {Object}

Transforms the response.

Parameters:
Name Type Description
response Object

The response.
Source:
Returns:

Result.

Type
Object

transformFrom(response) → {Object}

Transforms API data into the abstract model data.

Parameters:
Name Type Description
response Object

The data object gotten from the API.
Source:
Returns:

The filled model instance.

Type
Object

transformFrom(response) → {Object}

Transforms the response.

Parameters:
Name Type Description
response Object

The response.
Source:
Returns:
  • The media source.
Type
Object

transformFrom(data) → {Object}

Transforms api data to application data.

Parameters:
Name Type Description
data Object

Data object.
Source:
Returns:

Application data.

Type
Object

transformFrom(response) → {Object}

Transforms the response.

Parameters:
Name Type Description
response Object

The response.
Source:
Returns:
  • The media source.
Type
Object

transformFrom(response) → {Object}

Transforms API data into the abstract model data.

Parameters:
Name Type Description
response Object

The data object gotten from the API.
Source:
Returns:
  • The filled model instance.
Type
Object

transformFrom(response) → {Object}

Transforms API data into the abstract model data.

Parameters:
Name Type Description
response Object

The data object gotten from the API.
Source:
Returns:

The filled model instance.

Type
Object

transformFrom(response) → {Object}

Transforms API data into the abstract model data.

Parameters:
Name Type Description
response Object

The data object gotten from the API.
Source:
Returns:

The filled model instance.

Type
Object

transformFrom(response) → {Object}

Transforms the response.

Parameters:
Name Type Description
response Object

The response.
Source:
Returns:

Result.

Type
Object

transformFrom(response) → {Object}

Transforms API data into the abstract model data.

Parameters:
Name Type Description
response Object

The data object gotten from the API.
Source:
Returns:
  • The filled model instance.
Type
Object

transformFrom(response) → {Object}

Transforms the response.

Parameters:
Name Type Description
response Object

The response.
Source:
Returns:
  • The media source.
Type
Object

transformFromCreate(data) → {Object}

Transform data from API to Application for a Create method.

Parameters:
Name Type Description
data *

The data to be transformed.
Source:
Returns:

Transformed data.

Type
Object

transformFromCreate(response) → {Object}

Transforms the response.

Parameters:
Name Type Description
response Object

The response.
Source:
Returns:
  • Returns the user.
Type
Object

transformFromCreate(response) → {Object}

Transforms the response.

Parameters:
Name Type Description
response Object

The response.
Source:
Returns:

Result.

Type
Object

transformFromCreate(data) → {Object}

Transform data from API to Application for a Create method.

Parameters:
Name Type Description
data *

The data to be transformed.
Source:
Returns:

Transformed data.

Type
Object

transformFromRead(response) → {Object}

Transforms the response.

Parameters:
Name Type Description
response Object

The API response data.
Source:
Returns:
  • The Page model.
Type
Object

unload()

Resets/unloads the media player.

Source:

unload()

Resets/unloads the media player.

Source:

unlock()

For the rendered assets remove the locked container and set backrgound and title.

Source:

unlock()

Unlocks the asset.

Source:

unlock()

For the rendered assets remove the locked container and set background and title.

Source:

unlockAsset()

Unlocks asset.

Source:

update(modelReference, opts, retryFulFilledopt, retryRejectedopt) → {Promise}

Returns a Promise with an instance of the Model being requested.

Parameters:
Name Type Attributes Description
modelReference string | ModelInterface

Reference to the model or instance.
opts Object

Options object.

Properties
Name Type Attributes Default Description
params Object

Parameters object which is used in the resolveEndpoint method of the requested Model.
data Object <optional>
 {}

Data to send as payload.
retryFulFilled * <optional>

Resolve function for repeating request after failure.
retryRejected * <optional>

Reject function for repeating request after failure.
Source:
Throws:

When the fetched model module isn't an instance of ModelInterface.

Type
Error
Returns:

Returns a Promise.

Type
Promise

updateAsset(data, currentAsset)

Updated the given asset with the new data.

Parameters:
Name Type Description
data Object

New data to be set.
currentAsset Object

Current asset to update.
Source:

updateCarousel()

Requests and updates carousel items.

Source:

updateLastSearchedList()

Updates carousel object.

Source:

updateProgressBar() → {boolean}

Updates the content's progressbar.

Source:
Returns:
  • Progress complete.
Type
boolean

updateSeekSpeed(speed)

Updates the seek speed.

Parameters:
Name Type Description
speed number

The seek speed.
Source:

updateSeekSpeed(speed)

Updates the seek speed.

Parameters:
Name Type Description
speed number

The seek speed.
Source:

updateSeekSpeed(speed)

Updates the seek speed.

Parameters:
Name Type Description
speed number

The seek speed.
Source:

validateDestroyResponse(response) → {boolean}

Validates the response for DELETE.

Parameters:
Name Type Description
response Object

The response.
Source:
Returns:

Response.

Type
boolean

validateReadResponse(response) → {boolean}

Validates the read response.

Parameters:
Name Type Description
response Object

The read response.
Source:
Returns:
  • True if valid.
Type
boolean

validateReadResponse(response) → {boolean}

Validates the read response.

Parameters:
Name Type Description
response Object

The read response.
Source:
Returns:
  • True if valid.
Type
boolean

validateReadResponse(response) → {boolean}

Validates the read response.

Parameters:
Name Type Description
response Object

The read response.
Source:
Returns:
  • True if valid.
Type
boolean

validateReadResponse(response) → {boolean}

Validates the read response.

Parameters:
Name Type Description
response Object

The read response.
Source:
Returns:
  • True if valid.
Type
boolean

validateReadResponse(response) → {boolean}

Validates the read response.

Parameters:
Name Type Description
response Object

The read response.
Source:
Returns:
  • True if valid.
Type
boolean

validateReadResponse(response) → {boolean}

Validates the read response.

Parameters:
Name Type Description
response Object

The read response.
Source:
Returns:
  • True if valid.
Type
boolean

validateResponse(response) → {boolean}

Validates the response.

Parameters:
Name Type Description
response Object

The response.
Source:
Returns:
  • True if valid.
Type
boolean

validateResponse(response) → {boolean}

Validates the response.

Parameters:
Name Type Description
response Object

The response.
Source:
Returns:
  • True if valid.
Type
boolean

validateResponse(response) → {boolean}

Validates the response.

Parameters:
Name Type Description
response Object

The response.
Source:
Returns:
  • True if valid.
Type
boolean

validateResponse(response) → {boolean}

Validates the response.

Parameters:
Name Type Description
response Object

The response.
Source:
Returns:
  • True if the response is valid.
Type
boolean

validateResponse(response) → {boolean}

Validates the response.

Parameters:
Name Type Description
response Object

The response.
Source:
Returns:

Response.

Type
boolean

validateResponse(response) → {boolean}

Validates the response.

Parameters:
Name Type Description
response Object

The response.
Source:
Returns:

Response.

Type
boolean

validateResponse(response) → {boolean}

Validates the response.

Parameters:
Name Type Description
response Object

The response.
Source:
Returns:
  • True if valid.
Type
boolean

validateResponse(response) → {boolean}

Validates the response.

Parameters:
Name Type Description
response Object

The response.
Source:
Returns:
  • True if valid.
Type
boolean

validateResponse(response) → {boolean}

Validates the response.

Parameters:
Name Type Description
response Object

The response.
Source:
Returns:
  • True if valid.
Type
boolean

validateResponse(response) → {boolean}

Validates the response.

Parameters:
Name Type Description
response Object

The response.
Source:
Returns:

Response.

Type
boolean

validateResponse(response) → {boolean}

Validates the response.

Parameters:
Name Type Description
response Object

The response.
Source:
Returns:

Response.

Type
boolean

validateResponse(response) → {boolean}

Validates the response.

Parameters:
Name Type Description
response Object

The response.
Source:
Returns:
  • True if valid.
Type
boolean

validateResponse(response) → {boolean}

Validates the response.

Parameters:
Name Type Description
response Object

The response.
Source:
Returns:
  • True if valid.
Type
boolean

validateResponse(response) → {boolean}

Validates the response.

Parameters:
Name Type Description
response Object

The response.
Source:
Returns:
  • True if the response is valid.
Type
boolean

validateResponse(response) → {boolean}

Validates the response.

Parameters:
Name Type Description
response Object

The response.
Source:
Returns:

Response.

Type
boolean

Type Definitions

Sub-menu base widget.

Type:
  • Object
Source: