Linkify

Kotlin |Java

open class Linkify

kotlin.Any
↳	android.text.util.Linkify

Linkify take a piece of text and a regular expression and turns all of the regex matches in the text into clickable links. This is particularly useful for matching things like email addresses, web URLs, etc. and making them actionable. Alone with the pattern that is to be matched, a URL scheme prefix is also required. Any pattern match that does not begin with the supplied scheme will have the scheme prepended to the matched text when the clickable URL is created. For instance, if you are matching web URLs you would supply the scheme http://. If the pattern matches example.com, which does not have a URL scheme prefix, the supplied scheme will be prepended to create http://example.com when the clickable URL link is created.

Note: When using MAP_ADDRESSES or ALL to match street addresses on API level android.os.Build.VERSION_CODES#O_MR1 and earlier, methods in this class may throw android.util.AndroidRuntimeException or other exceptions if the device's WebView implementation is currently being updated, because android.webkit.WebView#findAddress is required to match street addresses.

Summary

Nested classes
abstract	`MatchFilter` MatchFilter enables client code to have more control over what is allowed to match and become a link, and what is not.
abstract	`TransformFilter` TransformFilter enables client code to have more control over how matched patterns are represented as URLs.

Constants
static Int	`ALL` Bit mask indicating that all available patterns should be matched in methods that take an options mask.
static Int	`EMAIL_ADDRESSES` Bit field indicating that email addresses should be matched in methods that take an options mask
static Int	`MAP_ADDRESSES` Bit field indicating that street addresses should be matched in methods that take an options mask.
static Int	`PHONE_NUMBERS` Bit field indicating that phone numbers should be matched in methods that take an options mask
static Int	`WEB_URLS` Bit field indicating that web URLs should be matched in methods that take an options mask

Public constructors
`Linkify()`

Public methods
static Boolean	`addLinks(text: Spannable, mask: Int)` Scans the text of the provided Spannable and turns all occurrences of the link types indicated in the mask into clickable links.
static Boolean	`addLinks(text: Spannable, mask: Int, urlSpanFactory: Function<String!, URLSpan!>?)` Scans the text of the provided Spannable and turns all occurrences of the link types indicated in the mask into clickable links.
static Boolean	`addLinks(text: TextView, mask: Int)` Scans the text of the provided TextView and turns all occurrences of the link types indicated in the mask into clickable links.
static Unit	`addLinks(text: TextView, pattern: Pattern, scheme: String?)` Applies a regex to the text of a TextView turning the matches into links.
static Unit	`addLinks(text: TextView, pattern: Pattern, scheme: String?, matchFilter: Linkify.MatchFilter?, transformFilter: Linkify.TransformFilter?)` Applies a regex to the text of a TextView turning the matches into links.
static Unit	`addLinks(text: TextView, pattern: Pattern, defaultScheme: String?, schemes: Array<String!>?, matchFilter: Linkify.MatchFilter?, transformFilter: Linkify.TransformFilter?)` Applies a regex to the text of a TextView turning the matches into links.
static Boolean	`addLinks(text: Spannable, pattern: Pattern, scheme: String?)` Applies a regex to a Spannable turning the matches into links.
static Boolean	`addLinks(spannable: Spannable, pattern: Pattern, scheme: String?, matchFilter: Linkify.MatchFilter?, transformFilter: Linkify.TransformFilter?)` Applies a regex to a Spannable turning the matches into links.
static Boolean	`addLinks(spannable: Spannable, pattern: Pattern, defaultScheme: String?, schemes: Array<String!>?, matchFilter: Linkify.MatchFilter?, transformFilter: Linkify.TransformFilter?)` Applies a regex to a Spannable turning the matches into links.
static Boolean	`addLinks(spannable: Spannable, pattern: Pattern, defaultScheme: String?, schemes: Array<String!>?, matchFilter: Linkify.MatchFilter?, transformFilter: Linkify.TransformFilter?, urlSpanFactory: Function<String!, URLSpan!>?)` Applies a regex to a Spannable turning the matches into links.

Properties
static Linkify.MatchFilter!	`sPhoneNumberMatchFilter` Filters out URL matches that don't have enough digits to be a phone number.
static Linkify.TransformFilter!	`sPhoneNumberTransformFilter` Transforms matched phone number text into something suitable to be used in a tel: URL.
static Linkify.MatchFilter!	`sUrlMatchFilter` Filters out web URL matches that occur after an at-sign (@).

Constants

ALL

Added in API level 1
Deprecated in API level 33

static val ALL: Int

Deprecated: use android.view.textclassifier.TextClassifier#generateLinks( * TextLinks.Request) instead, and avoid ALL even when targeting API levels where no alternative is available.

Bit mask indicating that all available patterns should be matched in methods that take an options mask. Note that this should be avoided, as the MAP_ADDRESSES field uses the android.webkit.WebView#findAddress( * String) method, which has various limitations and has been deprecated: see the documentation for android.webkit.WebView#findAddress(String) for more information.

Value: 15

EMAIL_ADDRESSES

Added in API level 1

static val EMAIL_ADDRESSES: Int

Bit field indicating that email addresses should be matched in methods that take an options mask

Value: 2

MAP_ADDRESSES

Added in API level 1
Deprecated in API level 28

static val MAP_ADDRESSES: Int

Deprecated: use android.view.textclassifier.TextClassifier#generateLinks( * TextLinks.Request) instead, and avoid MAP_ADDRESSES even when targeting API levels where no alternative is available.

Bit field indicating that street addresses should be matched in methods that take an options mask. Note that this should be avoided, as it uses the android.webkit.WebView#findAddress(String) method, which has various limitations and has been deprecated: see the documentation for android.webkit.WebView#findAddress(String) for more information.

Value: 8

PHONE_NUMBERS

Added in API level 1

static val PHONE_NUMBERS: Int

Bit field indicating that phone numbers should be matched in methods that take an options mask

Value: 4

WEB_URLS

Added in API level 1

static val WEB_URLS: Int

Bit field indicating that web URLs should be matched in methods that take an options mask

Value: 1

Public constructors

Linkify

Linkify()

Public methods

addLinks

Added in API level 1

static fun addLinks(
    text: Spannable, 
    mask: Int
): Boolean

Scans the text of the provided Spannable and turns all occurrences of the link types indicated in the mask into clickable links. If the mask is nonzero, it also removes any existing URLSpans attached to the Spannable, to avoid problems if you call it repeatedly on the same text.

Parameters
`text`	Spannable: Spannable whose text is to be marked-up with links This value cannot be `null`.
`mask`	Int: Mask to define which kinds of links will be searched. Value is either `0` or a combination of `android.text.util.Linkify#WEB_URLS`, `android.text.util.Linkify#EMAIL_ADDRESSES`, `android.text.util.Linkify#PHONE_NUMBERS`, `android.text.util.Linkify#MAP_ADDRESSES`, and `android.text.util.Linkify#ALL`

Return
`Boolean`	True if at least one link is found and applied.

See Also

#addLinks(Spannable, int, Function)

addLinks

Added in API level 29

static fun addLinks(
    text: Spannable, 
    mask: Int, 
    urlSpanFactory: Function<String!, URLSpan!>?
): Boolean

Parameters
`text`	Spannable: Spannable whose text is to be marked-up with links This value cannot be `null`.
`mask`	Int: mask to define which kinds of links will be searched Value is either `0` or a combination of `android.text.util.Linkify#WEB_URLS`, `android.text.util.Linkify#EMAIL_ADDRESSES`, `android.text.util.Linkify#PHONE_NUMBERS`, `android.text.util.Linkify#MAP_ADDRESSES`, and `android.text.util.Linkify#ALL`
`urlSpanFactory`	Function<String!, URLSpan!>?: function used to create `URLSpan`s This value may be `null`.

Return
`Boolean`	True if at least one link is found and applied.

addLinks

Added in API level 1

static fun addLinks(
    text: TextView, 
    mask: Int
): Boolean

Scans the text of the provided TextView and turns all occurrences of the link types indicated in the mask into clickable links. If matches are found the movement method for the TextView is set to LinkMovementMethod.

Parameters
`text`	TextView: TextView whose text is to be marked-up with links This value cannot be `null`.
`mask`	Int: Mask to define which kinds of links will be searched. Value is either `0` or a combination of `android.text.util.Linkify#WEB_URLS`, `android.text.util.Linkify#EMAIL_ADDRESSES`, `android.text.util.Linkify#PHONE_NUMBERS`, `android.text.util.Linkify#MAP_ADDRESSES`, and `android.text.util.Linkify#ALL`

Return
`Boolean`	True if at least one link is found and applied.

See Also

#addLinks(Spannable, int, Function)

addLinks

Added in API level 1

static fun addLinks(
    text: TextView, 
    pattern: Pattern, 
    scheme: String?
): Unit

Applies a regex to the text of a TextView turning the matches into links. If links are found then UrlSpans are applied to the link text match areas, and the movement method for the text is changed to LinkMovementMethod.

Parameters
`text`	TextView: TextView whose text is to be marked-up with links This value cannot be `null`.
`pattern`	Pattern: Regex pattern to be used for finding links This value cannot be `null`.
`scheme`	String?: URL scheme string (eg `http://`) to be prepended to the links that do not start with this scheme. This value may be `null`.

addLinks

Added in API level 1

static fun addLinks(
    text: TextView, 
    pattern: Pattern, 
    scheme: String?, 
    matchFilter: Linkify.MatchFilter?, 
    transformFilter: Linkify.TransformFilter?
): Unit

Parameters
`text`	TextView: TextView whose text is to be marked-up with links This value cannot be `null`.
`pattern`	Pattern: Regex pattern to be used for finding links This value cannot be `null`.
`scheme`	String?: URL scheme string (eg `http://`) to be prepended to the links that do not start with this scheme. This value may be `null`.
`matchFilter`	Linkify.MatchFilter?: The filter that is used to allow the client code additional control over which pattern matches are to be converted into links. This value may be `null`.
`transformFilter`	Linkify.TransformFilter?: This value may be `null`.

addLinks

Added in API level 24

static fun addLinks(
    text: TextView, 
    pattern: Pattern, 
    defaultScheme: String?, 
    schemes: Array<String!>?, 
    matchFilter: Linkify.MatchFilter?, 
    transformFilter: Linkify.TransformFilter?
): Unit

Parameters
`text`	TextView: TextView whose text is to be marked-up with links. This value cannot be `null`.
`pattern`	Pattern: Regex pattern to be used for finding links. This value cannot be `null`.
`defaultScheme`	String?: The default scheme to be prepended to links if the link does not start with one of the `schemes` given. This value may be `null`.
`schemes`	Array<String!>?: Array of schemes (eg `http://`) to check if the link found contains a scheme. Passing a null or empty value means prepend defaultScheme to all links.
`matchFilter`	Linkify.MatchFilter?: The filter that is used to allow the client code additional control over which pattern matches are to be converted into links. This value may be `null`.
`transformFilter`	Linkify.TransformFilter?: Filter to allow the client code to update the link found. This value may be `null`.

addLinks

Added in API level 1

static fun addLinks(
    text: Spannable, 
    pattern: Pattern, 
    scheme: String?
): Boolean

Applies a regex to a Spannable turning the matches into links.

Parameters
`text`	Spannable: Spannable whose text is to be marked-up with links This value cannot be `null`.
`pattern`	Pattern: Regex pattern to be used for finding links This value cannot be `null`.
`scheme`	String?: URL scheme string (eg `http://`) to be prepended to the links that do not start with this scheme. This value may be `null`.

See Also

#addLinks(Spannable, Pattern, String, String[], MatchFilter, TransformFilter, Function)

addLinks

Added in API level 1

static fun addLinks(
    spannable: Spannable, 
    pattern: Pattern, 
    scheme: String?, 
    matchFilter: Linkify.MatchFilter?, 
    transformFilter: Linkify.TransformFilter?
): Boolean

Applies a regex to a Spannable turning the matches into links.

Parameters
`spannable`	Spannable: Spannable whose text is to be marked-up with links This value cannot be `null`.
`pattern`	Pattern: Regex pattern to be used for finding links This value cannot be `null`.
`scheme`	String?: URL scheme string (eg `http://`) to be prepended to the links that do not start with this scheme. This value may be `null`.
`matchFilter`	Linkify.MatchFilter?: The filter that is used to allow the client code additional control over which pattern matches are to be converted into links. This value may be `null`.
`transformFilter`	Linkify.TransformFilter?: Filter to allow the client code to update the link found. This value may be `null`.

Return
`Boolean`	True if at least one link is found and applied.

See Also

#addLinks(Spannable, Pattern, String, String[], MatchFilter, TransformFilter, Function)

addLinks

Added in API level 24

static fun addLinks(
    spannable: Spannable, 
    pattern: Pattern, 
    defaultScheme: String?, 
    schemes: Array<String!>?, 
    matchFilter: Linkify.MatchFilter?, 
    transformFilter: Linkify.TransformFilter?
): Boolean

Applies a regex to a Spannable turning the matches into links.

Parameters
`spannable`	Spannable: Spannable whose text is to be marked-up with links. This value cannot be `null`.
`pattern`	Pattern: Regex pattern to be used for finding links. This value cannot be `null`.
`defaultScheme`	String?: The default scheme to be prepended to links if the link does not start with one of the `schemes` given. This value may be `null`.
`schemes`	Array<String!>?: Array of schemes (eg `http://`) to check if the link found contains a scheme. Passing a null or empty value means prepend defaultScheme to all links.
`matchFilter`	Linkify.MatchFilter?: The filter that is used to allow the client code additional control over which pattern matches are to be converted into links. This value may be `null`.
`transformFilter`	Linkify.TransformFilter?: Filter to allow the client code to update the link found. This value may be `null`.

Return
`Boolean`	True if at least one link is found and applied.

See Also

#addLinks(Spannable, Pattern, String, String[], MatchFilter, TransformFilter, Function)

addLinks

Added in API level 29

static fun addLinks(
    spannable: Spannable, 
    pattern: Pattern, 
    defaultScheme: String?, 
    schemes: Array<String!>?, 
    matchFilter: Linkify.MatchFilter?, 
    transformFilter: Linkify.TransformFilter?, 
    urlSpanFactory: Function<String!, URLSpan!>?
): Boolean

Applies a regex to a Spannable turning the matches into links.

Parameters
`spannable`	Spannable: spannable whose text is to be marked-up with links. This value cannot be `null`.
`pattern`	Pattern: regex pattern to be used for finding links. This value cannot be `null`.
`defaultScheme`	String?: the default scheme to be prepended to links if the link does not start with one of the `schemes` given. This value may be `null`.
`schemes`	Array<String!>?: array of schemes (eg `http://`) to check if the link found contains a scheme. Passing a null or empty value means prepend defaultScheme to all links.
`matchFilter`	Linkify.MatchFilter?: the filter that is used to allow the client code additional control over which pattern matches are to be converted into links. This value may be `null`.
`transformFilter`	Linkify.TransformFilter?: filter to allow the client code to update the link found. This value may be `null`.
`urlSpanFactory`	Function<String!, URLSpan!>?: function used to create `URLSpan`s This value may be `null`.

Return
`Boolean`	True if at least one link is found and applied.

Properties

sPhoneNumberMatchFilter

Added in API level 1

static val sPhoneNumberMatchFilter: Linkify.MatchFilter!

Filters out URL matches that don't have enough digits to be a phone number.

sPhoneNumberTransformFilter

Added in API level 1

static val sPhoneNumberTransformFilter: Linkify.TransformFilter!

Transforms matched phone number text into something suitable to be used in a tel: URL. It does this by removing everything but the digits and plus signs. For instance: '+1 (919) 555-1212' becomes '+19195551212'

sUrlMatchFilter

Added in API level 1

static val sUrlMatchFilter: Linkify.MatchFilter!

Filters out web URL matches that occur after an at-sign (@). This is to prevent turning the domain name in an email address into a web link.