ThemeParks

Class: TE2Park

TE2Park

Implements the The Experience Engine API framework.

new TE2Park(options)

Create new TE2Park Object. This object should not be called directly, but rather extended for each of the individual TE2 parks
Parameters:
Name Type Description
options Object
Properties
Name Type Argument Description
park_id String ID of the park to access the API for
auth_token String <optional>
 Auth token to use to connect to the API
api_base String <optional>
 Base URL to access the API
ride_types Array.<String> <optional>
 Array of types that denote rides at the park (to avoid listing restaurants/toilets etc. as rides)

Extends

Members

APIBase :String

Get this park's API Base URL
Type:
  • String

Cache

Get the cache object for this park
Inherited From:
Overrides:

FastPass :Boolean

Does this park offer fast-pass services?
Type:
  • Boolean
Inherited From:
Overrides:

FastPassReturnTimes :Boolean

Does this park tell you the fast-pass return times?
Type:
  • Boolean
Inherited From:
Overrides:

GetNumScheduleDays

How many days are returned by this park's schedule?
Inherited From:
Overrides:

ParkID :String

Get the park ID used by the SeaWorld/Cedar Fair API
Type:
  • String

Schedule :Schedule

Get this park's raw schedule object
Type:
Inherited From:
Overrides:

SupportsOpeningTimes :Boolean

Does this park offer opening time information?
Type:
  • Boolean
Inherited From:
Overrides:

SupportsRideSchedules :Boolean

Does this park offer opening times for rides?
Type:
  • Boolean
Inherited From:
Overrides:

SupportsWaitTimes :Boolean

Does this park offer wait time information?
Type:
  • Boolean
Inherited From:
Overrides:

UserAgent :String

Get this park's useragent string for making network requests This is usually randomly generated on object construction
Type:
  • String
Inherited From:
Overrides:

Methods

BuildWaitTimesResponse()

Build the Wait Times response from JSON data This will create/fetch Ride objects based on the supplied JSON data
Inherited From:
Overrides:

FetchRideNames()

Fetch all the rides and ride names for this park from the API (skip the cache)
Returns:
Object of RideID => Ride name in English
Type
Promise.<Object>

GetOpeningTimes()

Get opening times for this park
Inherited From:
Overrides:

GetRideNames()

Get cached (or fresh fetch) of ride names
Returns:
Object of RideID => Ride name in English
Type
Promise.<Object>

GetRideObject(rideId)

Find (or create) a ride object with the given ID
Parameters:
Name Type Description
rideId * ID to search for/create ride
Inherited From:
Overrides:

GetWaitTimes()

Get waiting times for rides from this park If the last argument is a function, this will act as a callback. Callback will call with callback(error, data) Data will be null if error is present If the last argument is not a function, this will return a Promise.
Inherited From:
Overrides:

HTTP()

Make an HTTP request using this park's user agent and HTTP settings
Inherited From:
Overrides:

UpdateRide(id, options)

Update a ride state
Parameters:
Name Type Description
id String The ride ID to update
options Object Ride options to update
Inherited From:
Overrides: