SearchSuggestionSpec.Builder

Builder(maximumResultCount: @IntRange(from = 1) Int)

Creates an SearchSuggestionSpec.Builder object.

fun addFilterDocumentClasses(documentClasses: Array<Class<Any!>!>): SearchSuggestionSpec.Builder

Adds a schema filter to SearchSuggestionSpec Entry. Only search for suggestions that has documents under the specified schema.

If unset, the query will search over all schema.

Merged list available from getFilterSchemas.

fun addFilterDocumentClasses(
    documentClasses: (Mutable)Collection<Class<Any!>!>
): SearchSuggestionSpec.Builder

Adds the Schema names of given document classes to the Schema type filter of SearchSuggestionSpec Entry. Only search for suggestions that has documents under the specified schema.

If unset, the query will search over all schema.

Merged list available from getFilterSchemas.

fun addFilterDocumentIds(namespace: String, documentIds: Array<String!>): SearchSuggestionSpec.Builder

Adds a document ID filter to SearchSuggestionSpec Entry. Only search for suggestions in the given specified documents.

If unset, the query will search over all documents.

fun addFilterDocumentIds(
    namespace: String,
    documentIds: (Mutable)Collection<String!>
): SearchSuggestionSpec.Builder

Adds a document ID filter to SearchSuggestionSpec Entry. Only search for suggestions in the given specified documents.

If unset, the query will search over all documents.

fun addFilterNamespaces(namespaces: Array<String!>): SearchSuggestionSpec.Builder

Adds a namespace filter to SearchSuggestionSpec Entry. Only search for suggestions that has documents under the specified namespaces.

If unset, the query will search over all namespaces.

fun addFilterNamespaces(namespaces: (Mutable)Collection<String!>): SearchSuggestionSpec.Builder

Adds a namespace filter to SearchSuggestionSpec Entry. Only search for suggestions that has documents under the specified namespaces.

If unset, the query will search over all namespaces.

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SEARCH_SPEC_ADD_FILTER_PROPERTIES)
fun addFilterProperties(
    documentClass: Class<Any!>,
    propertyPaths: (Mutable)Collection<String!>
): SearchSuggestionSpec.Builder

Adds property paths for the specified type to the property filter of SearchSuggestionSpec Entry. Only search for suggestions that has content under the specified property. If property paths are added for a type, then only the properties referred to will be retrieved 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 retrieved.

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SEARCH_SPEC_ADD_FILTER_PROPERTIES)
fun addFilterProperties(
    schema: String,
    propertyPaths: (Mutable)Collection<String!>
): SearchSuggestionSpec.Builder

Adds property paths for the specified type to the property filter of SearchSuggestionSpec Entry. Only search for suggestions that has content under the specified property. If property paths are added for a type, then only the properties referred to will be retrieved 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 retrieved.

Example properties: 'body', 'sender.name', 'sender.emailaddress', etc.

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SEARCH_SPEC_ADD_FILTER_PROPERTIES)
fun addFilterPropertyPaths(
    documentClass: Class<Any!>,
    propertyPaths: (Mutable)Collection<PropertyPath!>
): SearchSuggestionSpec.Builder

Adds property paths for the specified type to the property filter of SearchSuggestionSpec Entry. Only search for suggestions that has content under the specified property. If property paths are added for a type, then only the properties referred to will be retrieved 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 retrieved.

@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.SEARCH_SPEC_ADD_FILTER_PROPERTIES)
fun addFilterPropertyPaths(
    schema: String,
    propertyPaths: (Mutable)Collection<PropertyPath!>
): SearchSuggestionSpec.Builder

Adds property paths for the specified type to the property filter of SearchSuggestionSpec Entry. Only search for suggestions that has content under the specified property. If property paths are added for a type, then only the properties referred to will be retrieved 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 retrieved.

fun addFilterSchemas(schemaTypes: Array<String!>): SearchSuggestionSpec.Builder

Adds a schema filter to SearchSuggestionSpec Entry. Only search for suggestions that has documents under the specified schema.

If unset, the query will search over all schema.

fun addFilterSchemas(schemaTypes: (Mutable)Collection<String!>): SearchSuggestionSpec.Builder

Adds a schema filter to SearchSuggestionSpec Entry. Only search for suggestions that has documents under the specified schema.

If unset, the query will search over all schema.

fun build(): SearchSuggestionSpec

Constructs a new SearchSpec from the contents of this builder.

fun setRankingStrategy(rankingStrategy: Int): SearchSuggestionSpec.Builder

Sets ranking strategy for suggestion results.

The default value SUGGESTION_RANKING_STRATEGY_DOCUMENT_COUNT will be used if this method is never called.