Class AssetSearchFilter

A structure for defining the criteria of an IAsset search request.

Inheritance

Object

AssetSearchFilter

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: Unity.Cloud.Assets

Syntax

public class AssetSearchFilter : IAssetSearchFilter

Constructors

AssetSearchFilter(IProject)

Declaration

public AssetSearchFilter(IProject project)

Parameters

Type	Name	Description
IProject	project

Properties

AllCriteria

Declaration

public IEnumerable<ISearchCriteria> AllCriteria { get; }

Property Value

Type	Description
IEnumerable<ISearchCriteria>

AnyQueryMinimumMatch

Declaration

public int AnyQueryMinimumMatch { get; set; }

Property Value

Type	Description
Int32

Implements

IAssetSearchFilter.AnyQueryMinimumMatch

Attachments

The attachments of the asset.

Declaration

public AttachmentSearchFilter Attachments { get; }

Property Value

Type	Description
AttachmentSearchFilter

Author

The author of the asset.

Declaration

public AuthorSearchFilter Author { get; }

Property Value

Type	Description
AuthorSearchFilter

Categories

The categories of the asset.

Declaration

public HashsetSearchCriteria<string> Categories { get; }

Property Value

Type	Description
HashsetSearchCriteria<String>

Collections

The collections of the asset.

Declaration

public HashsetSearchCriteria<CollectionPath> Collections { get; }

Property Value

Type	Description
HashsetSearchCriteria<CollectionPath>

Created

The created date of the asset.

Declaration

public NullableSearchCriteria<DateTime> Created { get; }

Property Value

Type	Description
NullableSearchCriteria<DateTime>

CreatedBy

The created by of the asset.

Declaration

public SearchCriteria<string> CreatedBy { get; }

Property Value

Type	Description
SearchCriteria<String>

Description

The description of the asset.

Declaration

public StringSearchCriteria Description { get; }

Property Value

Type	Description
StringSearchCriteria

ExternalId

The external ID of the asset.

Declaration

public SearchCriteria<string> ExternalId { get; }

Property Value

Type	Description
SearchCriteria<String>

Files

The files of the asset.

Declaration

public FileSearchFilter Files { get; }

Property Value

Type	Description
FileSearchFilter

Id

The id of the asset.

Declaration

public SearchCriteria<string> Id { get; }

Property Value

Type	Description
SearchCriteria<String>

Location

The location of the asset.

Declaration

public LocationSearchFilter Location { get; }

Property Value

Type	Description
LocationSearchFilter

Name

The name of the asset.

Declaration

public StringSearchCriteria Name { get; }

Property Value

Type	Description
StringSearchCriteria

Origin

The origin of the asset.

Declaration

public SearchCriteria<string> Origin { get; }

Property Value

Type	Description
SearchCriteria<String>

PreviewFileId

The preview file ID of the asset.

Declaration

public SearchCriteria<string> PreviewFileId { get; }

Property Value

Type	Description
SearchCriteria<String>

Project

The project of the asset.

Declaration

public ProjectSearchFilter Project { get; }

Property Value

Type	Description
ProjectSearchFilter

ProjectIds

The project id's to which the asset is linked.

Declaration

public HashsetSearchCriteria<string> ProjectIds { get; }

Property Value

Type	Description
HashsetSearchCriteria<String>

ShortId

The short ID of the asset.

Declaration

public SearchCriteria<string> ShortId { get; }

Property Value

Type	Description
SearchCriteria<String>

SourceProjectId

The source project id of the asset.

Declaration

public SearchCriteria<string> SourceProjectId { get; }

Property Value

Type	Description
SearchCriteria<String>

Status

The status of the asset.

Declaration

public SearchCriteria<string> Status { get; }

Property Value

Type	Description
SearchCriteria<String>

StatusDetails

The status details of the asset.

Declaration

public SearchCriteria<string> StatusDetails { get; }

Property Value

Type	Description
SearchCriteria<String>

StorageId

The storage id of the asset.

Declaration

public SearchCriteria<string> StorageId { get; }

Property Value

Type	Description
SearchCriteria<String>

Tags

The tags of the asset.

Declaration

public HashsetSearchCriteria<string> Tags { get; }

Property Value

Type	Description
HashsetSearchCriteria<String>

Taxonomy

The taxonomy of the asset.

Declaration

public TaxonomySearchFilter Taxonomy { get; }

Property Value

Type	Description
TaxonomySearchFilter

Type

The type of the asset.

Declaration

public SearchCriteria<string> Type { get; }

Property Value

Type	Description
SearchCriteria<String>

Updated

The updated date of the asset.

Declaration

public NullableSearchCriteria<DateTime> Updated { get; }

Property Value

Type	Description
NullableSearchCriteria<DateTime>

UpdatedBy

The updated by of the asset.

Declaration

public SearchCriteria<string> UpdatedBy { get; }

Property Value

Type	Description
SearchCriteria<String>

Version

The version of the asset.

Declaration

public NullableSearchCriteria<int> Version { get; }

Property Value

Type	Description
NullableSearchCriteria<Int32>

VersionName

The version name of the asset.

Declaration

public SearchCriteria<string> VersionName { get; }

Property Value

Type	Description
SearchCriteria<String>

Methods

AccumulateAnyCriteria()

Gets the optional search criteria of the filter.

Declaration

public Dictionary<string, object> AccumulateAnyCriteria()

Returns

Type	Description
Dictionary<String, Object>	A dictionary containing the optional search criteria.

Implements

IAssetSearchFilter.AccumulateAnyCriteria()

AccumulateExcludedCriteria()

Gets the excluded search criteria of the filter.

Declaration

public Dictionary<string, object> AccumulateExcludedCriteria()

Returns

Type	Description
Dictionary<String, Object>	A dictionary containing the excluded search criteria.

Implements

IAssetSearchFilter.AccumulateExcludedCriteria()

AccumulateIncludedCriteria()

Gets the required search criteria of the filter.

Declaration

public Dictionary<string, object> AccumulateIncludedCriteria()

Returns

Type	Description
Dictionary<String, Object>	A dictionary containing the required search criteria.

Implements

IAssetSearchFilter.AccumulateIncludedCriteria()

AddUserCriteria(ISearchCriteria)

Adds a ISearchCriteria to the search.

Declaration

public bool AddUserCriteria(ISearchCriteria criteria)

Parameters

Type	Name	Description
ISearchCriteria	criteria

Returns

Type	Description
Boolean

Exceptions

Type	Condition
ArgumentNullException

Any(IAsset)

Includes any populated fields of the provided IAsset in the search.

Declaration

public void Any(IAsset asset)

Parameters

Type	Name	Description
IAsset	asset	An IAsset

Implements

IAssetSearchFilter.Any(IAsset)

Exclude(IAsset)

Excludes all populated fields of the provided IAsset in the search.

Declaration

public void Exclude(IAsset asset)

Parameters

Type	Name	Description
IAsset	asset	An IAsset

Implements

IAssetSearchFilter.Exclude(IAsset)

GetProjectToSearch()

Returns the default project for the search.

Declaration

public IProject GetProjectToSearch()

Returns

Type	Description
IProject	A project to be used in the search.

Implements

IAssetSearchFilter.GetProjectToSearch()

Include(IAsset)

Includes all populated fields of the provided IAsset in the search.

Declaration

public void Include(IAsset asset)

Parameters

Type	Name	Description
IAsset	asset	An IAsset

Implements

IAssetSearchFilter.Include(IAsset)

IsMatch(IAsset)

Returns whether the current filter matches the asset being queried.

Declaration

public bool IsMatch(IAsset asset)

Parameters

Type	Name	Description
IAsset	asset	The IAsset to query for match.

Returns

Type	Description
Boolean	True if the asset matches this search filter.

Implements

IAssetSearchFilter.IsMatch(IAsset)

RemoveUserCriteria(ISearchCriteria)

Removes a ISearchCriteria from the search.

Declaration

public bool RemoveUserCriteria(ISearchCriteria criteria)

Parameters

Type	Name	Description
ISearchCriteria	criteria

Returns

Type	Description
Boolean

Exceptions

Type	Condition
ArgumentNullException