IpadClient

IpadClient

new IpadClient(service_url, use_jsonp)

Source:
Parameters:
Name Type Description
service_url string
use_jsonp boolean

Classes

ProtocolError

Methods

add_gui_group_subscriptions(session_id, group_ids, on_success, on_failure)

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

attempt_bip(session_id, category, input, on_success, on_failure)

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

attempt_bip_v2(session_id, input, language, on_success, on_failure)

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

bip(session_id, category, input, language, on_success, on_failure)

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

build_info(on_success, on_failure)

Source:
Parameters:
Name Type Description
on_success function
on_failure function

clear_gui_group_subscriptions(session_id, on_success, on_failure)

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

create_session(menu_query, readmore_mode, language, disabled_flag_mode, ttl, origin, category, on_success, on_failure)

Source:
Parameters:
Name Type Description
menu_query string
readmore_mode spv.ds.ipprot_nova.input.BopReadMoreMode
language string
disabled_flag_mode spv.ds.ipprot_nova.input.BopDisabledFlagMode
ttl number
origin string
category string
on_success function
on_failure function

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

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

generate_pdf(session_id, template_name, add_auto_print, show_print_dialog, on_success, on_failure)

Source:
Parameters:
Name Type Description
session_id string
template_name string
add_auto_print boolean
show_print_dialog boolean
on_success function
on_failure function

generate_public_config(session_id, conf_name, on_success, on_failure)

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

get_bump(session_id, category, language, on_success, on_failure)

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

get_categories(on_success, on_failure)

Source:
Parameters:
Name Type Description
on_success function
on_failure function

get_config_as_string(session_id, encoding, on_success, on_failure)

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

get_config_image(encoded_config, encoding, scaled_width, scaled_height, serie_name, frame, crop_x_ratio, crop_y_ratio, cropped_width, cropped_height, skip, skip_groups, only_use, only_use_groups, file_type, use_hd, keep_aspect_ratio, auto_crop, bg_color_hex, on_success, on_failure)

Source:
Parameters:
Name Type Description
encoded_config string
encoding string
scaled_width number
scaled_height number
serie_name string
frame number
crop_x_ratio number
crop_y_ratio number
cropped_width number
cropped_height number
skip string
skip_groups string
only_use string
only_use_groups string
file_type string
use_hd boolean
keep_aspect_ratio boolean
auto_crop boolean
bg_color_hex string
on_success function
on_failure function

get_config_image_light(encoded_config, encoding, output_width, output_height, serie_name, frame, file_type, keep_aspect_ratio, on_success, on_failure)

Source:
Parameters:
Name Type Description
encoded_config string
encoding string
output_width number
output_height number
serie_name string
frame number
file_type string
keep_aspect_ratio boolean
on_success function
on_failure function

get_configs(session_id, on_success, on_failure)

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

get_current_config_image(session_id, scaled_width, scaled_height, serie_name, frame, crop_x_ratio, crop_y_ratio, cropped_width, cropped_height, skip, skip_groups, only_use, only_use_groups, file_type, use_hd, keep_aspect_ratio, auto_crop, bg_color_hex, allow_padding, on_success, on_failure)

Source:
Parameters:
Name Type Description
session_id string
scaled_width number
scaled_height number
serie_name string
frame number
crop_x_ratio number
crop_y_ratio number
cropped_width number
cropped_height number
skip string
skip_groups string
only_use string
only_use_groups string
file_type string
use_hd boolean
keep_aspect_ratio boolean
auto_crop boolean
bg_color_hex string
allow_padding boolean
on_success function
on_failure function

get_facebook_share_data(session_id, on_success, on_failure)

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

get_fresh_configs(ctime, limit, meta_filter, scale_width, scale_height, on_success, on_failure)

Source:
Parameters:
Name Type Description
ctime number
limit number
meta_filter string
scale_width number
scale_height number
on_success function
on_failure function

get_image(session_id, serie_index, frame_index, on_success, on_failure)

Source:
Parameters:
Name Type Description
session_id string
serie_index number
frame_index number
on_success function
on_failure function

get_image_absolute_url(session_id, serie_index, frame_index, on_success, on_failure)

Source:
Parameters:
Name Type Description
session_id string
serie_index number
frame_index number
on_success function
on_failure function

get_image_from_encoded_string(encoded_config, enc_type, crop_x_rationullable, crop_y_rationullable, cropped_width, cropped_height, auto_crop, scaled_width, scaled_height, keep_aspect_ratio, ext, shadows, main_image, background, use_hd, serie, frame, on_success, on_failure)

Source:
Parameters:
Name Type Attributes Description
encoded_config string
enc_type string
crop_x_ratio number <nullable>
crop_y_ratio number <nullable>
cropped_width number
cropped_height number
auto_crop boolean
scaled_width number
scaled_height number
keep_aspect_ratio boolean
ext string
shadows boolean
main_image boolean
background boolean
use_hd boolean
serie string
frame number
on_success function
on_failure function

get_initial_consequence_of_change(session_id, language, on_success, on_failure)

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

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

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

get_item_resources(category, model, language, item_ids, on_success, on_failure)

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

get_media_kit(session_id, serie_index, frame_index, file_type, separate_background, separate_shadow, all_frames, use_hd, aspect_ratio, allow_padding, image_width, image_height, on_success, on_failure)

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
aspect_ratio number
allow_padding boolean
image_width number
image_height number
on_success function
on_failure function

get_presentation_structure(session_id, filter_name, filter_query, on_success, on_failure)

Source:
Parameters:
Name Type Description
session_id string
filter_name string
filter_query Array.<string>
on_success function
on_failure function

get_presentation_structure_v2(session_id, filter_name, filter_query, on_success, on_failure)

Source:
Parameters:
Name Type Description
session_id string
filter_name string
filter_query spv.ds.ipprot_nova.input.PresentationStructureQuery
on_success function
on_failure function

get_readmore(item_id, model, category, language, on_success, on_failure)

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

get_state_resolvers(session_id, item_id, on_success, on_failure)

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

get_user_config_image(session_id, config_name, scaled_width, scaled_height, serie_name, frame, crop_x_ratio, crop_y_ratio, cropped_width, cropped_height, skip, skip_groups, only_use, only_use_groups, file_type, use_hd, keep_aspect_ratio, auto_crop, bg_color_hex, on_success, on_failure)

Source:
Parameters:
Name Type Description
session_id string
config_name string
scaled_width number
scaled_height number
serie_name string
frame number
crop_x_ratio number
crop_y_ratio number
cropped_width number
cropped_height number
skip string
skip_groups string
only_use string
only_use_groups string
file_type string
use_hd boolean
keep_aspect_ratio boolean
auto_crop boolean
bg_color_hex string
on_success function
on_failure function

heartbeat(session_id, on_success, on_failure)

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

init_settings(on_success, on_failure)

Source:
Parameters:
Name Type Description
on_success function
on_failure function

initialize_session(on_success, on_failure)

Source:
Parameters:
Name Type Description
on_success function
on_failure function

load_config(session_id, conf_name, on_success, on_failure)

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

load_config_from_string(session_id, config, encoding, language, memorize_mode, on_success, on_failure)

Source:
Parameters:
Name Type Description
session_id string
config string
encoding string
language string
memorize_mode string
on_success function
on_failure function

load_public_config(session_id, conf_name, on_success, on_failure)

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

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

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

logout(session_id, on_success, on_failure)

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

public_config_v2_info(public_config_id, on_success, on_failure)

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

public_config_v2_load(session_id, public_config_id, on_success, on_failure)

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

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

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

rebop(session_id, language, on_success, on_failure)

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

remove_config(session_id, conf_name, on_success, on_failure)

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

reset(session_id, on_success, on_failure)

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

reset_password(token, new_password, on_success, on_failure)

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

save_config(session_id, conf_name, allow_overwrite, on_success, on_failure)

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

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

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

session_has_logged_in_user(session_id, on_success, on_failure)

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

set_menu_query(session_id, menu_query, on_success, on_failure)

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

set_price_localization(session_id, lid, on_success, on_failure)

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

test_internal_server_error(on_success, on_failure)

Source:
Parameters:
Name Type Description
on_success function
on_failure function

user_config_add_flag(user_name, config_name, flag, on_success, on_failure)

Source:
Parameters:
Name Type Description
user_name string
config_name string
flag string
on_success function
on_failure function

user_config_add_flag_to_all(user_name, flag, on_success, on_failure)

Source:
Parameters:
Name Type Description
user_name string
flag string
on_success function
on_failure function

user_config_add_flag_to_all_ignoring_flags(user_name, flag, ignore_flags, on_success, on_failure)

Source:
Parameters:
Name Type Description
user_name string
flag string
ignore_flags Array.<string>
on_success function
on_failure function

user_config_list(user_name, on_success, on_failure)

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

user_config_list_ignoring_flags(user_name, ignore_flags, on_success, on_failure)

Source:
Parameters:
Name Type Description
user_name string
ignore_flags Array.<string>
on_success function
on_failure function

user_config_load(session_id, user_name, config_name, on_success, on_failure)

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

user_config_remove_all_configs(user_name, on_success, on_failure)

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

user_config_remove_flag(user_name, config_name, flag, on_success, on_failure)

Source:
Parameters:
Name Type Description
user_name string
config_name string
flag string
on_success function
on_failure function

user_config_remove_flag_from_all(user_name, flag, on_success, on_failure)

Source:
Parameters:
Name Type Description
user_name string
flag string
on_success function
on_failure function

user_config_remove_flag_from_all_ignoring_flags(user_name, flag, ignore_flags, on_success, on_failure)

Source:
Parameters:
Name Type Description
user_name string
flag string
ignore_flags Array.<string>
on_success function
on_failure function

user_config_remove_user(user_name, on_success, on_failure)

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

user_config_remove_user_config(user_name, config_name, on_success, on_failure)

Source:
Parameters:
Name Type Description
user_name string
config_name string
on_success function
on_failure function

user_config_save(session_id, user_name, config_name, allow_overwrite, on_success, on_failure)

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

user_config_save_user_data(session_id, user_name, on_success, on_failure)

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

user_config_v2_delete(session_id, user_config_id, on_success, on_failure)

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

user_config_v2_list(session_id, on_success, on_failure)

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

user_config_v2_load(session_id, user_config_id, on_success, on_failure)

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

user_config_v2_save(session_id, user_config_id, description, user_config_aux, config_storage_aux, on_success, on_failure)

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

user_config_v2_save_as(session_id, config_name, description, user_config_aux, config_storage_aux, on_success, on_failure)

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