Packagecom.yahoo.webapis.upcoming
Classpublic class State
InheritanceState Inheritance flash.events.EventDispatcher

Yahoo! Upcoming.org API State Class. This class is used to hold information about states in which Upcoming events take place (for US locations only)



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

The state's Upcoming.org code

idproperty 
public var id:Number

The state's Upcoming.org ID number

nameproperty 
public var name:String

The state's name

parent_serviceproperty 
public var parent_service:UpcomingService

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

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

State class constructor

Parameters
_parent_service:UpcomingService — An UpcomingService with an instantiated token and API key.
 
_id:Number — State's Upcoming.org identification number
 
_name:String — State's name
 
_code:String — State's code
Method detail
update()method
public function update(_id:Number):void

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

When the update completes, the State class will dispatch an UpcomingResultEvent.STATE_GET_INFO event.

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