com.yahoo.webapis.upcoming.uEvent

	Property	Defined by
		category : Category The event category (from a preset list of Upcoming.org categories).	uEvent
		description : String Event description	uEvent
		end_date : Date The ending date and time for the event, if applicable	uEvent
		geocoding_ambiguous : Boolean A Boolean indicating whether the geocoding associated with the event is ambiguous.	uEvent
		geocoding_precision : String String describing the level of precision for the geographic information (for example, "zip", or "address")	uEvent
		id : Number The Upcoming.org event ID	uEvent
		latitude : Number Latitude of the event's location	uEvent
		longitude : Number Longitude of the event's location	uEvent
		metro : Metro The metro area to which the event belogs.	uEvent
		name : String The event name	uEvent
		parent_service : UpcomingService Defines the parent UpcomingService for this event (used to access the token and API key)	uEvent
		personal : Boolean The privacy flag: if `true`, the event is private; otherwise, public.	uEvent
		post_date : Date The date when the event was posted	uEvent
		selfpromotion : Boolean The selfpromotion flag.	uEvent
		start_date : Date The starting date and time for the event	uEvent
		url : String The event website URL, if applicable.	uEvent
		user : User The user announcing the event.	uEvent
		venue : Venue The venue where the event will take place.	uEvent
		watchlist : Array List of users watching the event.	uEvent

	Method	Defined by
		uEvent(_parent_service:UpcomingService, _name:String = null, _venue:Venue = null, _metro:Metro = null, _category:Category = null, _start_date:Date = null, _end_date:Date = null, _description:String = null, _url:String = null, _personal:Boolean = false, _selfpromotion:Boolean = false) Constructor for the uEvent class.	uEvent
		add():void Adds the current event and its filled in data to the Upcoming.org database.	uEvent
		commit():void Updates an existing event with the current event's instance's data fields.	uEvent
		getUsersWatching():void Gets a list of users currently watching or attending this event.	uEvent
		update(event_id:Number):void This method updates the data in the specific instance of uEvent by the ID number.	uEvent

Property detail

category

property

public var category:Category

The event category (from a preset list of Upcoming.org categories).

description

property

public var description:String

Event description

end_date

property

public var end_date:Date

The ending date and time for the event, if applicable

geocoding_ambiguous

property

public var geocoding_ambiguous:Boolean

A Boolean indicating whether the geocoding associated with the event is ambiguous.

geocoding_precision

property

public var geocoding_precision:String

String describing the level of precision for the geographic information (for example, "zip", or "address")

property

public var id:Number

The Upcoming.org event ID

latitude

property

public var latitude:Number

Latitude of the event's location

longitude

property

public var longitude:Number

Longitude of the event's location

metro

property

public var metro:Metro

The metro area to which the event belogs.

name

property

public var name:String

The event name

parent_service

property

public var parent_service:UpcomingService

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

personal

property

public var personal:Boolean

The privacy flag: if true, the event is private; otherwise, public.

post_date

property

public var post_date:Date

The date when the event was posted

selfpromotion

property

public var selfpromotion:Boolean

The selfpromotion flag. If true, then the event is being self-promoted.

start_date

property

public var start_date:Date

The starting date and time for the event

url

property

public var url:String

The event website URL, if applicable.

user

property

public var user:User

The user announcing the event.

venue

property

public var venue:Venue

The venue where the event will take place.

watchlist

property

public var watchlist:Array

List of users watching the event.

Constructor detail

uEvent

()

constructor

public function uEvent(_parent_service:UpcomingService, _name:String = null, _venue:Venue = null, _metro:Metro = null, _category:Category = null, _start_date:Date = null, _end_date:Date = null, _description:String = null, _url:String = null, _personal:Boolean = false, _selfpromotion:Boolean = false)

Constructor for the uEvent class. The only required parameter is the _parent_service, which gives uEvent access to the API key and the user token. Other parameters may need to be filled in depending on what methods are called.

Parameters

	`_parent_service:UpcomingService` — An UpcomingService with an instantiated token and API key.

	`_name:String` (default = `null`) — The event name

	`_venue:Venue` (default = `null`) — The venue where the event is to take place

	`_metro:Metro` (default = `null`) — The metro area where the event venue is located

	`_category:Category` (default = `null`) — The event category, from a preset list of Upcoming.org categories

	`_start_date:Date` (default = `null`) — The starting date and time of the event

	`_end_date:Date` (default = `null`) — The end date and time for the event

	`_description:String` (default = `null`) — The event description

	`_url:String` (default = `null`) — Event's website URL, if applicable

	`_personal:Boolean` (default = `false`) — Event's privacy setting. If `true`, the event is private, otherwise it is public.

	`_selfpromotion:Boolean` (default = `false`) — Event's self-promotion flag. If `true`, then the event is self-promoted.

Method detail

add

()

method

public function add():void

Adds the current event and its filled in data to the Upcoming.org database. The database requires that the name, venue and category are filed in. When the event is added, uEvent dispatched a UpcomingResultEvent.EVENT_ADDED event.





commit () method  



public function commit():void
 Updates an existing event with the current event's instance's data fields.
 Requires that the event's ID is filled in; if it's not, it adds the event
 as a new event instead.
 When editing an event is complete, the uEvent instance dispatches 
 UpcomingResultEvent.EVENT_EDITED event.
 
 



getUsersWatching () method  



public function getUsersWatching():void
 Gets a list of users currently watching or attending
 this event. The event id is required to be filled in. 
 When the list of users is received, uEvent dispatches
 UpcomingResultEvent.USERS_WATCHING_EVENT, 
 with an array of Users contained in the event object's 
 data field.
 



update () method  



public function update(event_id:Number):void
    This method updates the data in the specific instance of uEvent
    by the ID number. If the id property is already filled in,
    then no argument needs to be passed. Otherwise, pass the uEvent's
    Upcoming.org identification number.
    
When the update completes, the uEvent class will dispatch an
    UpcomingResultEvent.EVENT_LOADED event.
    Parameters


event_id:Number — The uEvent's Upcoming.org identification number, if
    none is filled in.
    
    













Visit ydn-flash for Yahoo! ASTRA feedback and support

Astra Library Documentation
Class uEvent
Properties \| Methods	All Packages \| All Classes \| Index \| Frames No Frames

Package	com.yahoo.webapis.upcoming
Class	public class uEvent
Inheritance	uEvent flash.events.EventDispatcher