Class IIVQueryableExtensions

Inheritance

System.Object

IIVQueryableExtensions

Namespace: ImageVault.Client.Query

Assembly: ImageVault.Client.dll

Syntax

public static class IIVQueryableExtensions : Object

Methods

ApplyEffects(IIVQueryable<Image>, IEnumerable<Effect>)

Declaration

public static IIVQueryable<Image> ApplyEffects(this IIVQueryable<Image> source, IEnumerable<Effect> effects)

Parameters

Type	Name	Description
IIVQueryable<Image>	source
System.Collections.Generic.IEnumerable<Effect>	effects

Returns

Type	Description
IIVQueryable<Image>

Exceptions

Type	Condition
System.ArgumentNullException	If source is null.

ApplyEffects(IIVQueryable<Thumbnail>, IEnumerable<Effect>)

Applies a set of effects on the Thumbnail

Declaration

public static IIVQueryable<Thumbnail> ApplyEffects(this IIVQueryable<Thumbnail> source, IEnumerable<Effect> effects)

Parameters

Type	Name	Description
IIVQueryable<Thumbnail>	source
System.Collections.Generic.IEnumerable<Effect>	effects

Returns

Type	Description
IIVQueryable<Thumbnail>

Exceptions

Type	Condition
System.ArgumentNullException	If source is null.

ApplyEffects(IIVQueryable<Video>, IEnumerable<Effect>)

Declaration

public static IIVQueryable<Video> ApplyEffects(this IIVQueryable<Video> source, IEnumerable<Effect> effects)

Parameters

Type	Name	Description
IIVQueryable<Video>	source
System.Collections.Generic.IEnumerable<Effect>	effects

Returns

Type	Description
IIVQueryable<Video>

Exceptions

Type	Condition
System.ArgumentNullException	If source is null.

ApplyEffects(IIVQueryable<WebMedia>, IEnumerable<Effect>)

Declaration

public static IIVQueryable<WebMedia> ApplyEffects(this IIVQueryable<WebMedia> source, IEnumerable<Effect> effects)

Parameters

Type	Name	Description
IIVQueryable<WebMedia>	source
System.Collections.Generic.IEnumerable<Effect>	effects

Returns

Type	Description
IIVQueryable<WebMedia>

Exceptions

Type	Condition
System.ArgumentNullException	If source is null.

Crop(IIVQueryable<Image>, Int32, Int32, Int32, Int32)

Declaration

public static IIVQueryable<Image> Crop(this IIVQueryable<Image> source, int x, int y, int width, int height)

Parameters

Type	Name	Description
IIVQueryable<Image>	source
System.Int32	x
System.Int32	y
System.Int32	width
System.Int32	height

Returns

Type	Description
IIVQueryable<Image>

Exceptions

Type	Condition
System.ArgumentNullException	If source is null.

Crop(IIVQueryable<Thumbnail>, Int32, Int32, Int32, Int32)

Declaration

public static IIVQueryable<Thumbnail> Crop(this IIVQueryable<Thumbnail> source, int x, int y, int width, int height)

Parameters

Type	Name	Description
IIVQueryable<Thumbnail>	source
System.Int32	x
System.Int32	y
System.Int32	width
System.Int32	height

Returns

Type	Description
IIVQueryable<Thumbnail>

Exceptions

Type	Condition
System.ArgumentNullException	If source is null.

Crop(IIVQueryable<Video>, Int32, Int32, Int32, Int32)

Declaration

public static IIVQueryable<Video> Crop(this IIVQueryable<Video> source, int x, int y, int width, int height)

Parameters

Type	Name	Description
IIVQueryable<Video>	source
System.Int32	x
System.Int32	y
System.Int32	width
System.Int32	height

Returns

Type	Description
IIVQueryable<Video>

Exceptions

Type	Condition
System.ArgumentNullException	If source is null.

Crop(IIVQueryable<WebMedia>, Int32, Int32, Int32, Int32)

Declaration

public static IIVQueryable<WebMedia> Crop(this IIVQueryable<WebMedia> source, int x, int y, int width, int height)

Parameters

Type	Name	Description
IIVQueryable<WebMedia>	source
System.Int32	x
System.Int32	y
System.Int32	width
System.Int32	height

Returns

Type	Description
IIVQueryable<WebMedia>

Exceptions

Type	Condition
System.ArgumentNullException	If source is null.

DisableHtml<T>(IIVQueryable<T>, Boolean)

Disables HTML rendering on server. Requires usage of RenderMedia(Media) to produce Html for the media instead.

Declaration

public static IIVQueryable<T> DisableHtml<T>(this IIVQueryable<T> source, bool disableHtml = true)

Parameters

Type	Name	Description
IIVQueryable<T>	source
System.Boolean	disableHtml

Returns

Type	Description
IIVQueryable<T>

Type Parameters

Name	Description
T

Exceptions

Type	Condition
System.ArgumentNullException

IgnoreClientCache<T>(IIVQueryable<T>, Boolean)

Ignore the client cache for the query

Declaration

public static IIVQueryable<T> IgnoreClientCache<T>(this IIVQueryable<T> source, bool ignore = true)

Parameters

Type	Name	Description
IIVQueryable<T>	source
System.Boolean	ignore	True (default) if client cache should be ignored, false otherwise.

Returns

Type	Description
IIVQueryable<T>

Type Parameters

Name	Description
T

InAgreement<T>(IIVQueryable<T>, Int32[])

Filters media on agreement id

Declaration

public static IIVQueryable<T> InAgreement<T>(this IIVQueryable<T> source, params int[] agreementIds)

Parameters

Type	Name	Description
IIVQueryable<T>	source	The source.
System.Int32[]	agreementIds	The agreement ids.

Returns

Type	Description
IIVQueryable<T>

Type Parameters

Name	Description
T

Include<T, TKey>(IIVQueryable<T>, Expression<Func<T, TKey>>)

Declaration

public static IIVQueryable<T> Include<T, TKey>(this IIVQueryable<T> source, Expression<Func<T, TKey>> selector)

Parameters

Type	Name	Description
IIVQueryable<T>	source
System.Linq.Expressions.Expression<System.Func<T, TKey>>	selector

Returns

Type	Description
IIVQueryable<T>

Type Parameters

Name	Description
T
TKey

Exceptions

Type	Condition
System.ArgumentNullException	If source is null.

InCollection<T>(IIVQueryable<T>, Int32[])

Filters media on the supplied collectionId list

Declaration

public static IIVQueryable<T> InCollection<T>(this IIVQueryable<T> source, params int[] collectionIds)

Parameters

Type	Name	Description
IIVQueryable<T>	source	The source.
System.Int32[]	collectionIds	The collection ids.

Returns

Type	Description
IIVQueryable<T>

Type Parameters

Name	Description
T

InConsentUser<T>(IIVQueryable<T>, Int32[])

Filters only items that belongs to the supplied consent users

Declaration

public static IIVQueryable<T> InConsentUser<T>(this IIVQueryable<T> source, params int[] consentUserId)

Parameters

Type	Name	Description
IIVQueryable<T>	source
System.Int32[]	consentUserId

Returns

Type	Description
IIVQueryable<T>

Type Parameters

Name	Description
T

Exceptions

Type	Condition
System.ArgumentNullException

InConsentUserAgreement<T>(IIVQueryable<T>, IConsentUserAgreementKey[])

Filters media on consent user agreements

Declaration

public static IIVQueryable<T> InConsentUserAgreement<T>(this IIVQueryable<T> source, params IConsentUserAgreementKey[] consentUserAgreementKeys)

Parameters

Type	Name	Description
IIVQueryable<T>	source
IConsentUserAgreementKey[]	consentUserAgreementKeys

Returns

Type	Description
IIVQueryable<T>

Type Parameters

Name	Description
T

Exceptions

Type	Condition
System.ArgumentNullException

IsPublished<T>(IIVQueryable<T>, Boolean)

Filters media on its State property according to its MediaPublished flag value

Declaration

public static IIVQueryable<T> IsPublished<T>(this IIVQueryable<T> source, bool isPublished = true)

Parameters

Type	Name	Description
IIVQueryable<T>	source
System.Boolean	isPublished

Returns

Type	Description
IIVQueryable<T>

Type Parameters

Name	Description
T

OrderBy<T, TKey>(IIVQueryable<T>, Expression<Func<T, TKey>>)

Sorts the elements of a sequence in order according to the keySelector

Declaration

public static IIVQueryable<T> OrderBy<T, TKey>(this IIVQueryable<T> source, Expression<Func<T, TKey>> keySelector)

Parameters

Type	Name	Description
IIVQueryable<T>	source	A sequence of values to order.
System.Linq.Expressions.Expression<System.Func<T, TKey>>	keySelector

Returns

Type	Description
IIVQueryable<T>	An IIVQueryable<T> whose elements are sorted according to the sort order.

Type Parameters

Name	Description
T	The type of the elements of source.
TKey

Exceptions

Type	Condition
System.ArgumentNullException	If source is null.

OrderByDescending<T, TKey>(IIVQueryable<T>, Expression<Func<T, TKey>>)

Sorts the elements of a sequence in a descending order according to the keySelector

Declaration

public static IIVQueryable<T> OrderByDescending<T, TKey>(this IIVQueryable<T> source, Expression<Func<T, TKey>> keySelector)

Parameters

Type	Name	Description
IIVQueryable<T>	source	A sequence of values to order.
System.Linq.Expressions.Expression<System.Func<T, TKey>>	keySelector	The selector who's values should be used as sort values

Returns

Type	Description
IIVQueryable<T>	An IIVQueryable<T> whose elements are sorted according to the sort order.

Type Parameters

Name	Description
T	The type of the elements of source.
TKey	Type of values to sort by

Exceptions

Type	Condition
System.ArgumentNullException	If source is null or if keySelector is null.

Resize(IIVQueryable<Image>, Nullable<Int32>, Nullable<Int32>, ResizeMode)

Declaration

public static IIVQueryable<Image> Resize(this IIVQueryable<Image> source, Nullable<int> width, Nullable<int> height = null, ResizeMode resizeMode)

Parameters

Type	Name	Description
IIVQueryable<Image>	source
System.Nullable<System.Int32>	width
System.Nullable<System.Int32>	height
ResizeMode	resizeMode

Returns

Type	Description
IIVQueryable<Image>

Exceptions

Type	Condition
System.ArgumentNullException	If source is null.

Resize(IIVQueryable<Thumbnail>, Nullable<Int32>, Nullable<Int32>, ResizeMode)

Declaration

public static IIVQueryable<Thumbnail> Resize(this IIVQueryable<Thumbnail> source, Nullable<int> width, Nullable<int> height = null, ResizeMode resizeMode)

Parameters

Type	Name	Description
IIVQueryable<Thumbnail>	source
System.Nullable<System.Int32>	width
System.Nullable<System.Int32>	height
ResizeMode	resizeMode

Returns

Type	Description
IIVQueryable<Thumbnail>

Exceptions

Type	Condition
System.ArgumentNullException	If source is null.

Resize(IIVQueryable<Video>, Nullable<Int32>, Nullable<Int32>, ResizeMode)

Declaration

public static IIVQueryable<Video> Resize(this IIVQueryable<Video> source, Nullable<int> width, Nullable<int> height = null, ResizeMode resizeMode)

Parameters

Type	Name	Description
IIVQueryable<Video>	source
System.Nullable<System.Int32>	width
System.Nullable<System.Int32>	height
ResizeMode	resizeMode

Returns

Type	Description
IIVQueryable<Video>

Exceptions

Type	Condition
System.ArgumentNullException	If source is null.

Resize(IIVQueryable<WebMedia>, Nullable<Int32>, Nullable<Int32>, ResizeMode)

Declaration

public static IIVQueryable<WebMedia> Resize(this IIVQueryable<WebMedia> source, Nullable<int> width, Nullable<int> height = null, ResizeMode resizeMode)

Parameters

Type	Name	Description
IIVQueryable<WebMedia>	source
System.Nullable<System.Int32>	width
System.Nullable<System.Int32>	height
ResizeMode	resizeMode

Returns

Type	Description
IIVQueryable<WebMedia>

Exceptions

Type	Condition
System.ArgumentNullException	If source is null.

SearchFor<T>(IIVQueryable<T>, String)

Searches the query by a keyword

Declaration

public static IIVQueryable<T> SearchFor<T>(this IIVQueryable<T> source, string keyword)

Parameters

Type	Name	Description
IIVQueryable<T>	source
System.String	keyword

Returns

Type	Description
IIVQueryable<T>

Type Parameters

Name	Description
T

Exceptions

Type	Condition
System.ArgumentNullException	If source is null.

SetItems<T>(IIVQueryable<T>, IList<MediaItemReference>)

Filters on the supplied list of items

Declaration

public static IIVQueryable<T> SetItems<T>(this IIVQueryable<T> source, IList<MediaItemReference> items)

Parameters

Type	Name	Description
IIVQueryable<T>	source
System.Collections.Generic.IList<MediaItemReference>	items

Returns

Type	Description
IIVQueryable<T>

Type Parameters

Name	Description
T

Skip<T>(IIVQueryable<T>, Int32)

Bypasses a specified number of elements in a sequence and then returns the remaining elements.

Declaration

public static IIVQueryable<T> Skip<T>(this IIVQueryable<T> source, int count)

Parameters

Type	Name	Description
IIVQueryable<T>	source	The sequence to return elements from.
System.Int32	count	The number of elements to skip before returning the remaining elements.

Returns

Type	Description
IIVQueryable<T>	An IIVQueryable<T> that contains elements that occur after the specified index in the input sequence.

Type Parameters

Name	Description
T	The type of the elements of source.

Exceptions

Type	Condition
System.ArgumentNullException	If source is null.

Take<T>(IIVQueryable<T>, Int32)

Returns a specified number of contiguous elements from the start of a sequence.

Declaration

public static IIVQueryable<T> Take<T>(this IIVQueryable<T> source, int count)

Parameters

Type	Name	Description
IIVQueryable<T>	source	The sequence to return elements from.
System.Int32	count	The number of elements to return.

Returns

Type	Description
IIVQueryable<T>	An IIVQueryable<T> that contains the specified number of elements from the start of the input sequence.

Type Parameters

Name	Description
T	The type of the elements of source.

Exceptions

Type	Condition
System.ArgumentNullException	If source is null.

UsedOn<T>(IIVQueryable<T>, IUserPublishDetailsData)

Marks the media as used on the supplied IUserPublishDetailsData

Declaration

public static IIVQueryable<T> UsedOn<T>(this IIVQueryable<T> source, IUserPublishDetailsData data)

Parameters

Type	Name	Description
IIVQueryable<T>	source
IUserPublishDetailsData	data

Returns

Type	Description
IIVQueryable<T>

Type Parameters

Name	Description
T

UseFormat<T>(IIVQueryable<T>, MediaFormatBase)

Declaration

public static IIVQueryable<T> UseFormat<T>(this IIVQueryable<T> source, MediaFormatBase format)
    where T : Media

Parameters

Type	Name	Description
IIVQueryable<T>	source
MediaFormatBase	format

Returns

Type	Description
IIVQueryable<T>

Type Parameters

Name	Description
T

Exceptions

Type	Condition
System.ArgumentNullException	If source is null.

UseFormat<T>(IIVQueryable<T>, Int32)

Declaration

public static IIVQueryable<T> UseFormat<T>(this IIVQueryable<T> source, int formatId)
    where T : Media

Parameters

Type	Name	Description
IIVQueryable<T>	source
System.Int32	formatId

Returns

Type	Description
IIVQueryable<T>

Type Parameters

Name	Description
T

Where<T>(IIVQueryable<T>, Expression<Func<T, Boolean>>)

Declaration

public static IIVQueryable<T> Where<T>(this IIVQueryable<T> source, Expression<Func<T, bool>> predicate)

Parameters

Type	Name	Description
IIVQueryable<T>	source
System.Linq.Expressions.Expression<System.Func<T, System.Boolean>>	predicate

Returns

Type	Description
IIVQueryable<T>

Type Parameters

Name	Description
T

Exceptions

Type	Condition
System.ArgumentNullException	If source is null.

Where<T>(IIVQueryable<T>, Expression<Func<T, Int32, Boolean>>)

Declaration

public static IIVQueryable<T> Where<T>(this IIVQueryable<T> source, Expression<Func<T, int, bool>> predicate)

Parameters

Type	Name	Description
IIVQueryable<T>	source
System.Linq.Expressions.Expression<System.Func<T, System.Int32, System.Boolean>>	predicate

Returns

Type	Description
IIVQueryable<T>

Type Parameters

Name	Description
T

Exceptions

Type	Condition
System.ArgumentNullException	If source is null or if predicate is null.

Where<T>(IIVQueryable<T>, String)

Filter for a custom condition

Declaration

public static IIVQueryable<T> Where<T>(this IIVQueryable<T> source, string condition)

Parameters

Type	Name	Description
IIVQueryable<T>	source	The sequence to return elements from.
System.String	condition	The custom condition that should be fulfilled

Returns

Type	Description
IIVQueryable<T>

Type Parameters

Name	Description
T	The type of the elements of source.

WithConsentUserAgreement<T>(IIVQueryable<T>, Nullable<Boolean>)

Filters

Declaration

public static IIVQueryable<T> WithConsentUserAgreement<T>(this IIVQueryable<T> source, Nullable<bool> withConsentUserAgreement)

Parameters

Type	Name	Description
IIVQueryable<T>	source
System.Nullable<System.Boolean>	withConsentUserAgreement	True to include all items with consent user agreements. False to only include items without consent user agreement. Null to not filter by consent user agreements at all.

Returns

Type	Description
IIVQueryable<T>

Type Parameters

Name	Description
T