Packagecom.brightcove.api.events
Classpublic class ShortenedLinkEvent
InheritanceShortenedLinkEvent Inheritance flash.events.Event

Event specifically for shortened link retrieval in the player. Direct links to the player can be of a length too long or unwieldy for posting on social sites due to the IDs that are appended. Shortened links are retrieved by the player from the server when a direct link is requested by the user. Since this is an asynchronous call, this event is provided to allow a developer to know when a shortened link has been retrieved. This can be used in conjunction with the SocialModule's getLink() and isURLShortenedForMedia() in order to determine if a shortened link to particular media has already been retrieved, allowing the setting up of a listener for this event if the link must first be requested.



Public Properties
 PropertyDefined By
  media : MediaDTO
The media for which the link has been generated.
ShortenedLinkEvent
  url : String
The shortened link URL to the player and media.
ShortenedLinkEvent
Public Methods
 MethodDefined By
  
ShortenedLinkEvent(type:String, url:String, media:MediaDTO)
Constructor.
ShortenedLinkEvent
  
clone():Event
[override] Returns a copy of the event instance.
ShortenedLinkEvent
Public Constants
 ConstantDefined By
  LINK_GENERATED : String = linkGenerated
[static] The ShortenedLinkEvent.LINK_GENERATED constant defines the value of the type property of the event object for a linkGenerated event.
ShortenedLinkEvent
Property Detail
mediaproperty
public var media:MediaDTO

The media for which the link has been generated.

urlproperty 
public var url:String

The shortened link URL to the player and media.

Constructor Detail
ShortenedLinkEvent()Constructor
public function ShortenedLinkEvent(type:String, url:String, media:MediaDTO)

Constructor.

Parameters
type:String — name if the event.
 
url:String — embed code snippet connected with the event.
 
media:MediaDTO
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
LINK_GENERATEDConstant
public static const LINK_GENERATED:String = linkGenerated

The ShortenedLinkEvent.LINK_GENERATED constant defines the value of the type property of the event object for a linkGenerated event.