Language

SearchSpec.Builder.AddFilterProperties Method

Definition

Adds property paths for the specified type to the property filter of SearchSpec Entry.

[Android.Runtime.Register("addFilterProperties", "(Ljava/lang/String;Ljava/util/Collection;)Landroid/app/appsearch/SearchSpec$Builder;", "", ApiSince=35)]
public Android.App.AppSearch.SearchSpec.Builder AddFilterProperties(string schema, System.Collections.Generic.ICollection<string> propertyPaths);
[<Android.Runtime.Register("addFilterProperties", "(Ljava/lang/String;Ljava/util/Collection;)Landroid/app/appsearch/SearchSpec$Builder;", "", ApiSince=35)>]
member this.AddFilterProperties : string * System.Collections.Generic.ICollection<string> -> Android.App.AppSearch.SearchSpec.Builder

Parameters

schema
String

the AppSearchSchema that contains the target properties. This value cannot be null.

propertyPaths
ICollection<String>

The String version of PropertyPath. A dot-delimited sequence of property names. This value cannot be null.

Returns

Attributes

Remarks

Adds property paths for the specified type to the property filter of SearchSpec Entry. Only returns documents that have matches under the specified properties. If property paths are added for a type, then only the properties referred to will be searched for results of that type. If a property path that is specified isn't present in a result, it will be ignored for that result. Property paths cannot be null. If no property paths are added for a particular type, then all properties of results of that type will be searched. Example properties: 'body', 'sender.name', 'sender.emailaddress', etc. If property paths are added for the SearchSpec.SCHEMA_TYPE_WILDCARD, then those property paths will apply to all results, excepting any types that have their own, specific property paths set.

Android reference for android.app.appsearch.SearchSpec.Builder.addFilterProperties.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to