HintFilter

Kotlin |Java

class HintFilter : Parcelable

kotlin.Any
↳	android.app.personalcontext.hint.HintFilter

Filter for hint refiners and understanders to indicate which hints they want to receive. The filter can be a combination of different criteria, such as the publisher's package or the type of ContextHint. Each parameter can be customized with a number of filter flags. Specifying FILTER_TYPE_ALLOWED limits the returned set to only include the those hints that match the associated filter. Specifying FILTER_TYPE_FILTER_TYPE_REQUIRED means that a hint matching this filter must be present for the set to be returned.

Summary

Nested classes
	`Builder` Builder for a `HintFilter`.

Constants
static Int	`FILTER_TYPE_ALLOWED` Flag indicating that only hints matching this filter should be included.
static Int	`FILTER_TYPE_NONE` Flag indicating no filter is applied
static Int	`FILTER_TYPE_REQUIRED` Flag indicating that the returned set must include a hint that matches this filter.

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
Int	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
MutableSet<Class<Any!>!>	`getHintTypes()` Returns the `ContextHint` classes within this filter.
MutableSet<Class<Any!>!>	`getHintTypes(filter: Int)` Returns the `ContextHint` classes within this filter.
MutableSet<String!>	`getPackages()` Returns the publishing packages checked for within this filter.
MutableSet<String!>	`getPackages(filter: Int)` Returns the publishing packages checked for within this filter.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<HintFilter!>	`CREATOR`

Constants

FILTER_TYPE_ALLOWED

Added in API level 37.2

static val FILTER_TYPE_ALLOWED: Int

Flag indicating that only hints matching this filter should be included.

Value: 1

FILTER_TYPE_NONE

Added in API level 37.2

static val FILTER_TYPE_NONE: Int

Flag indicating no filter is applied

Value: 0

FILTER_TYPE_REQUIRED

Added in API level 37.2

static val FILTER_TYPE_REQUIRED: Int

Flag indicating that the returned set must include a hint that matches this filter.

Value: 2

Public methods

describeContents

Added in API level 37.2

fun describeContents(): Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

getHintTypes

Added in API level 37.2

fun getHintTypes(): MutableSet<Class<Any!>!>

Returns the ContextHint classes within this filter.

Return
`MutableSet<Class<Any!>!>`	A set of classes in the filter that match the supplied filter type flags.

getHintTypes

Added in API level 37.2

fun getHintTypes(filter: Int): MutableSet<Class<Any!>!>

Returns the ContextHint classes within this filter.

Parameters
`filter`	Int: the android.app.personalcontext.hint.HintFilter.FilterType flags that should be set on the filters for returned `ContextHint` classes. Value is either `0` or a combination of the following: `FILTER_TYPE_NONE` `FILTER_TYPE_ALLOWED` `FILTER_TYPE_REQUIRED`

Return
`MutableSet<Class<Any!>!>`	A set of classes in the filter that match the supplied filter type flags.

getPackages

Added in API level 37.2

fun getPackages(): MutableSet<String!>

Returns the publishing packages checked for within this filter.

Return
`MutableSet<String!>`	A set of package names in the filter.

getPackages

Added in API level 37.2

fun getPackages(filter: Int): MutableSet<String!>

Returns the publishing packages checked for within this filter.

Parameters
`filter`	Int: the android.app.personalcontext.hint.HintFilter.FilterType flags that should be set on the matching filters. Value is either `0` or a combination of the following: `FILTER_TYPE_NONE` `FILTER_TYPE_ALLOWED` `FILTER_TYPE_REQUIRED`

Return
`MutableSet<String!>`	A set of package names in the filter that match the supplied filter type flags.

writeToParcel

Added in API level 37.2

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
`dest`	Parcel: The Parcel in which the object should be written. This value cannot be `null`.
`flags`	Int: Additional flags about how the object should be written. May be 0 or `PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: `PARCELABLE_WRITE_RETURN_VALUE`

Properties

CREATOR

Added in API level 37.2

static val CREATOR: Parcelable.Creator<HintFilter!>