vision-embedded-web/dist/storadge/index.d.ts

Cubic Vision methods for embedded web content.

/**
 * Receiving data in JSON string format
 * @param  {string} key - data key
 * @returns Promise<string> - data value
 */
export declare function getJSON(key: string): Promise<string>;
/**
 * Saving data in JSON string format
 * @param  {string} key - data key
 * @param  {string} value - data value
 * @param  {boolean=false} useAfterRepublishing - do not clear data after template republishing
 * @returns Promise<void>
 */
export declare function setJSON(key: string, value: string, useAfterRepublishing?: boolean): Promise<void>;
/**
 * Receiving data in object format
 * @param  {string} key - data key
 * @returns Promise<DataT | null> - data value
 */
export declare function get<DataT>(key: string): Promise<DataT | null>;
/**
 * Saving data in object format
 * @param  {string} key - data key
 * @param  {DataT} value - data value
 * @param  {boolean=false} useAfterRepublishing - do not clear data after template republishing
 * @returns Promise<void>
 */
export declare function set<DataT>(key: string, value: DataT, useAfterRepublishing?: boolean): Promise<void>;
/**
 * Getting variable value from СMS for the player
 * @param  {string} varName - variable name
 * @returns Promise<string> - variable value
 */
export declare function getVar(varName: string): Promise<string>;