IntentFilter

Kotlin |Java

open class IntentFilter : Parcelable

kotlin.Any
↳	android.content.IntentFilter

Structured description of Intent values to be matched. An IntentFilter can match against actions, categories, and data (either via its type, scheme, and/or path) in an Intent. It also includes a "priority" value which is used to order multiple matching filters.

IntentFilter objects are often created in XML as part of a package's AndroidManifest.xml file, using intent-filter tags.

There are three Intent characteristics you can filter on: the action, data, and categories. For each of these characteristics you can provide multiple possible matching values (via addAction, addDataType, addDataScheme, addDataSchemeSpecificPart, addDataAuthority, addDataPath, and addCategory, respectively). For actions, if no data characteristics are specified, then the filter will only match intents that contain no data.

The data characteristic is itself divided into three attributes: type, scheme, authority, and path. Any that are specified must match the contents of the Intent. If you specify a scheme but no type, only Intent that does not have a type (such as mailto:) will match; a content: URI will never match because they always have a MIME type that is supplied by their content provider. Specifying a type with no scheme has somewhat special meaning: it will match either an Intent with no URI field, or an Intent with a content: or file: URI. If you specify neither, then only an Intent with no data or type will match. To specify an authority, you must also specify one or more schemes that it is associated with. To specify a path, you also must specify both one or more authorities and one or more schemes it is associated with.

Filter Rules

A match is based on the following rules. Note that for an IntentFilter to match an Intent, three conditions must hold: the action and category must match, and the data (both the data type and data scheme+authority+path if specified) must match (see match(android.content.ContentResolver,android.content.Intent,boolean,java.lang.String) for more details on how the data fields match).

Action matches if any of the given values match the Intent action; if the filter specifies no actions, then it will only match Intents that do not contain an action.

Data Type matches if any of the given values match the Intent type. The Intent type is determined by calling android.content.Intent#resolveType. A wildcard can be used for the MIME sub-type, in both the Intent and IntentFilter, so that the type "audio/*" will match "audio/mpeg", "audio/aiff", "audio/*", etc. Note that MIME type matching here is case sensitive, unlike formal RFC MIME types! You should thus always use lower case letters for your MIME types.

Data Scheme matches if any of the given values match the Intent data's scheme. The Intent scheme is determined by calling Intent#getData and android.net.Uri#getScheme on that URI. Note that scheme matching here is case sensitive, unlike formal RFC schemes! You should thus always use lower case letters for your schemes.

Data Scheme Specific Part matches if any of the given values match the Intent's data scheme specific part and one of the data schemes in the filter has matched the Intent, or no scheme specific parts were supplied in the filter. The Intent scheme specific part is determined by calling Intent#getData and android.net.Uri#getSchemeSpecificPart on that URI. Note that scheme specific part matching is case sensitive.

Data Authority matches if any of the given values match the Intent's data authority and one of the data schemes in the filter has matched the Intent, or no authorities were supplied in the filter. The Intent authority is determined by calling Intent#getData and android.net.Uri#getAuthority on that URI. Note that authority matching here is case sensitive, unlike formal RFC host names! You should thus always use lower case letters for your authority.

Data Path matches if any of the given values match the Intent's data path and both a scheme and authority in the filter has matched against the Intent, or no paths were supplied in the filter. The Intent authority is determined by calling Intent#getData and android.net.Uri#getPath on that URI.

Categories match if all of the categories in the Intent match categories given in the filter. Extra categories in the filter that are not in the Intent will not cause the match to fail. Note that unlike the action, an IntentFilter with no categories will only match an Intent that does not have any categories.

Summary

Nested classes
	`AuthorityEntry` This is an entry for a single authority in the Iterator returned by `authoritiesIterator()`.
open	`MalformedMimeTypeException` This exception is thrown when a given MIME type does not have a valid syntax.

Constants
static Int	`MATCH_ADJUSTMENT_MASK` The part of a match constant that applies a quality adjustment to the basic category of match.
static Int	`MATCH_ADJUSTMENT_NORMAL` Quality adjustment applied to the category of match that signifies the default, base value; higher numbers improve the quality while lower numbers reduce it.
static Int	`MATCH_CATEGORY_EMPTY` The filter matched an intent that had no data specified.
static Int	`MATCH_CATEGORY_HOST` The filter matched an intent with the same data URI scheme and authority host.
static Int	`MATCH_CATEGORY_MASK` The part of a match constant that describes the category of match that occurred.
static Int	`MATCH_CATEGORY_PATH` The filter matched an intent with the same data URI scheme, authority, and path.
static Int	`MATCH_CATEGORY_PORT` The filter matched an intent with the same data URI scheme and authority host and port.
static Int	`MATCH_CATEGORY_SCHEME` The filter matched an intent with the same data URI scheme.
static Int	`MATCH_CATEGORY_SCHEME_SPECIFIC_PART` The filter matched an intent with the same data URI scheme and scheme specific part.
static Int	`MATCH_CATEGORY_TYPE` The filter matched an intent with the same data MIME type.
static Int	`NO_MATCH_ACTION` The filter didn't match due to different actions.
static Int	`NO_MATCH_CATEGORY` The filter didn't match because it required one or more categories that were not in the Intent.
static Int	`NO_MATCH_DATA` The filter didn't match due to different data URIs.
static Int	`NO_MATCH_TYPE` The filter didn't match due to different MIME types.
static Int	`SYSTEM_HIGH_PRIORITY` The filter `setPriority` value at which system high-priority receivers are placed; that is, receivers that should execute before application code.
static Int	`SYSTEM_LOW_PRIORITY` The filter `setPriority` value at which system low-priority receivers are placed; that is, receivers that should execute after application code.

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 constructors
`IntentFilter()` New empty IntentFilter.
`IntentFilter(action: String!)` New IntentFilter that matches a single action with no data.
`IntentFilter(action: String!, dataType: String!)` New IntentFilter that matches a single action and data type.
`IntentFilter(o: IntentFilter!)` New IntentFilter containing a copy of an existing filter.

Public methods
MutableIterator<String!>!	`actionsIterator()` Return an iterator over the filter's actions.
Unit	`addAction(action: String!)` Add a new Intent action to match against.
Unit	`addCategory(category: String!)` Add a new Intent category to match against.
Unit	`addDataAuthority(host: String!, port: String!)` Add a new Intent data authority to match against.
Unit	`addDataPath(path: String!, type: Int)` Add a new Intent data path to match against.
Unit	`addDataScheme(scheme: String!)` Add a new Intent data scheme to match against.
Unit	`addDataSchemeSpecificPart(ssp: String!, type: Int)` Add a new Intent data "scheme specific part" to match against.
Unit	`addDataType(type: String!)` Add a new Intent data type to match against.
Unit	`addUriRelativeFilterGroup(group: UriRelativeFilterGroup)` Add a new URI relative filter group to match against the Intent data.
open Predicate<Intent!>	`asPredicate()` Return a `Predicate` which tests whether this filter matches the given intent.
open Predicate<Intent!>	`asPredicateWithTypeResolution(resolver: ContentResolver)` Return a `Predicate` which tests whether this filter matches the given intent.
MutableIterator<IntentFilter.AuthorityEntry!>!	`authoritiesIterator()` Return an iterator over the filter's data authorities.
MutableIterator<String!>!	`categoriesIterator()` Return an iterator over the filter's categories.
Unit	`clearUriRelativeFilterGroups()` Removes all existing URI relative filter groups in the intent filter.
Int	`countActions()` Return the number of actions in the filter.
Int	`countCategories()` Return the number of categories in the filter.
Int	`countDataAuthorities()` Return the number of data authorities in the filter.
Int	`countDataPaths()` Return the number of data paths in the filter.
Int	`countDataSchemeSpecificParts()` Return the number of data scheme specific parts in the filter.
Int	`countDataSchemes()` Return the number of data schemes in the filter.
Int	`countDataTypes()` Return the number of data types in the filter.
Int	`countUriRelativeFilterGroups()` Return the number of URI relative filter groups in the intent filter.
open static IntentFilter!	`create(action: String!, dataType: String!)` Create a new IntentFilter instance with a specified action and MIME type, where you know the MIME type is correctly formatted.
Int	`describeContents()`
open Unit	`dump(du: Printer!, prefix: String!)`
String!	`getAction(index: Int)` Return an action in the filter.
String!	`getCategory(index: Int)` Return a category in the filter.
IntentFilter.AuthorityEntry!	`getDataAuthority(index: Int)` Return a data authority in the filter.
PatternMatcher!	`getDataPath(index: Int)` Return a data path in the filter.
String!	`getDataScheme(index: Int)` Return a data scheme in the filter.
PatternMatcher!	`getDataSchemeSpecificPart(index: Int)` Return a data scheme specific part in the filter.
String!	`getDataType(index: Int)` Return a data type in the filter.
Int	`getPriority()` Return the priority of this filter.
UriRelativeFilterGroup	`getUriRelativeFilterGroup(index: Int)` Return a URI relative filter group in the intent filter.
Boolean	`hasAction(action: String!)` Is the given action included in the filter? Note that if the filter does not include any actions, false will always be returned.
Boolean	`hasCategory(category: String!)` Is the given category included in the filter?
Boolean	`hasDataAuthority(data: Uri!)` Is the given data authority included in the filter? Note that if the filter does not include any authorities, false will always be returned.
Boolean	`hasDataPath(data: String!)` Is the given data path included in the filter? Note that if the filter does not include any paths, false will always be returned.
Boolean	`hasDataScheme(scheme: String!)` Is the given data scheme included in the filter? Note that if the filter does not include any scheme, false will always be returned.
Boolean	`hasDataSchemeSpecificPart(data: String!)` Is the given data scheme specific part included in the filter? Note that if the filter does not include any scheme specific parts, false will always be returned.
Boolean	`hasDataType(type: String!)` Is the given data type included in the filter? Note that if the filter does not include any type, false will always be returned.
Int	`match(resolver: ContentResolver!, intent: Intent!, resolve: Boolean, logTag: String!)` Test whether this filter matches the given intent.
Int	`match(action: String!, type: String!, scheme: String!, data: Uri!, categories: MutableSet<String!>!, logTag: String!)` Test whether this filter matches the given intent data.
Boolean	`matchAction(action: String!)` Match this filter against an Intent's action.
String!	`matchCategories(categories: MutableSet<String!>!)` Match this filter against an Intent's categories.
Int	`matchData(type: String!, scheme: String!, data: Uri!)` Match this filter against an Intent's data (type, scheme and path).
Int	`matchDataAuthority(data: Uri!)` Match this intent filter against the given Intent data.
MutableIterator<PatternMatcher!>!	`pathsIterator()` Return an iterator over the filter's data paths.
open Unit	`readFromXml(parser: XmlPullParser!)`
MutableIterator<PatternMatcher!>!	`schemeSpecificPartsIterator()` Return an iterator over the filter's data scheme specific parts.
MutableIterator<String!>!	`schemesIterator()` Return an iterator over the filter's data schemes.
Unit	`setPriority(priority: Int)` Modify priority of this filter.
MutableIterator<String!>!	`typesIterator()` Return an iterator over the filter's data types.
Unit	`writeToParcel(dest: Parcel, flags: Int)`
open Unit	`writeToXml(serializer: XmlSerializer!)` Write the contents of the IntentFilter as an XML stream.

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

Parameters
`action`	String!: The action to match, such as Intent.ACTION_VIEW.
`dataType`	String!: The type to match, such as "vnd.android.cursor.dir/person".

Parameters
`host`	String!: The host part of the authority to match. May start with a single '*' to wildcard the front of the host name.
`port`	String!: Optional port part of the authority to match. If null, any port is allowed.

Parameters
`path`	String!: Either a raw string that must exactly match the file path, or a simple pattern, depending on type.
`type`	Int: Determines how path will be compared to determine a match: either `PatternMatcher#PATTERN_LITERAL`, `PatternMatcher#PATTERN_PREFIX`, `PatternMatcher#PATTERN_SUFFIX`, or `PatternMatcher#PATTERN_SIMPLE_GLOB`.

Parameters
`ssp`	String!: Either a raw string that must exactly match the scheme specific part path, or a simple pattern, depending on type.
`type`	Int: Determines how ssp will be compared to determine a match: either `PatternMatcher#PATTERN_LITERAL`, `PatternMatcher#PATTERN_PREFIX`, `PatternMatcher#PATTERN_SUFFIX`, or `PatternMatcher#PATTERN_SIMPLE_GLOB`.

Parameters
`intent`	Intent!: The Intent to compare against.
`resolve`	Boolean: If true, the intent's type will be resolved by calling Intent.resolveType(); otherwise a simple match against Intent.type will be performed.
`logTag`	String!: Tag to use in debugging messages.

Parameters
`action`	String!: The intent action to match against (Intent.getAction).
`type`	String!: The intent type to match against (Intent.resolveType()).
`scheme`	String!: The data scheme to match against (Intent.getScheme()).
`data`	Uri!: The data URI to match against (Intent.getData()).
`categories`	MutableSet<String!>!: The categories to match against (Intent.getCategories()).
`logTag`	String!: Tag to use in debugging messages.

Parameters
`type`	String!: The desired data type to look for, as returned by Intent.resolveType().
`scheme`	String!: The desired data scheme to look for, as returned by Intent.getScheme().
`data`	Uri!: The full data string to match against, as supplied in Intent.data.

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 `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

IntentFilter

Filter Rules

Summary

Constants

MATCH_ADJUSTMENT_MASK

MATCH_ADJUSTMENT_NORMAL

MATCH_CATEGORY_EMPTY

MATCH_CATEGORY_HOST

MATCH_CATEGORY_MASK

MATCH_CATEGORY_PATH

MATCH_CATEGORY_PORT

MATCH_CATEGORY_SCHEME

MATCH_CATEGORY_SCHEME_SPECIFIC_PART

MATCH_CATEGORY_TYPE

NO_MATCH_ACTION

NO_MATCH_CATEGORY

NO_MATCH_DATA

NO_MATCH_TYPE

SYSTEM_HIGH_PRIORITY

SYSTEM_LOW_PRIORITY

Public constructors

IntentFilter

IntentFilter

IntentFilter

IntentFilter

Public methods

actionsIterator

addAction

addCategory

addDataAuthority

addDataPath

addDataScheme

addDataSchemeSpecificPart

addDataType

addUriRelativeFilterGroup

asPredicate

asPredicateWithTypeResolution

authoritiesIterator

categoriesIterator

clearUriRelativeFilterGroups

countActions

countCategories

countDataAuthorities

countDataPaths

countDataSchemeSpecificParts

countDataSchemes

countDataTypes

countUriRelativeFilterGroups

create

describeContents

dump

getAction

getCategory

getDataAuthority

getDataPath

getDataScheme

getDataSchemeSpecificPart

getDataType

getPriority

getUriRelativeFilterGroup

hasAction

hasCategory

hasDataAuthority

hasDataPath

hasDataScheme

hasDataSchemeSpecificPart

hasDataType

match

match

matchAction

matchCategories

matchData

matchDataAuthority

pathsIterator

readFromXml

schemeSpecificPartsIterator

schemesIterator

setPriority

typesIterator

writeToParcel