IPPNovaAdaptor

IPPNovaAdaptor

new IPPNovaAdaptor(service_url, use_jsonp)

Protocol adaptor for spv.ds.ipprot_nova.IpadClient

Resposible for hiding protocol data types and interpreting reponse data to failures in cases where errors are reported inside the normal result data. eg. Result codes from load config operations.

Implements:
Source:
Parameters:
Name Type Description
service_url string
use_jsonp boolean

Members

Methods

getBuildInfo(on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
on_success function
on_failure function

getConfigImage(conf, img_params, on_success, on_failure)

Fetches an image for a serialized configuration.

Implements:
Source:
Parameters:
Name Type Description
conf spv.ds.Config
img_params spv.ds.ImageParams
on_success function
on_failure function

getFreshConfigs(limit, scale_width, scale_height, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
limit number
scale_width number
scale_height number
on_success function
on_failure function

getIntroPage(on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
on_success function
on_failure function

getItemResources(item_ids, resource_keys, category, model, language, model_group, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
item_ids Array.<string>
resource_keys Array.<string>
category string
model string
language string
model_group string
on_success function
on_failure function

getReadMore(item_id, model, category, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
item_id string
model string
category string
on_success function
on_failure function

getUserConfigList(username, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
username string
on_success function
on_failure function

publicConfigV2Load(session_id, public_config_id, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
public_config_id string
on_success function
on_failure function

publicConfigV2Save(session_id, description, config_storage_aux, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
description string
config_storage_aux Object.<string, string>
on_success function
on_failure function

resetPassword(token, new_password, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
token string
new_password string
on_success function
on_failure function

sessionAddGuiGroupSubscriptions(session_id, group_ids, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
group_ids Array.<string>
on_success function
on_failure function

sessionBip(session_id, category, item_ids, language, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
category string
item_ids Array.<string>
language string
on_success function
on_failure function

sessionClearGuiGroupSubscriptions(session_id, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
on_success function
on_failure function

sessionCreate(menu_query, readmore_mode, language, ttl, origin, category, item_interpreter_options, on_success, on_failure)

Hides multiple server calls required to initialize

Implements:
Source:
Parameters:
Name Type Description
menu_query string
readmore_mode spv.ds.ipprot_nova.input.BopReadMoreMode
language string
ttl number

Time To Live for this session in seconds

origin string

URL of the embedding page

category string
item_interpreter_options string
on_success function
on_failure function

sessionCreateUser(session_id, user_name, password, on_success, on_failure, languageopt)

Implements:
Source:
Parameters:
Name Type Attributes Description
session_id string
user_name string
password string
on_success function
on_failure function
language string <optional>

sessionGeneratePdf(session_id, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
on_success function

Callback taking the generated pdf url

on_failure function

sessionGeneratePublicConfig(session_id, on_success, on_failure)

Source:
Parameters:
Name Type Description
session_id string
on_success function
on_failure function

sessionGetConfig(session_id, encoding, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
encoding string
on_success function
on_failure function

sessionGetConfigNames(session_id, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
on_success function
on_failure function

sessionGetFacebookShareData(session_id, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
on_success function
on_failure function

sessionGetFlexImage(session_id, input, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
input spv.ds.ipprot_nova.input.ProtocolFlexImageParameters
on_success function
on_failure function

sessionGetFreshConfigs(session_id, limit, scale_width, scale_height, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
limit number
scale_width number
scale_height number
on_success function
on_failure function

sessionGetImage(session_id, img_params, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
img_params spv.ds.ImageParams
on_success function
on_failure function

sessionGetInitialConsequenceOfChange(session_id, language, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
language string
on_success function
on_failure function

sessionGetItemInfo(session_id, item_ids, language, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
item_ids Array.<string>
language string
on_success function
on_failure function

sessionGetMediaKit(session_id, serie_index, frame_index, file_type, separate_background, separate_shadow, all_frames, use_hd, image_width, image_height, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
serie_index number
frame_index number
file_type string
separate_background boolean
separate_shadow boolean
all_frames boolean
use_hd boolean
image_width number
image_height number
on_success function
on_failure function

sessionGetPresentationStructure(session_id, filter_name, query, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
filter_name string
query spv.ds.PresentationStructureQuery
on_success function
on_failure function

sessionGetStateResolvers(session_id, item_id, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
item_id string
on_success function
on_failure function

sessionGetSummary(session_id, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
on_success function
on_failure function

sessionGetUserConfigImage(session_id, config_name, img_params, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
config_name string
img_params spv.ds.ImageParams
on_success function
on_failure function

sessionGetUserConsents(session_id, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
on_success function
on_failure function

sessionHasLoggedInUser(session_id, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
on_success function
on_failure function

sessionLoadConfig(session_id, config, language, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
config spv.ds.Config
language string
on_success function
on_failure function

sessionLoadConfigByName(session_id, config_name, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
config_name string
on_success function
on_failure function

sessionLoadConfigMemorizeAll(session_id, config, language, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
config spv.ds.Config
language string
on_success function
on_failure function

sessionLoadPublicConfig(session_id, config_name, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
config_name string
on_success function
on_failure function

sessionLogin(session_id, user_name, password, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
user_name string
password string
on_success function
on_failure function

sessionLogout(session_id, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
on_success function
on_failure function

sessionRemoveConfigByName(session_id, config_name, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
config_name string
on_success function
on_failure function

sessionResume(session_id, language, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
language string
on_success function
on_failure function

sessionSaveConfigByName(session_id, config_name, allow_overwrite, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
config_name string
allow_overwrite boolean
on_success function
on_failure function

sessionSendHeartBeat(session_id, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
on_success function
on_failure function

sessionSendResetPasswordMail(session_id, main_url, user_name, language, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
main_url string
user_name string
language string
on_success function
on_failure function

sessionSetPriceLocalization(session_id, price_localization_id, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
price_localization_id string
on_success function
on_failure function

sessionSetUserConsent(user_id, consent_id, consent_text, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
user_id number
consent_id string
consent_text string
on_success function
on_failure function

sessionSetUserConsentSession(session_id, consent_id, consent_text, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
consent_id string
consent_text string
on_success function
on_failure function

sessionToggleItem(session_id, item_id, category, on_bop, on_resolvers, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
item_id string
category string
on_bop function
on_resolvers function
on_failure function

sessionUpdateBop(session_id, language, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
language string
on_success function
on_failure function

userConfigV2ChangeName(session_id, user_config_id, new_name, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
user_config_id number
new_name string
on_success function
on_failure function

userConfigV2Delete(session_id, config_id, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
config_id number
on_success function
on_failure function

userConfigV2List(session_id, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
on_success function
on_failure function

userConfigV2Load(session_id, config_id, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
config_id number
on_success function
on_failure function

userConfigV2Save(session_id, config_id, description, user_config_aux, config_storage_aux, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
config_id number
description string
user_config_aux Object.<string, string>
config_storage_aux Object.<string, string>
on_success function
on_failure function

userConfigV2SaveAs(session_id, config_name, config_description, user_config_aux, config_storage_aux, on_success, on_failure)

Implements:
Source:
Parameters:
Name Type Description
session_id string
config_name string
config_description string
user_config_aux Object.<string, string>
config_storage_aux Object.<string, string>
on_success function
on_failure function