docs.unity3d.com
    Show / Hide Table of Contents

    Class SearchCriteria<T>

    Inheritance
    Object
    SearchCriteria<T>
    CollectionSearchCriteria<U, T>
    StringSearchCriteria
    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
    [Serializable]
    public class SearchCriteria<T> : ISearchCriteria<T>, ISearchCriteria
    Type Parameters
    Name Description
    T

    Methods

    Clear()

    Implement this method to clear the criteria fields.

    Declaration
    public void Clear()
    Implements
    ISearchCriteria.Clear()

    Exclude(T)

    Implement this method to explicitly exclude results presenting the value in a search.

    Declaration
    public void Exclude(T value)
    Parameters
    Type Name Description
    T value

    A value to exclude from a search.

    Implements
    ISearchCriteria<T>.Exclude(T)

    ForAny(T)

    Implement this method to include results presenting the value in a search.

    Declaration
    public void ForAny(T value)
    Parameters
    Type Name Description
    T value

    An optional value for a search.

    Implements
    ISearchCriteria<T>.ForAny(T)

    Include(T)

    Implement this method to explicitly include results presenting the value in a search.

    Declaration
    public void Include(T value)
    Parameters
    Type Name Description
    T value

    A required value for a search.

    Implements
    ISearchCriteria<T>.Include(T)

    IsValidType(Object)

    Declaration
    protected virtual bool IsValidType(object input)
    Parameters
    Type Name Description
    Object input
    Returns
    Type Description
    Boolean

    IsValueEmpty(T)

    Declaration
    protected virtual bool IsValueEmpty(T value)
    Parameters
    Type Name Description
    T value
    Returns
    Type Description
    Boolean

    SatisfiesAny(Object)

    Declaration
    protected virtual bool SatisfiesAny(object input)
    Parameters
    Type Name Description
    Object input
    Returns
    Type Description
    Boolean

    SatisfiesMatch(Object)

    Declaration
    protected virtual bool SatisfiesMatch(object input)
    Parameters
    Type Name Description
    Object input
    Returns
    Type Description
    Boolean

    TransformValue(T)

    Declaration
    protected virtual object TransformValue(T value)
    Parameters
    Type Name Description
    T value
    Returns
    Type Description
    Object

    TransformValue(Object)

    Declaration
    protected virtual T TransformValue(object value)
    Parameters
    Type Name Description
    Object value
    Returns
    Type Description
    T

    Explicit Interface Implementations

    ISearchCriteria.Exclude(Dictionary<String, Object>, String)

    Implement this method to add the included value to the collection of excludedValues.

    Declaration
    void ISearchCriteria.Exclude(Dictionary<string, object> excludedValues, string prefix)
    Parameters
    Type Name Description
    Dictionary<String, Object> excludedValues

    The collection in which to add a value to exclude from the search.

    String prefix

    A prefix for the SearchKey; may be empty.

    Implements
    ISearchCriteria.Exclude(Dictionary<String, Object>, String)

    ISearchCriteria.Exclude(Object)

    Implement this method to explicitly exclude results presenting the value in a search.

    Declaration
    void ISearchCriteria.Exclude(object value)
    Parameters
    Type Name Description
    Object value

    A value to exclude from a search.

    Implements
    ISearchCriteria.Exclude(Object)

    ISearchCriteria.ForAny(Dictionary<String, Object>, String)

    Implement this method to add the included value to the collection of forAnyValues.

    Declaration
    void ISearchCriteria.ForAny(Dictionary<string, object> forAnyValues, string prefix)
    Parameters
    Type Name Description
    Dictionary<String, Object> forAnyValues

    The collection in which to add an optional value for the search.

    String prefix

    A prefix for the SearchKey; may be empty.

    Implements
    ISearchCriteria.ForAny(Dictionary<String, Object>, String)

    ISearchCriteria.ForAny(Object)

    Implement this method to include results presenting the value in a search.

    Declaration
    void ISearchCriteria.ForAny(object value)
    Parameters
    Type Name Description
    Object value

    An optional value for a search.

    Implements
    ISearchCriteria.ForAny(Object)

    ISearchCriteria.Include(Dictionary<String, Object>, String)

    Implement this method to add the included value to the collection of includedValues.

    Declaration
    void ISearchCriteria.Include(Dictionary<string, object> includedValues, string prefix)
    Parameters
    Type Name Description
    Dictionary<String, Object> includedValues

    The collection in which to add a value to include in the search.

    String prefix

    A prefix for the SearchKey; may be empty.

    Implements
    ISearchCriteria.Include(Dictionary<String, Object>, String)

    ISearchCriteria.Include(Object)

    Implement this method to explicitly include results presenting the value in a search.

    Declaration
    void ISearchCriteria.Include(object value)
    Parameters
    Type Name Description
    Object value

    A required value for a search.

    Implements
    ISearchCriteria.Include(Object)

    ISearchCriteria.IsAny(Object)

    Implement this method to verify whether the input satisfies the optional search critiera.

    Declaration
    bool ISearchCriteria.IsAny(object input)
    Parameters
    Type Name Description
    Object input

    The element to compare to the criteria.

    Returns
    Type Description
    Boolean

    True if the input satisfies the criteria, false otherwise.

    Implements
    ISearchCriteria.IsAny(Object)

    ISearchCriteria.IsEmpty()

    Implement this method to return whether the criteria has been populated.

    Declaration
    bool ISearchCriteria.IsEmpty()
    Returns
    Type Description
    Boolean

    True if there are no requirements to meet, false otherwise.

    Implements
    ISearchCriteria.IsEmpty()

    ISearchCriteria.IsMatch(Object)

    Implement this method to verify whether an input satisfies the search criteria.

    Declaration
    bool ISearchCriteria.IsMatch(object input)
    Parameters
    Type Name Description
    Object input

    The element to compare to the criteria.

    Returns
    Type Description
    Boolean

    True if the input satisfies the criteria, false otherwise.

    Implements
    ISearchCriteria.IsMatch(Object)

    ISearchCriteria.SearchFieldType

    Implement this property to return the type of the search element.

    Declaration
    Type ISearchCriteria.SearchFieldType { get; }
    Returns
    Type Description
    Type
    Implements
    ISearchCriteria.SearchFieldType

    ISearchCriteria.SearchKey

    Implement this property to return the key of the search element.

    Declaration
    string ISearchCriteria.SearchKey { get; }
    Returns
    Type Description
    String
    Implements
    ISearchCriteria.SearchKey

    ISearchCriteria.TryGetAny(out Object)

    Implement this method to return the included search element.

    Declaration
    bool ISearchCriteria.TryGetAny(out object anyValue)
    Parameters
    Type Name Description
    Object anyValue

    The optional search value.

    Returns
    Type Description
    Boolean

    True if the criteria should be included in the search, false otherwise.

    Implements
    ISearchCriteria.TryGetAny(out Object)

    ISearchCriteria.TryGetExcluded(out Object)

    Implement this method to return the included search element.

    Declaration
    bool ISearchCriteria.TryGetExcluded(out object excludedValue)
    Parameters
    Type Name Description
    Object excludedValue

    The excluded search value.

    Returns
    Type Description
    Boolean

    True if the criteria should be included in the search, false otherwise.

    Implements
    ISearchCriteria.TryGetExcluded(out Object)

    ISearchCriteria.TryGetIncluded(out Object)

    Implement this method to return the included search element.

    Declaration
    bool ISearchCriteria.TryGetIncluded(out object includedValue)
    Parameters
    Type Name Description
    Object includedValue

    The included search value.

    Returns
    Type Description
    Boolean

    True if the criteria should be included in the search, false otherwise.

    Implements
    ISearchCriteria.TryGetIncluded(out Object)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023