vds/ServiceInfo.js

/**
 * @fileoverview Exposed data type for use outside of VdsClient.
 *               All properties should be exposed to allow use from uncompiled
 *               code.
 *
 * @author kim.simmons@spark-vision.com (Kim Simmons)
 */


goog.provide( 'spv.vds.ServiceInfo' );


/**
 * If the ServiceInfo.has_message is true, then the message must be displayed
 * before initializing the client.
 * If blocking_dialog is true then the client shouldn't be allowed to start at all.
 * This is usually in the case of maintanence.
 *
 * @export
 * @struct
 * @constructor
 * @param {!string} service_url
 * @param {string} message
 * @param {boolean} blocking
 */
spv.vds.ServiceInfo = function( service_url, message, blocking )
{
	/**
	 * @nocollapse
	 * @type {string}
	 */
	this.service_url = service_url;

	/**
	 * @nocollapse
	 * @type {boolean}
	 */
	this.has_message = Boolean(message);
	/**
	 * @nocollapse
	 * @type {string}
	 */
	this.message = message;
	/**
	 * @nocollapse
	 * @type {boolean}
	 */
	this.blocking_dialog = blocking == true;
};