Class awMedia

Description
Description | Descendents | Vars (details) | Methods (details)

Represents some kind of media.

Located in /classes/cm/Media.php 

awComplexObject
   |
   --awMedia
Direct descendents
Description | Descendents | Vars (details) | Methods (details)
Class Description
class awVideo Encapsulates a Video media identified by a MediaId
class awImage
class awAudio Encapsulates an Audio media identified by a MediaId.
Variable Summary
Description | Descendents | Vars (details) | Methods (details)
string $creationTime
awMedia_Size_DimensionsMapEntry[] $dimensions
long $fileSize
long $mediaId
string $mimeType
string $name
long $referenceId
string $sourceUrl
string $type
awMedia_Size_StringMapEntry[] $urls
mixed $_checkFields
Method Summary
Description | Descendents | Vars (details) | Methods (details)
void factory ( $row,  $className)
Variables
Description | Descendents | Vars (details) | Methods (details)
string $creationTime

Media creation date in the format YYYY-MM-DD HH:MM:SS+TZ.

This is not updatable and not specifiable. <span class="constraint Selectable">This field can be selected using the value "CreationTime".</span><span class="constraint Filterable">This field can be filtered on.</span> <span class="constraint ReadOnly">This field is read only and should not be set for following Operators : SET, REMOVE. If this field is sent to the API, it will be ignored.</span>

awMedia_Size_DimensionsMapEntry[] $dimensions

Various dimension sizes for the media. Only applies to image media (and video media for video thumbnails).

<span class="constraint Selectable">This field can be selected using the value "Dimensions".</span>

long $fileSize

The size of the media file in bytes

<span class="constraint Selectable">This field can be selected using the value "FileSize".</span><span class="constraint Filterable">This field can be filtered on.</span> <span class="constraint ReadOnly">This field is read only and should not be set for following Operators : SET, REMOVE. If this field is sent to the API, it will be ignored.</span>

long $mediaId

ID of this media object.

<span class="constraint Selectable">This field can be selected using the value "MediaId".</span><span class="constraint Filterable">This field can be filtered on.</span> <span class="constraint Required">This field is required and should not be {@code null} when it is contained within Operators : SET, REMOVE.</span>

string $mimeType

The mime type of the media

<span class="constraint Selectable">This field can be selected using the value "MimeType".</span><span class="constraint Filterable">This field can be filtered on.</span> <span class="constraint ReadOnly">This field is read only and should not be set for following Operators : SET, REMOVE. If this field is sent to the API, it will be ignored.</span>

  • var: awMedia.MimeType
string $name

The name of the media. The name can be used by clients to help identify previously uploaded media.

<span class="constraint Selectable">This field can be selected using the value "Name".</span><span class="constraint Filterable">This field can be filtered on.</span>

long $referenceId

Media reference id key

<span class="constraint Selectable">This field can be selected using the value "ReferenceId".</span><span class="constraint Filterable">This field can be filtered on.</span> <span class="constraint ReadOnly">This field is read only and should not be set for following Operators : SET, REMOVE. If this field is sent to the API, it will be ignored.</span>

string $sourceUrl

The url where the orginal media was downloaded from (or a file name).

<span class="constraint Selectable">This field can be selected using the value "SourceUrl".</span><span class="constraint Filterable">This field can be filtered on.</span> <span class="constraint ReadOnly">This field is read only and should not be set for following Operators : SET, REMOVE. If this field is sent to the API, it will be ignored.</span>

string $type

Type of this media object. Required when using upload to upload a new media file.

<span class="constraint Selectable">This field can be selected using the value "Type".</span><span class="constraint Filterable">This field can be filtered on.</span> <span class="constraint ReadOnly">This field is read only and should not be set for following Operators : SET, REMOVE. If this field is sent to the API, it will be ignored.</span>

  • var: awMedia.MediaType
awMedia_Size_StringMapEntry[] $urls

Urls pointing to the resized media for the given sizes. Only applies to image media.

<span class="constraint Selectable">This field can be selected using the value "Urls".</span> <span class="constraint ReadOnly">This field is read only and should not be set. If this field is sent to the API, it will be ignored.</span>

mixed $_checkFields = array(
'dimensions' => array(
'objName' => 'awMedia_Size_DimensionsMapEntry',
'type' => 'array'
),'urls'=>array('objName'=>'awMedia_Size_StringMapEntry','type'=>'array'),)
  • access: public
Redefinition of:
awComplexObject::$_checkFields

Inherited Variables

Inherited from awComplexObject

awComplexObject::$_cachedCheckFields
 awComplexObject::$_row
Methods
Description | Descendents | Vars (details) Methods (details)
  • access: public
void factory ( $row,  $className)
  • $row
  • $className
Redefinition of:
awComplexObject::factory()

Inherited Methods

Inherited From awComplexObject

awComplexObject::__construct()
awComplexObject::factory()
awComplexObject::get()
awComplexObject::getAsObj()
awComplexObject::getCheckFields()
awComplexObject::getRow()
awComplexObject::getSoapVars()
awComplexObject::getXml()
awComplexObject::isEmpty()
awComplexObject::remove()
awComplexObject::set()
awComplexObject::setRow()

Documentation generated on Fri, 23 Mar 2012 13:44:04 +0200 by phpDocumentor 1.4.3