Package | com.brightcove.api.events |
Class | public class SearchEvent |
Inheritance | SearchEvent ![]() |
Property | Defined 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 |
Method | Defined 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 |
Constant | Defined 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 |
items | property |
items:Array
[read-only] Returns the most recent page/array of items in the search result.
public function get items():Array
pageNumber | property |
pageNumber:uint
[read-only] Returns the current page of the result set.
public function get pageNumber():uint
pageSize | property |
pageSize:uint
[read-only] Returns the number of items in each page of the result set.
public function get pageSize():uint
videoSearch | property |
videoSearch:VideoSearch
[read-only] Returns the VideoSearch instance broadcasting the event.
public function get videoSearch():VideoSearch
SearchEvent | () | Constructor |
public function SearchEvent(type:String, videoSearch:VideoSearch, items:Array = null, pageSize:uint = 0, pageNumber:uint = 0)
Constructor.
Parameterstype: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.
|
clone | () | method |
override public function clone():Event
Returns a copy of the event instance.
ReturnsEvent — A copy of the event.
|
ERROR | Constant |
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.
RESULT | Constant |
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.