Interface IAssetSearchFilter
A structure for defining the criteria of an IAsset search request.
Namespace: Unity.Cloud.Assets
Syntax
public interface IAssetSearchFilterProperties
AnyQueryMinimumMatch
Returns the number of matches required for a search to be considered a match.
Declaration
int AnyQueryMinimumMatch { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
Methods
AccumulateAnyCriteria()
Gets the optional search criteria of the filter.
Declaration
Dictionary<string, object> AccumulateAnyCriteria()Returns
| Type | Description |
|---|---|
| Dictionary<String, Object> | A dictionary containing the optional search criteria. |
AccumulateExcludedCriteria()
Gets the excluded search criteria of the filter.
Declaration
Dictionary<string, object> AccumulateExcludedCriteria()Returns
| Type | Description |
|---|---|
| Dictionary<String, Object> | A dictionary containing the excluded search criteria. |
AccumulateIncludedCriteria()
Gets the required search criteria of the filter.
Declaration
Dictionary<string, object> AccumulateIncludedCriteria()Returns
| Type | Description |
|---|---|
| Dictionary<String, Object> | A dictionary containing the required search criteria. |
Any(IAsset)
Includes all populated fields of the provided IAsset as optional criteria in the search.
Declaration
void Any(IAsset asset)Parameters
| Type | Name | Description |
|---|---|---|
| IAsset | asset | An IAsset |
Exclude(IAsset)
Excludes all populated fields of the provided IAsset in the search.
Declaration
void Exclude(IAsset asset)Parameters
| Type | Name | Description |
|---|---|---|
| IAsset | asset | An IAsset |
GetProjectToSearch()
Returns the default project for the search.
Declaration
IProject GetProjectToSearch()Returns
| Type | Description |
|---|---|
| IProject | A project to be used in the search. |
Include(IAsset)
Includes all populated fields of the provided IAsset in the search.
Declaration
void Include(IAsset asset)Parameters
| Type | Name | Description |
|---|---|---|
| IAsset | asset | An IAsset |
IsMatch(IAsset)
Returns whether the current filter matches the asset being queried.
Declaration
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. |