Packagecom.yahoo.webapis.upcoming
Classpublic class Metro
InheritanceMetro Inheritance flash.events.EventDispatcher

Yahoo! Upcoming.org API Metro Class. This class holds information about Upcoming.org Metro areas.



Public Properties
 PropertyDefined by
  code : String
Upcoming.org Metro area code
Metro
  id : Number
Upcoming.org Metro area identification number
Metro
  name : String
Upcoming.org Metro area name
Metro
  parent_service : UpcomingService
Defines the parent UpcomingService for this Metro (used to access the token and API key)
Metro
  state : State
The state in which the Metro area is located
Metro
Public Methods
 MethodDefined by
  
Metro(_parent_service:UpcomingService, _id:Number, _name:String, _code:String, _state:State)
Metro class constructor
Metro
  
update(_id:Number):void
This method updates the data fields in the specific instance of Metro by the ID number.
Metro
Property detail
codeproperty
public var code:String

Upcoming.org Metro area code

idproperty 
public var id:Number

Upcoming.org Metro area identification number

nameproperty 
public var name:String

Upcoming.org Metro area name

parent_serviceproperty 
public var parent_service:UpcomingService

Defines the parent UpcomingService for this Metro (used to access the token and API key)

stateproperty 
public var state:State

The state in which the Metro area is located

Constructor detail
Metro()constructor
public function Metro(_parent_service:UpcomingService, _id:Number, _name:String, _code:String, _state:State)

Metro class constructor

Parameters
_parent_service:UpcomingService — An UpcomingService with an instantiated token and API key.
 
_id:Number — The Metro area ID
 
_name:String — Metro area name
 
_code:String — Metro area code
 
_state:State — The state in which the Metro area is located
Method detail
update()method
public function update(_id:Number):void

This method updates the data fields in the specific instance of Metro by the ID number. If the id property is already filled in, then no argument needs to be passed. Otherwise, pass the Metro's Upcoming.org identification number.

When the update completes, the Metro class will dispatch an UpcomingResultEvent.METRO_GET_INFO event.

Parameters
_id:Number — The metro's Upcoming.org identification number, if none is filled in.