Packagecom.brightcove.api.events
Classpublic class SearchEvent
InheritanceSearchEvent Inheritance flash.events.Event

Events specifically for video searches.



Public Properties
 PropertyDefined By
  items : Array
[read-only] Returns the most recent page/array of items in the search result.
SearchEvent
  pageNumber : uint
[read-only] Returns the current page of the result set.
SearchEvent
  pageSize : uint
[read-only] Returns the number of items in each page of the result set.
SearchEvent
  videoSearch : VideoSearch
[read-only] Returns the VideoSearch instance broadcasting the event.
SearchEvent
Public Methods
 MethodDefined By
  
SearchEvent(type:String, videoSearch:VideoSearch, items:Array = null, pageSize:uint = 0, pageNumber:uint = 0)
Constructor.
SearchEvent
  
clone():Event
[override] Returns a copy of the event instance.
SearchEvent
Public Constants
 ConstantDefined By
  ERROR : String = searchError
[static] The SearchEvent.ERROR constant defines the value of the type property of the event object for a searchError event.
SearchEvent
  RESULT : String = searchResult
[static] The SearchEvent.RESULT constant defines the value of the type property of the event object for a searchResult event.
SearchEvent
Property Detail
itemsproperty
items:Array  [read-only]

Returns the most recent page/array of items in the search result.


Implementation
    public function get items():Array
pageNumberproperty 
pageNumber:uint  [read-only]

Returns the current page of the result set.


Implementation
    public function get pageNumber():uint
pageSizeproperty 
pageSize:uint  [read-only]

Returns the number of items in each page of the result set.


Implementation
    public function get pageSize():uint
videoSearchproperty 
videoSearch:VideoSearch  [read-only]

Returns the VideoSearch instance broadcasting the event.


Implementation
    public function get videoSearch():VideoSearch
Constructor Detail
SearchEvent()Constructor
public function SearchEvent(type:String, videoSearch:VideoSearch, items:Array = null, pageSize:uint = 0, pageNumber:uint = 0)

Constructor.

Parameters
type:String — name if the event.
 
videoSearch:VideoSearch — VideoSearch instance broadcasting the event.
 
items:Array (default = null) — array of items in the current page of the search.
 
pageSize:uint (default = 0) — number of items in each page of the result set.
 
pageNumber:uint (default = 0) — current page of the result set.
Method Detail
clone()method
override public function clone():Event

Returns a copy of the event instance.

Returns
Event — A copy of the event.
Constant Detail
ERRORConstant
public static const ERROR:String = searchError

The SearchEvent.ERROR constant defines the value of the type property of the event object for a searchError event.

RESULTConstant 
public static const RESULT:String = searchResult

The SearchEvent.RESULT constant defines the value of the type property of the event object for a searchResult event.