Class DbPublishedMediaContentReference

Defines a published media item

Inheritance

System.Object

DbPublishedMediaContentReference

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.Core.Common.DbEntities

Assembly: ImageVault.Core.dll

Syntax

public class DbPublishedMediaContentReference

Constructors

DbPublishedMediaContentReference()

Initializes a new instance of the DbMediaContentReference class.

Declaration

public DbPublishedMediaContentReference()

DbPublishedMediaContentReference(DbMediaContentReference, Int32, String)

Initializes a new instance of the DbPublishedMediaContentReference class.

Declaration

public DbPublishedMediaContentReference(DbMediaContentReference mediaContentReference, int publishingSourceId, string publishDetails)

Parameters

Type	Name	Description
DbMediaContentReference	mediaContentReference	The media content reference to publish
System.Int32	publishingSourceId	The id of the publishing source to use
System.String	publishDetails	Details about the publish

Exceptions

Type	Condition
System.ArgumentNullException	If mediaContentReference is null.

Properties

Media

Get/Sets the Media of the DbPublishedMediaContentReference

Declaration

public Media Media { get; set; }

Property Value

Type	Description
Media

MediaContentReference

Get/Sets the DbMediaContentReference of the DbPublishedMediaContentReference

Declaration

public DbMediaContentReference MediaContentReference { get; set; }

Property Value

Type	Description
DbMediaContentReference

MediaContentReferenceId

Get/Sets the MediaContentReferenceId of the DbPublishedMediaContentReference

Declaration

public string MediaContentReferenceId { get; set; }

Property Value

Type	Description
System.String

MediaInformation

Get/Sets the MediaInformation of the DbPublishedMediaContentReference

Declaration

public string MediaInformation { get; set; }

Property Value

Type	Description
System.String

PublishDetails

Contains the PublishDetails for the published media content reference

Declaration

public IList<DbPublishDetails> PublishDetails { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<DbPublishDetails>

PublishedMediaContentReferenceId

Get/Sets the PublishedMediaContentReferenceId of the DbPublishedMediaContentReference

Declaration

public string PublishedMediaContentReferenceId { get; set; }

Property Value

Type	Description
System.String

PublishingSource

Get/Sets the PublishingSource of the DbPublishedMediaContentReference

Declaration

public DbPublishingSource PublishingSource { get; set; }

Property Value

Type	Description
DbPublishingSource

PublishingSourceId

Get/Sets the PublishingSourceId of the DbPublishedMediaContentReference

Declaration

public int PublishingSourceId { get; set; }

Property Value

Type	Description
System.Int32

PublishingSourceIdentifier

Get/Sets the DbPublishingSource of the DbPublishedMediaContentReference

Declaration

public string PublishingSourceIdentifier { get; set; }

Property Value

Type	Description
System.String

RedirectTo

If not null, this will reference to the PublishedMediaContentReferenceId that it should redirect to.

Declaration

public string RedirectTo { get; set; }

Property Value

Type	Description
System.String

Remarks

If set, this publishing source has been used to publish a previous version of the media item.

Methods

ToPublishedMediaContentReference()

Creates a PublishedMediaContentReference representing this instance.

Declaration

public PublishedMediaContentReference ToPublishedMediaContentReference()

Returns

Type	Description
PublishedMediaContentReference	The PublishedMediaContentReference representing this instance.

ToPublishInformation(Boolean)

Converts the db object to an api object

Declaration

public PublishInformation ToPublishInformation(bool includeDetailsAndMedia = false)

Parameters

Type	Name	Description
System.Boolean	includeDetailsAndMedia	Set to true if media information and details should be populated

Returns

Type	Description
PublishInformation