Class MediaItemFilter

Defines the filterdata that will be used to perform a query for mediaitems

Inheritance
System.Object
IVFilter
MediaItemFilter
MediaItemFilter
Implements
System.ICloneable
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.Query
Assembly: ImageVault.Common.dll
Syntax
public class MediaItemFilter : IVFilter, IIVFilter, ICloneable

Constructors

MediaItemFilter()

Initializes a new instance of the MediaItemFilter class.

Declaration
public MediaItemFilter()

MediaItemFilter(MediaItemFilter)

Initializes a new instance of the MediaItemFilter class.

Declaration
public MediaItemFilter(MediaItemFilter i)
Parameters
Type Name Description
MediaItemFilter i

Properties

AgreementId

The id of the agreements to search in

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

The agreement identifier.

CategoryId

The id of the category to search in (or null/0 if categories shouldn't be included in the filter)

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

CollectionId

The id of the collections to search in

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

The collection identifier.

Id

Get/Sets the Id of the mediaitem(s) to match.

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

Finds a media item by this id(s). If this is set, other search parameters are ignored

MediaItemState

Get/Sets the MediaItemState of the MediaItemFilter

Declaration
public MediaItemStates MediaItemState { get; set; }
Property Value
Type Description
MediaItemStates

SearchString

The freetext search string

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

SortOrder

The order to sort the result

Declaration
public MediaItemSortOrders SortOrder { get; set; }
Property Value
Type Description
MediaItemSortOrders

Url

Get/Sets the Url of the MediaItemFilter

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

If no id is entered, the urls is parsed and the media id and format is identified and used in the query. The id as a filter and format as a population

VaultId

The id of the vaults to search in (or null/0 if all of the users vaults should be included

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

VersionFilter

Describes the version to filter on. Default is Current

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

VersionId

Instead of requesting the latest version, a set of version id can be specified.

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

Will override any value set by the VersionFilter property

Methods

Clone()

Creates a new object that is a copy of the current instance.

Declaration
public override object Clone()
Returns
Type Description
System.Object

A new object that is a copy of this instance.
Overrides

Implements

System.ICloneable

Extension Methods