Packagecom.adobe.mediacore.metadata
Classpublic class Metadata
InheritanceMetadata Inheritance flash.events.EventDispatcher
Subclasses AdMetadata, AdvertisingMetadata, TrackingMetadata

Metadata class encapsulates a related collection of metadata.

Metadata consists of key-value pairs, where keys are Strings and values are arbitrary Objects.



Public Properties
 PropertyDefined By
  keys : Vector.<String>
[read-only] The keys stored in this Metadata object.
Metadata
Public Methods
 MethodDefined By
  
Default constructor.
Metadata
  
addValue(key:String, value:Object):void
Stores the specified value in this Metadata object, using the specified key.
Metadata
  
containsKey(key:String):Boolean
Checks if the specified key existins in this metdata objects.
Metadata
  
getValue(key:String):*
Returns the value associate with the specified key.
Metadata
  
removeValue(key:String):*
Removes the value associated with the specified key from this Metadata object.
Metadata
  
toString():String
[override] Returns a string representation of this configuration.
Metadata
Events
 Event Summary Defined By
  Dispatched when a value is added on the metadataMetadata
  Dispatched when a value is changed on the metadataMetadata
  Dispatched when a value is removed from the metadataMetadata
Property Detail
keysproperty
keys:Vector.<String>  [read-only]

The keys stored in this Metadata object.


Implementation
    public function get keys():Vector.<String>
Constructor Detail
Metadata()Constructor
public function Metadata()

Default constructor.

Method Detail
addValue()method
public function addValue(key:String, value:Object):void

Stores the specified value in this Metadata object, using the specified key. The key can subsequently be used to retrieve the value. If the key is equal to the key of another object already in the Metadata object this will overwrite the association with the new value.

Parameters

key:String — The key to associate the value with.
 
value:Object — The value to add to the Metadata object.


Throws
ArgumentError — If key is null.
containsKey()method 
public function containsKey(key:String):Boolean

Checks if the specified key existins in this metdata objects. Returns true if the key is present and false otherwise.

Parameters

key:String

Returns
Boolean

Throws
ArgumentError — if the key is null.
getValue()method 
public function getValue(key:String):*

Returns the value associate with the specified key. Returns 'null' if the Metadata object fails to resolve the key.

Parameters

key:String

Returns
*

Throws
ArgumentError — If key is null.
removeValue()method 
public function removeValue(key:String):*

Removes the value associated with the specified key from this Metadata object. Returns undefined if there is no value associated with the key in this Metadata object.

Parameters

key:String — The key associated with the value to be removed.

Returns
*

Throws
ArgumentError — If key is null.
toString()method 
override public function toString():String

Returns a string representation of this configuration.

Returns
String
Event Detail
valueAdd Event
Event Object Type: com.adobe.mediacore.events.MetadataEvent

Dispatched when a value is added on the metadata

valueChange Event  
Event Object Type: com.adobe.mediacore.events.MetadataEvent

Dispatched when a value is changed on the metadata

valueRemove Event  
Event Object Type: com.adobe.mediacore.events.MetadataEvent

Dispatched when a value is removed from the metadata