API Docs for: 1.7.0
Show:

AvailabilityPlugin Class

Constructor

AvailabilityPlugin

(
  • core
  • options
)

Parameters:

  • core Core

    A reference to core object

  • options Object

    A list of options to set

    • service String | URL

      the url to the ismds server that will return availability data

    • apiKey String

      the API key is needed for authentication by the ISMDS service

    • apiSecret String

      the API secret is also needed for authentication by the ISMDS service

    • [placeUpdateInterval=30000] Integer optional

      the amount of milliseconds that have to pass before the place availability will update

    • [summaryUpdateInterval=75000] Integer optional

      the amount of milliseconds that have to pass before the summary will update

    • [platinumEnabled] Boolean optional

      Indicates if platinum data is to be fetched

    • [resaleEnabled] Boolean optional

      Indicates if resale data is to be fetched

    • [ranges] Array optional

      An array of objects with the keys range, and color

Example:

var ismdsOptions= {
        service: 'https://services.ticketmaster.com/api/ismds',
        apiKey: 'aj6sxy6vhtv7bujsnvgejsblcifgfd',
        apiSecret:'sc2ruf344746p4symm3lunsbbqfs',
        summaryUpdateInterval: 10000,
        placeUpdateInterval: 5000,
        platinumEnabled: true;
        resaleEnabled: true,
        ranges:[{range: '0',color: '999999'}, {range: '0.25', color: '000000'},   {range: '0.25', color: '91c9ea'}, {range: '0.75', color: '1099de'},  {range: '1', color: '004878'}]
    };
 ICE.ISMDSPlugin.create(ice, ismdsOptions);

Properties

apiKey

String private

The API Key is needed for authentication by the ISMDS service

apiSecret

String private

The API secret is also needed for authentication by the ISMDS service

core

CORE

Instance of core

placeUpdateInterval

Integer Milliseconds

Sets the delay for fetching availability data for places

Default: 30000

platinumEnabled

Boolean

Indicates whether or not we get platinum data

resaleEnabled

Boolean

Indicates whether or not we get resale data

service

String

Sets the link to the availability server

summaryUpdateInterval

Integer Milliseconds

Sets the delay for fetching availability data for segments

Default: 75000