AppSearchSchema.PropertyConfig.Description Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Returns a natural language description of this property.
public virtual string Description { [Android.Runtime.Register("getDescription", "()Ljava/lang/String;", "GetGetDescriptionHandler", ApiSince=36)] get; }[<get: Android.Runtime.Register("getDescription", "()Ljava/lang/String;", "GetGetDescriptionHandler", ApiSince=36)>]
member this.Description : stringProperty Value
- Attributes
Remarks
Returns a natural language description of this property.
Ex. The description for the "homeAddress" property of a "Person" type could be "the address at which this person lives".
This information is purely to help apps consuming this type the semantic meaning of its properties. This field has no effect in AppSearch - it is just stored with the AppSearchSchema. If the description is not set, then this method will return an empty string.
Java documentation for android.app.appsearch.AppSearchSchema.PropertyConfig.getDescription().
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.