API Docs for: 1.7.0
Show:

File: src/js/AdditionalDocumentation.js

/**
 * A list of all events emitted by the availability plugin
 * @module EmittedEvents
 * @class EmittedEvents
 */
/**
 * Emitted after availability has been updated for at least one segment
 * @private
 * @event summary-availability-update
 * @param {Array} changedSegments a list of segments with updated availability
 */
/**
 * Emitted after availability has been updated for at least one place
 * @private
 * @event place-availability-update
 * @param {Array} changedPlaces a list of places with updated availability
 *
 */

/**
 * Explanation of the availability url. This use the service URL to go to proxy server that returns the availability data
 * @module Availability URL
 * @class Availability URL
 */
/**
 * Availability URL for summary calls
 * @event /availability?eventId=[eventId]&summary=true
 * @param {String} eventID the event id given the ICE Core in the create function
 */
/**
 * Availability URL for place availability calls
 * @event /availability?eventId=[eventId]&segments=[segmentId]
 * @param {String} eventID the event id given the ICE Core in the create function
 * @param {String} segmentId the segment id we are requesting availability for
 */

/**
 * A list of all default templates. For summary template, the name of the templates will be 'shape-availability-' and the range name. A range name for 0 will look like 0%-0%
 * @class DefaultTemplates
 */

/**
 * Default template for places with OPEN status
 * @event default-place-status-OPEN
 * @param {String} interiorColor color of the place. Default to '004878'
 * @example
 *     var defaultTemplate = ice.templates.find('default-place-status-OPEN');
 *     var interiorColor = defaultTemplate.interiorColor;
 */
/**
 * Default template for places with SOLD status
 * @event default-place-status-SOLD
 * @param {String} interiorColor color of the place. Default to '999999'
 * @example
 *     var defaultTemplate = ice.templates.find('default-place-status-SOLD');
 *     var interiorColor = defaultTemplate.interiorColor;
 */