Class MediaItem

Summary description for MediaItem.

Inheritance
System.Object
MediaItem
Implements
IItem<System.Int32>
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: ImageVault.Common.Data
Assembly: ImageVault.Common.dll
Syntax
public class MediaItem : IItem<int>

Constructors

MediaItem()

Initializes a new instance of the MediaItem class.

Declaration
public MediaItem()

MediaItem(MediaItem)

Initializes a new instance of the MediaItem class.

Declaration
public MediaItem(MediaItem mediaItem)
Parameters
Type Name Description
MediaItem mediaItem

Properties

Access

Get/Sets the Access of the MediaItem

Declaration
public VaultRoles Access { get; set; }
Property Value
Type Description
VaultRoles
Remarks

Not populated by default populated

AddedBy

Get/Sets the AddedBy of the MediaItem

Declaration
public string AddedBy { get; set; }
Property Value
Type Description
System.String

The name of the user that added the image

Agreements

Agreements

Declaration
public List<AgreementListData> Agreements { get; set; }
Property Value
Type Description
System.Collections.Generic.List<AgreementListData>

CanBeDownloaded

Get/Sets the CanBeDownloaded of the MediaItem

Declaration
public bool? CanBeDownloaded { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

If the media item is downloadable

Categories

Get/Sets the Categories of the MediaItem

Declaration
public List<Category> Categories { get; set; }
Property Value
Type Description
System.Collections.Generic.List<Category>

The System.Collections.Generic.List<T> of the item (if it is populated)

CurrentVersionId

Defines the id of the version that is the current selected version for the media item

Declaration
public int CurrentVersionId { get; set; }
Property Value
Type Description
System.Int32

DateAdded

Get/Sets the DateAdded of the MediaItem

Declaration
public DateTime DateAdded { get; set; }
Property Value
Type Description
System.DateTime

DeletedDate

Date when the item was marked for delete

Declaration
public DateTime? DeletedDate { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>

DuplicateMediaItemId

Contains a list of duplicate media item ids

Declaration
[Obsolete("Use DuplicateVersionId instead")]
public IList<int> DuplicateMediaItemId { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<System.Int32>

DuplicateVersionId

Contains a list of duplicate version ids

Declaration
public IList<int> DuplicateVersionId { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<System.Int32>

Id

Get/Sets the Id of the MediaItem

Declaration
public int Id { get; set; }
Property Value
Type Description
System.Int32

The id of the mediaitem

MediaConversions

Get/Sets the MediaFormats of the MediaItem

Declaration
public List<Media> MediaConversions { get; set; }
Property Value
Type Description
System.Collections.Generic.List<Media>

The System.Collections.Generic.List<T> that was populated
Remarks

Not necessarily in the requested order.

MediaVersion

Defines the MediaVersion information

Declaration
public MediaVersion MediaVersion { get; set; }
Property Value
Type Description
MediaVersion

Metadata

Get/Sets the Metadata of the MediaItem

Declaration
public List<Metadata> Metadata { get; set; }
Property Value
Type Description
System.Collections.Generic.List<Metadata>

The populated metadata

Name

Get/Sets the Name of the MediaItem

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String

The name of the media item

PublishInformation

Get/Sets the PublishInformation of the MediaItem

Declaration
public List<PublishInformation> PublishInformation { get; set; }
Property Value
Type Description
System.Collections.Generic.List<PublishInformation>

The System.Collections.Generic.List<T> if it is populated

Shared

Get/Sets the Shared of the MediaItem

Declaration
[Obsolete("Use (State&AssetStates.MediaShared)==AssetStates.MediaShared instead")]
public bool? Shared { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

If populated, contains the information if the file is shared or not

State

State for the asset

Declaration
public AssetStates State { get; set; }
Property Value
Type Description
AssetStates

VaultId

Get/Sets the VaultId of the MediaItem

Declaration
public int VaultId { get; set; }
Property Value
Type Description
System.Int32

The Id of the vault where the item resides

VersionId

Defines the id of the version of this media item.

Declaration
public int VersionId { get; set; }
Property Value
Type Description
System.Int32

Methods

CopyTo(MediaItem)

Copies the information from one mediaitem to another...

Declaration
public void CopyTo(MediaItem mi)
Parameters
Type Name Description
MediaItem mi

SetMetadata<T>(MetadataDefinition, T)

Declaration
public void SetMetadata<T>(MetadataDefinition definition, T value)
Parameters
Type Name Description
MetadataDefinition definition
T value
Type Parameters
Name Description
T

SetMetadata<T>(String, MetadataDefinitionTypes, T)

Set metadata by supplying name, definition type and value

Declaration
public void SetMetadata<T>(string name, MetadataDefinitionTypes definitionType, T value)
Parameters
Type Name Description
System.String name
MetadataDefinitionTypes definitionType
T value
Type Parameters
Name Description
T

TryGetMetadata<T>(String, MetadataDefinitionTypes, out T)

Declaration
public bool TryGetMetadata<T>(string name, MetadataDefinitionTypes definitionType, out T value)
Parameters
Type Name Description
System.String name
MetadataDefinitionTypes definitionType
T value
Returns
Type Description
System.Boolean
Type Parameters
Name Description
T

Implements

Extension Methods