| Package | com.yahoo.webapis.upcoming |
| Class | public class User |
| Inheritance | User  flash.events.EventDispatcher |
| Property | Defined by | ||
|---|---|---|---|
| id : Number
The Upcoming.org user's id number.
| User | ||
| name : String
The Upcoming.org user's name.
| User | ||
| parent_service : UpcomingService
Defines the parent UpcomingService for this user (used to access the token and API key)
| User | ||
| photourl : String
The Upcoming.org user's photo URL.
| User | ||
| username : String
The Upcoming.org user's username.
| User | ||
| zip : String
The Upcoming.org user's zip code.
| User | ||
| Method | Defined by | ||
|---|---|---|---|
|
User(_parent_service:UpcomingService, _id:Number, _name:String, _username:String, _zip:String, _photourl:String)
The User class constructor.
| User | ||
|
getMetroList():void
This method retrieves a list of Metros for the given user.
| User | ||
|
getWatchList(show:String = null):void
This retrieves a list of events watched by a specific user.
| User | ||
|
updateById(_id:Number):void
This method updates the data in the specific instance of User
by the ID number.
| User | ||
|
updateByUsername(_username:String = null):void
This method updates the data in the specific instance of user
by the username.
| User | ||
| id | property |
public var id:NumberThe Upcoming.org user's id number.
| name | property |
public var name:StringThe Upcoming.org user's name.
| parent_service | property |
public var parent_service:UpcomingServiceDefines the parent UpcomingService for this user (used to access the token and API key)
| photourl | property |
public var photourl:StringThe Upcoming.org user's photo URL.
| username | property |
public var username:StringThe Upcoming.org user's username.
| zip | property |
public var zip:StringThe Upcoming.org user's zip code.
| User | () | constructor |
public function User(_parent_service:UpcomingService, _id:Number, _name:String, _username:String, _zip:String, _photourl:String)The User class constructor.
Parameters_parent_service:UpcomingService — An UpcomingService with an instantiated token and API key.
|
|
_id:Number — The user id.
|
|
_name:String — The user's name.
|
|
_username:String — The user's username.
|
|
_zip:String — The user's zip code.
|
|
_photourl:String — The user's photo URL.
|
| getMetroList | () | method |
public function getMetroList():void
This method retrieves a list of Metros for the given user.
When the list if retrieved, the current instance of User
dispatches a UpcomingResultEvent.METRO_GET_LIST event.
| getWatchList | () | method |
public function getWatchList(show:String = null):voidThis retrieves a list of events watched by a specific user. When the results are received, the current instance of User dispatches a USER_GET_WATCHLIST event.
Parametersshow:String (default = null) |
| updateById | () | method |
public function updateById(_id:Number):void
This method updates the data in the specific instance of User
by the ID number. If the id property is already filled in,
then no argument needs to be passed. Otherwise, pass the user's
Upcoming.org identification number.
When the update completes, the user class will dispatch an
UpcomingResultEvent.USER_UPDATED event.
_id:Number — The user's Upcoming.org identification number, if
none is filled in.
|
| updateByUsername | () | method |
public function updateByUsername(_username:String = null):void
This method updates the data in the specific instance of user
by the username. If the username property is already filled in,
then no argument needs to be passed. Otherwise, pass the user's
Upcoming.org identification number.
When the update completes, the user class will dispatch an
UpcomingResultEvent.USER_UPDATED event.
_username:String (default = null) |