Packagecom.yahoo.webapis.upcoming
Classpublic class Group
InheritanceGroup Inheritance flash.events.EventDispatcher

Yahoo! Upcoming.org API Group Class. This class is used to hold information about Upcoming.org user groups.


Public Properties
 PropertyDefined by
  commercial_account_id : Number
Group's commercial account ID, if present
Group
  description : String
Upcoming.org user group description.
Group
  id : Number
The Upcoming.org user group identification number.
Group
  is_private : Boolean
Upcoming.org group privacy setting.
Group
  metro_id : Metro
The Metro area associated with the group.
Group
  moderation_level : String
Upcoming.org group moderation level.
Group
  name : String
Upcoming.org user group name.
Group
  num_members : Number
Number of members in the group.
Group
  owner_user : User
The group's creator.
Group
  parent_service : UpcomingService
Defines the parent UpcomingService for this country (used to access the token and API key)
Group
  personal : Boolean
Group's privacy setting.
Group
  start_date : Date
The date and time when the group has been started.
Group
Public Methods
 MethodDefined by
  
Group(_parent_service:UpcomingService, _name:String = null, _description:String = null, _moderation_level:String = null, _is_private:Number = 1, _timestamp:String = null, _owner_user:User = null, _commercial_account_id:Number, _num_members:Number, _id:Number)
Group class constructor
Group
  
add():void
This method adds the Group instance for which it's called to the Upcoming.org database.
Group
  
commit():void
This method commits edits for an existing Group to the Upcoming.org database.
Group
  
update(_id:Number):void
This method updates the data in the specific instance of Group by the ID number.
Group
Property detail
commercial_account_idproperty
public var commercial_account_id:Number

Group's commercial account ID, if present

descriptionproperty 
public var description:String

Upcoming.org user group description.

idproperty 
public var id:Number

The Upcoming.org user group identification number.

is_privateproperty 
public var is_private:Boolean

Upcoming.org group privacy setting. Can be either true(private), or false(public).

metro_idproperty 
public var metro_id:Metro

The Metro area associated with the group.

moderation_levelproperty 
public var moderation_level:String

Upcoming.org group moderation level. Can be either 'moderated' or 'unmoderated'.

nameproperty 
public var name:String

Upcoming.org user group name.

num_membersproperty 
public var num_members:Number

Number of members in the group.

owner_userproperty 
public var owner_user:User

The group's creator.

parent_serviceproperty 
public var parent_service:UpcomingService

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

personalproperty 
public var personal:Boolean

Group's privacy setting. If true, then the group is private; if false, then public.

start_dateproperty 
public var start_date:Date

The date and time when the group has been started.

Constructor detail
Group()constructor
public function Group(_parent_service:UpcomingService, _name:String = null, _description:String = null, _moderation_level:String = null, _is_private:Number = 1, _timestamp:String = null, _owner_user:User = null, _commercial_account_id:Number, _num_members:Number, _id:Number)

Group class constructor

Parameters
_parent_service:UpcomingService — An UpcomingService with an instantiated token and API key.
 
_name:String (default = null) — The name of the user group.
 
_description:String (default = null) — Group description
 
_moderation_level:String (default = null) — Group moderation level, can be either "moderated" or "unmoderated"
 
_is_private:Number (default = 1) — Group privacy setting (true if private, falseotherwise)
 
_timestamp:String (default = null) — The User that owns the group.
 
_owner_user:User (default = null) — The group's commercial account ID, if any.
 
_commercial_account_id:Number — The number of members in the group.
 
_num_members:Number — The group id.
 
_id:Number
Method detail
add()method
public function add():void

This method adds the Group instance for which it's called to the Upcoming.org database.

Upcoming.org requires the group to have at least a name. If the name is already taken, the server returns a 409 error.

commit()method 
public function commit():void

This method commits edits for an existing Group to the Upcoming.org database. It requires that the current group have a valid group ID and a group name.

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

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

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

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



Visit ydn-flash for Yahoo! ASTRA feedback and support