Packagecom.yahoo.webapis.upcoming
Classpublic class Venue
InheritanceVenue Inheritance flash.events.EventDispatcher

Yahoo! Upcoming.org API Venue Class. This class holds the data about Upcoming.org event venues.



Public Properties
 PropertyDefined by
  address : String
The venue street address.
Venue
  city : String
The venue city.
Venue
  description : String
The venue description
Venue
  geocoding_ambiguous : Boolean
The geocoding ambiguity flag; if true, then the geocoding is ambiguous.
Venue
  geocoding_precision : String
The string describing the geocoding precision for the venue, for example "address" or "zip".
Venue
  id : Number
The Upcoming.org venue id number.
Venue
  latitude : Number
The venue latitude.
Venue
  longitude : Number
The venue longitude.
Venue
  metro : Metro
The metro where the venue is located.
Venue
  name : String
The venue name.
Venue
  parent_service : UpcomingService
Defines the parent UpcomingService for this country (used to access the token and API key)
Venue
  phone : String
The venue phone number.
Venue
  privacy : Boolean
The venue privacy setting: if true, then the venue is private.
Venue
  url : String
The venue web site URL.
Venue
  user : User
The user associated with the venue (creator).
Venue
  zip : String
The venue zip.
Venue
Public Methods
 MethodDefined by
  
Venue(_parent_service:UpcomingService, _name:String = null, _address:String = null, _city:String = null, _metro:Metro = null, _id:Number, _zip:String = null, _phone:String = null, _url:String = null, _description:String = null, _private:Boolean = false)
Venue class constructor.
Venue
  
add():void
Adds the current venue and its filled in data to the Upcoming.org database.
Venue
  
commit():void
Updates an existing venue with the current venue's instance's data fields.
Venue
  
update(_id:Number):void
This method updates the data in the specific instance of Venue by the ID number.
Venue
Property detail
addressproperty
public var address:String

The venue street address.

cityproperty 
public var city:String

The venue city.

descriptionproperty 
public var description:String

The venue description

geocoding_ambiguousproperty 
public var geocoding_ambiguous:Boolean

The geocoding ambiguity flag; if true, then the geocoding is ambiguous.

geocoding_precisionproperty 
public var geocoding_precision:String

The string describing the geocoding precision for the venue, for example "address" or "zip".

idproperty 
public var id:Number

The Upcoming.org venue id number.

latitudeproperty 
public var latitude:Number

The venue latitude.

longitudeproperty 
public var longitude:Number

The venue longitude.

metroproperty 
public var metro:Metro

The metro where the venue is located.

nameproperty 
public var name:String

The venue name.

parent_serviceproperty 
public var parent_service:UpcomingService

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

phoneproperty 
public var phone:String

The venue phone number.

privacyproperty 
public var privacy:Boolean

The venue privacy setting: if true, then the venue is private.

urlproperty 
public var url:String

The venue web site URL.

userproperty 
public var user:User

The user associated with the venue (creator).

zipproperty 
public var zip:String

The venue zip.

Constructor detail
Venue()constructor
public function Venue(_parent_service:UpcomingService, _name:String = null, _address:String = null, _city:String = null, _metro:Metro = null, _id:Number, _zip:String = null, _phone:String = null, _url:String = null, _description:String = null, _private:Boolean = false)

Venue class constructor.

Parameters
_parent_service:UpcomingService — An UpcomingService with an instantiated token and API key.
 
_name:String (default = null) — The venue name.
 
_address:String (default = null) — The venue address.
 
_city:String (default = null) — The venue city.
 
_metro:Metro (default = null) — The venue metro.
 
_id:Number — The venue Upcoming.org id number.
 
_zip:String (default = null) — The venue zip code.
 
_phone:String (default = null) — The venue phone number.
 
_url:String (default = null) — The venue website URL.
 
_description:String (default = null) — The description of the venue.
 
_private:Boolean (default = false) — The venue privacy setting. If true, the venue is private.
Method detail
add()method
public function add():void

Adds the current venue and its filled in data to the Upcoming.org database. The database requires that the name, address, city and metro are filled in. When the venue is added, the current instance of Venue dispatches a UpcomingResultEvent.VENUE_ADDED event.

commit()method 
public function commit():void

Updates an existing venue with the current venue's instance's data fields. Requires that the venue's ID is filled in; if it's not, it adds the venue as a new venue instead. When editing a venue is complete, the Venue instance dispatches UpcomingResultEvent.VENUE_EDITED event.

update()method 
public function update(_id:Number):void

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

When the update completes, the venue class will dispatch an UpcomingResultEvent.VENUE_LOADED event.

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