PropertyDefinedNode

@ExperimentalAppSearchApi
class PropertyDefinedNode : FunctionNode

FunctionNode representing the `propertyDefined` query function.

The `propertyDefined` query function will return all documents of types that define the given property. This will include documents that do not have the property itself, so long as that property is a part of the document's schema.

If you need to restrict to documents that have >=1 value(s) populated for that property, see HasPropertyNode.

Summary

Public constructors

Constructor for a PropertyDefinedNode representing the query function `propertyDefined` that takes in a PropertyPath.

Public functions
Boolean
equals(o: Any!)
String

Returns the name of the function represented by PropertyDefinedNode.
PropertyPath

Returns the PropertyDefinedNode representing the property being checked for in the document.
Int
Unit

Sets the property being checked for in the document, as represented by PropertyDefinedNode.
String

Get the string representation of PropertyDefinedNode.

Inherited Constants
From androidx.appsearch.ast.FunctionNode
const String!
FUNCTION_NAME_GET_SEARCH_STRING_PARAMETER = "getSearchStringParameter"

Name of the query function represented by androidx.appsearch.ast.query.GetSearchStringParameterNode.
const String!

Name of the query function represented by androidx.appsearch.ast.query.HasPropertyNode.
const String!
FUNCTION_NAME_PROPERTY_DEFINED = "propertyDefined"

Name of the query function represented by androidx.appsearch.ast.query.PropertyDefinedNode.
const String!

Name of the query function represented by androidx.appsearch.ast.query.SearchNode.
const String!

Name of the query function represented by androidx.appsearch.ast.query.SemanticSearchNode.

Inherited functions
From androidx.appsearch.ast.Node
(Mutable)List<Node!>

Get a list of the node's child Nodes.

Public constructors

PropertyDefinedNode

Added in 1.1.0-alpha07
PropertyDefinedNode(property: PropertyPath)

Constructor for a PropertyDefinedNode representing the query function `propertyDefined` that takes in a PropertyPath.

Public functions

equals

fun equals(o: Any!): Boolean

getFunctionName

Added in 1.1.0-alpha07
fun getFunctionName(): String

Returns the name of the function represented by PropertyDefinedNode.

getProperty

Added in 1.1.0-alpha07
fun getProperty(): PropertyPath

Returns the PropertyDefinedNode representing the property being checked for in the document.

hashCode

fun hashCode(): Int

setProperty

Added in 1.1.0-alpha07
fun setProperty(property: PropertyPath): Unit

Sets the property being checked for in the document, as represented by PropertyDefinedNode.

toString

fun toString(): String

Get the string representation of PropertyDefinedNode.

The string representation of PropertyDefinedNode is the function name followed by the property path in quotes surrounded by parentheses.