Package | com.brightcove.api.events |
Class | public class MenuEvent |
Inheritance | MenuEvent ![]() |
Property | Defined By | ||
---|---|---|---|
page : String [read-only]
Returns the name of the menu page sent with the event. | MenuEvent | ||
video : VideoDTO [read-only]
Returns the VideoDTO sent with the event. | MenuEvent |
Method | Defined By | ||
---|---|---|---|
Constructor. | MenuEvent | ||
clone():Event [override]
Returns a copy of the event instance. | MenuEvent |
Constant | Defined By | ||
---|---|---|---|
BLOG_POST_CLICK : String = blogPostClick [static]
The MenuEvent.BLOG_POST_CLICK constant defines the value of the
type property of the event object for a
blogPostClick event. | MenuEvent | ||
COPY_CODE : String = copyCode [static]
The MenuEvent.COPY_CODE constant defines the value of the
type property of the event object for a
copyCode event. | MenuEvent | ||
COPY_LINK : String = copyLink [static]
The MenuEvent.COPY_LINK constant defines the value of the
type property of the event object for a
copyLink event. | MenuEvent | ||
MENU_PAGE_CLOSE : String = menuPageClose [static]
The MenuEvent.MENU_PAGE_CLOSE constant defines the value of the
type property of the event object for a
menuPageClose event. | MenuEvent | ||
MENU_PAGE_OPEN : String = menuPageOpen [static]
The MenuEvent.MENU_PAGE_OPEN constant defines the value of the
type property of the event object for a
menuPageOpen event. | MenuEvent | ||
OVERLAY_MENU_CLOSE : String = overlayMenuClose [static]
The MenuEvent.OVERLAY_MENU_CLOSE constant defines the value of the
type property of the event object for a
overlayMenuClose event. | MenuEvent | ||
OVERLAY_MENU_OPEN : String = overlayMenuOpen [static]
The MenuEvent.OVERLAY_MENU_OPEN constant defines the value of the
type property of the event object for a
overlayMenuOpen event. | MenuEvent | ||
OVERLAY_MENU_PLAY_CLICK : String = overlayMenuPlayClick [static]
The MenuEvent.OVERLAY_MENU_PLAY_CLICK constant defines the value of the
type property of the event object for a
overlayMenuPlayClick event. | MenuEvent | ||
SEND_EMAIL_CLICK : String = sendEmailClick [static]
The MenuEvent.SEND_EMAIL_CLICK constant defines the value of the
type property of the event object for a
sendEmailClick event. | MenuEvent | ||
VIDEO_REQUEST : String = videoRequest [static]
The MenuEvent.VIDEO_REQUEST constant defines the value of the
type property of the event object for a
videoRequest event. | MenuEvent |
page | property |
page:String
[read-only] Returns the name of the menu page sent with the event.
public function get page():String
video | property |
video:VideoDTO
[read-only] Returns the VideoDTO sent with the event.
public function get video():VideoDTO
MenuEvent | () | Constructor |
public function MenuEvent(type:String, page:String = null, video:VideoDTO = null)
Constructor.
Parameterstype:String — name if the event.
| |
page:String (default = null ) — page that is currently loaded in the menu.
| |
video:VideoDTO (default = null ) — video that is currently displayed in the menu.
|
clone | () | method |
override public function clone():Event
Returns a copy of the event instance.
ReturnsEvent — A copy of the event.
|
BLOG_POST_CLICK | Constant |
public static const BLOG_POST_CLICK:String = blogPostClick
The MenuEvent.BLOG_POST_CLICK constant defines the value of the
type
property of the event object for a
blogPostClick
event.
COPY_CODE | Constant |
public static const COPY_CODE:String = copyCode
The MenuEvent.COPY_CODE constant defines the value of the
type
property of the event object for a
copyCode
event.
COPY_LINK | Constant |
public static const COPY_LINK:String = copyLink
The MenuEvent.COPY_LINK constant defines the value of the
type
property of the event object for a
copyLink
event.
MENU_PAGE_CLOSE | Constant |
public static const MENU_PAGE_CLOSE:String = menuPageClose
The MenuEvent.MENU_PAGE_CLOSE constant defines the value of the
type
property of the event object for a
menuPageClose
event.
MENU_PAGE_OPEN | Constant |
public static const MENU_PAGE_OPEN:String = menuPageOpen
The MenuEvent.MENU_PAGE_OPEN constant defines the value of the
type
property of the event object for a
menuPageOpen
event.
OVERLAY_MENU_CLOSE | Constant |
public static const OVERLAY_MENU_CLOSE:String = overlayMenuClose
The MenuEvent.OVERLAY_MENU_CLOSE constant defines the value of the
type
property of the event object for a
overlayMenuClose
event.
OVERLAY_MENU_OPEN | Constant |
public static const OVERLAY_MENU_OPEN:String = overlayMenuOpen
The MenuEvent.OVERLAY_MENU_OPEN constant defines the value of the
type
property of the event object for a
overlayMenuOpen
event.
OVERLAY_MENU_PLAY_CLICK | Constant |
public static const OVERLAY_MENU_PLAY_CLICK:String = overlayMenuPlayClick
The MenuEvent.OVERLAY_MENU_PLAY_CLICK constant defines the value of the
type
property of the event object for a
overlayMenuPlayClick
event.
SEND_EMAIL_CLICK | Constant |
public static const SEND_EMAIL_CLICK:String = sendEmailClick
The MenuEvent.SEND_EMAIL_CLICK constant defines the value of the
type
property of the event object for a
sendEmailClick
event.
VIDEO_REQUEST | Constant |
public static const VIDEO_REQUEST:String = videoRequest
The MenuEvent.VIDEO_REQUEST constant defines the value of the
type
property of the event object for a
videoRequest
event.