• index
• spv
• ds
• impl
• search: Go

The spv.ds.impl.IPPAdaptor Class

spv.ds.impl.IPPAdaptor(service_url, use_jsonp)

Protocol adaptor for spv.ds.ipprot.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.

service_url {string}

use_jsonp {boolean}

._impl {spv.ds.ipprot.IpadClient}

.disabled_item {Object.<string,boolean>}

.getConfigImage(conf, img_params, on_success, on_failure)

Fetches an image for a serialized configuration.

conf {spv.ds.Config}

img_params {spv.ds.ImageParams}

on_success {function(spv.ds.ImageResult)}

on_failure {function(Error)}

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

limit {number}

scale_width {number}

scale_height {number}

on_success {function(Array.<spv.ds.FreshConfig>)}

on_failure {function(Error)}

.getIntroPage(on_success, on_failure)

on_success {function(spv.ds.IntroPage)}

on_failure {function(Error)}

.getItemResources(item_ids, category, model, language, on_success, on_failure)

item_ids {Array<string>}

category {string}

model {string}

language {string}

on_success {function(Object<string,spv.ds.ItemResources>)}

on_failure {function(Error)}

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

item_id {string}

model {string}

category {string}

on_success {function(Array.<spv.ds.ReadMoreResource>)}

on_failure {function(Error)}

.getUserConfigList(username, on_success, on_failure)

username {string}

on_success {function(Array.<spv.ds.SavedConfig>)}

on_failure {function(Error)}

.publicConfigV2Load(session_id, public_config_id, on_success, on_failure)

session_id {string}

public_config_id {string}

on_success {Function}

on_failure {function(Error)}

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

session_id {string}

description {string}

config_storage_aux {Object.<string, string>}

on_success {function(spv.ds.PublicConfigInfo)}

on_failure {function(Error)}

.resetPassword(token, new_password, on_success, on_failure)

token {string}

new_password {string}

on_success {Function}

on_failure {function(Error)}

.sessionAddGuiGroupSubscriptions(session_id, group_ids, on_success, on_failure)

session_id {string}

group_ids {Array.<string>}

on_success {function()}

on_failure {function(Error)}

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

session_id {string}

category {string}

item_ids {Array.<string>}

language {string}

on_success {function(spv.ds.SessionStateUpdate, spv.ds.impl.AuxData)}

on_failure {function(Error)}

.sessionClearGuiGroupSubscriptions(session_id, on_success, on_failure)

session_id {string}

on_success {function()}

on_failure {function(Error)}

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

Hides multiple server calls required to initialize

menu_query {string}

readmore_mode {string}

language {string}

ttl {number}

NOT IMPLEMENTED IN PRE-NOVA BOOSTER

origin {string}

NOT IMPLEMENTED IN PRE-NOVA BOOSTER

category {string}

NOT IMPLEMENTED IN PRE-NOVA BOOSTER

on_success {function(spv.ds.impl.SessionInitData)}

on_failure {function(Error)}

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

session_id {string}

user_name {string}

password {string}

on_success {Function}

on_failure {function(Error)}

.sessionGeneratePdf(session_id, on_success, on_failure)

session_id {string}

on_success {function(string)}

Callback taking the generated pdf url

on_failure {function(Error)}

.sessionGeneratePublicConfig(session_id, on_success, on_failure)

session_id {string}

on_success {function(string)}

on_failure {function(Error)}

.sessionGetConfig(session_id, encoding, on_success, on_failure)

session_id {string}

encoding {string}

on_success {function(spv.ds.Config)}

on_failure {function(Error)}

.sessionGetConfigNames(session_id, on_success, on_failure)

session_id {string}

on_success {function(Array.<string>)}

on_failure {function(Error)}

.sessionGetFacebookShareData(session_id, on_success, on_failure)

session_id {string}

on_success {function(spv.ds.FacebookShareData)}

on_failure {function(Error)}

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

session_id {string}

limit {number}

scale_width {number}

scale_height {number}

on_success {function(Array.<spv.ds.FreshConfig>)}

on_failure {function(Error)}

.sessionGetImage(session_id, img_params, on_success, on_failure)

session_id {string}

img_params {spv.ds.ImageParams}

on_success {function(spv.ds.ImageResult)}

on_failure {function(Error)}

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

session_id {string}

item_ids {Array.<string>}

language {string}

on_success {function(Array.<spv.ds.MenuItem>)}

on_failure {function(Error)}

.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)

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(string)}

on_failure {function(Error)}

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

session_id {string}

filter_name {string}

query {spv.ds.PresentationStructureQuery}

on_success {function(spv.ds.PresentationStructure)}

on_failure {function(Error)}

.sessionGetStateResolvers(session_id, item_id, on_success, on_failure)

session_id {string}

item_id {string}

on_success {function(Array.<spv.ds.impl.GoalStateResolver>)}

on_failure {function(Error)}

.sessionGetSummary(session_id, on_success, on_failure)

session_id {string}

on_success {function(spv.ds.Summary)}

on_failure {function(Error)}

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

session_id {string}

config_name {string}

img_params {spv.ds.ImageParams}

on_success {function(spv.ds.ImageResult)}

on_failure {function(Error)}

.sessionHasLoggedInUser(session_id, on_success, on_failure)

session_id {string}

on_success {function(boolean)}

on_failure {function(Error)}

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

session_id {string}

config {spv.ds.Config}

language {string}

on_success {function(spv.ds.ConfigLoadResult, spv.ds.SessionStateUpdate, spv.ds.impl.AuxData)}

on_failure {function(Error)}

.sessionLoadConfigByName(session_id, config_name, on_success, on_failure)

session_id {string}

config_name {string}

on_success {function(spv.ds.ConfigLoadResult, spv.ds.SessionStateUpdate, spv.ds.impl.AuxData)}

on_failure {function(Error)}

.sessionLoadPublicConfig(session_id, config_name, on_success, on_failure)

session_id {string}

config_name {string}

on_success {function(spv.ds.ConfigLoadResult, spv.ds.SessionStateUpdate, spv.ds.impl.AuxData)}

on_failure {function(Error)}

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

session_id {string}

user_name {string}

password {string}

on_success {Function}

on_failure {function(Error)}

.sessionLogout(session_id, on_success, on_failure)

session_id {string}

on_success {function(boolean)}

on_failure {function(Error)}

.sessionRemoveConfigByName(session_id, config_name, on_success, on_failure)

session_id {string}

config_name {string}

on_success {Function}

on_failure {function(Error)}

.sessionResume(session_id, language, on_success, on_failure)

session_id {string}

language {string}

on_success {function(spv.ds.impl.SessionInitData)}

on_failure {function(Error)}

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

session_id {string}

config_name {string}

allow_overwrite {boolean}

on_success {Function}

on_failure {function(Error)}

.sessionSendHeartBeat(session_id, on_success, on_failure)

session_id {string}

on_success {function(string)}

on_failure {function(Error)}

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

session_id {string}

main_url {string}

user_name {string}

language {string}

on_success {Function}

on_failure {function(Error)}

.sessionSetPriceLocalization(session_id, price_localization_id, on_success, on_failure)

session_id {string}

price_localization_id {string}

on_success {Function}

on_failure {function(Error)}

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

session_id {string}

item_id {string}

category {string}

language {string}

on_bop {function(spv.ds.SessionStateUpdate, spv.ds.impl.AuxData)}

on_resolvers {function(Array.<spv.ds.impl.GoalStateResolver>)}

on_failure {function(Error)}

.sessionUpdateBop(session_id, language, on_success, on_failure)

session_id {string}

language {string}

on_success {function(spv.ds.SessionStateUpdate, spv.ds.impl.AuxData)}

on_failure {function(Error)}

.userConfigV2Delete(session_id, config_id, on_success, on_failure)

session_id {string}

config_id {number}

on_success {function()}

on_failure {function(Error)}

.userConfigV2List(session_id, on_success, on_failure)

session_id {string}

on_success {function(Array<spv.ds.UserConfigInfo>)}

on_failure {function(Error)}

.userConfigV2Load(session_id, config_id, on_success, on_failure)

session_id {string}

config_id {number}

on_success {function()}

on_failure {function(Error)}

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

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(Error)}

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

session_id {string}

config_name {string}

config_description {string}

user_config_aux {Object.<string,string>}

config_storage_aux {Object.<string,string>}

on_success {function(number)}

on_failure {function(Error)}

Documentation generated using JvJsDoc, version 0.5 on 2016-11-01.