Language

AppSearchSchema.Description Property

Definition

Returns a natural language description of this schema type.

public string Description { [Android.Runtime.Register("getDescription", "()Ljava/lang/String;", "", ApiSince=36)] get; }
[<get: Android.Runtime.Register("getDescription", "()Ljava/lang/String;", "", ApiSince=36)>]
member this.Description : string

Property Value

Attributes

Remarks

Returns a natural language description of this schema type.

Ex. The description for an Email type could be "A type of electronic message".

This information is purely to help apps consuming this type to understand its semantic meaning. This field has no effect in AppSearch - it is just stored with the AppSearchSchema. If Builder#setDescription is uncalled, then this method will return an empty string.

Java documentation for android.app.appsearch.AppSearchSchema.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.

Applies to