Added in API level 1

Summary: Nested Classes | Constants | Fields | Ctors | Methods | Inherited Methods

Linkify

---

Kotlin |Java

public class Linkify
extends Object

java.lang.Object
↳	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 Build.VERSION_CODES.O_MR1 and earlier, methods in this class may throw AndroidRuntimeException or other exceptions if the device's WebView implementation is currently being updated, because WebView.findAddress(String) is required to match street addresses.

See also:

• Linkify.MatchFilter
• Linkify.TransformFilter

Summary

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

Constants
int	ALL This constant was deprecated in API level 33. use TextClassifier.generateLinks(TextLinks.Request) instead, and avoid ALL even when targeting API levels where no alternative is available.
int	EMAIL_ADDRESSES Bit field indicating that email addresses should be matched in methods that take an options mask
int	MAP_ADDRESSES This constant was deprecated in API level 28. use TextClassifier.generateLinks(TextLinks.Request) instead, and avoid MAP_ADDRESSES even when targeting API levels where no alternative is available.
int	PHONE_NUMBERS Bit field indicating that phone numbers should be matched in methods that take an options mask
int	WEB_URLS Bit field indicating that web URLs should be matched in methods that take an options mask

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

Public constructors
Linkify()

Public methods
static final void	addLinks(TextView text, Pattern pattern, String scheme, Linkify.MatchFilter matchFilter, Linkify.TransformFilter transformFilter) Applies a regex to the text of a TextView turning the matches into links.
static final void	addLinks(TextView text, Pattern pattern, String defaultScheme, String[] schemes, Linkify.MatchFilter matchFilter, Linkify.TransformFilter transformFilter) Applies a regex to the text of a TextView turning the matches into links.
static final boolean	addLinks(Spannable spannable, Pattern pattern, String defaultScheme, String[] schemes, Linkify.MatchFilter matchFilter, Linkify.TransformFilter transformFilter) Applies a regex to a Spannable turning the matches into links.
static final boolean	addLinks(Spannable text, Pattern pattern, String scheme) Applies a regex to a Spannable turning the matches into links.
static final boolean	addLinks(Spannable spannable, Pattern pattern, String defaultScheme, String[] schemes, Linkify.MatchFilter matchFilter, Linkify.TransformFilter transformFilter, Function<String, URLSpan> urlSpanFactory) Applies a regex to a Spannable turning the matches into links.
static final boolean	addLinks(Spannable text, int mask) Scans the text of the provided Spannable and turns all occurrences of the link types indicated in the mask into clickable links.
static final void	addLinks(TextView text, Pattern pattern, String scheme) Applies a regex to the text of a TextView turning the matches into links.
static final boolean	addLinks(Spannable text, int mask, Function<String, URLSpan> urlSpanFactory) Scans the text of the provided Spannable and turns all occurrences of the link types indicated in the mask into clickable links.
static final boolean	addLinks(Spannable spannable, Pattern pattern, String scheme, Linkify.MatchFilter matchFilter, Linkify.TransformFilter transformFilter) Applies a regex to a Spannable turning the matches into links.
static final boolean	addLinks(TextView text, int mask) Scans the text of the provided TextView and turns all occurrences of the link types indicated in the mask into clickable links.

Inherited methods

From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

ALL

Added in API level 1
Deprecated in API level 33

public static final int ALL

This constant was deprecated in API level 33.
use 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 WebView.findAddress(String) method, which has various limitations and has been deprecated: see the documentation for WebView.findAddress(String) for more information.

Constant Value: 15 (0x0000000f)

EMAIL_ADDRESSES

Added in API level 1

public static final int EMAIL_ADDRESSES

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

Constant Value: 2 (0x00000002)

MAP_ADDRESSES

Added in API level 1
Deprecated in API level 28

public static final int MAP_ADDRESSES

This constant was deprecated in API level 28.
use 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 WebView.findAddress(String) method, which has various limitations and has been deprecated: see the documentation for WebView.findAddress(String) for more information.

Constant Value: 8 (0x00000008)

PHONE_NUMBERS

Added in API level 1

public static final int PHONE_NUMBERS

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

Constant Value: 4 (0x00000004)

WEB_URLS

Added in API level 1

public static final int WEB_URLS

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

Constant Value: 1 (0x00000001)

Fields

sPhoneNumberMatchFilter

Added in API level 1

public static final Linkify.MatchFilter sPhoneNumberMatchFilter

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

sPhoneNumberTransformFilter

Added in API level 1

public static final Linkify.TransformFilter sPhoneNumberTransformFilter

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: '[phone]' becomes '[phone]'

sUrlMatchFilter

Added in API level 1

public static final Linkify.MatchFilter sUrlMatchFilter

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.

Public constructors

Linkify

public Linkify ()

Public methods

addLinks

Added in API level 1

public static final void addLinks (TextView text, 
                Pattern pattern, 
                String scheme, 
                Linkify.MatchFilter matchFilter, 
                Linkify.TransformFilter transformFilter)

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.
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

public static final void addLinks (TextView text, 
                Pattern pattern, 
                String defaultScheme, 
                String[] schemes, 
                Linkify.MatchFilter matchFilter, 
                Linkify.TransformFilter transformFilter)

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.
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	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 24

public static final boolean addLinks (Spannable spannable, 
                Pattern pattern, 
                String defaultScheme, 
                String[] schemes, 
                Linkify.MatchFilter matchFilter, 
                Linkify.TransformFilter transformFilter)

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	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.

Returns
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 1

public static final boolean addLinks (Spannable text, 
                Pattern pattern, 
                String scheme)

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.

Returns
boolean

See also:

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

addLinks

Added in API level 29

public static final boolean addLinks (Spannable spannable, 
                Pattern pattern, 
                String defaultScheme, 
                String[] schemes, 
                Linkify.MatchFilter matchFilter, 
                Linkify.TransformFilter transformFilter, 
                Function<String, URLSpan> urlSpanFactory)

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	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: function used to create URLSpans This value may be null.

Returns
boolean	True if at least one link is found and applied.

addLinks

Added in API level 1

public static final boolean addLinks (Spannable text, 
                int mask)

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 WEB_URLS, EMAIL_ADDRESSES, PHONE_NUMBERS, MAP_ADDRESSES, and ALL

Returns
boolean	True if at least one link is found and applied.

See also:

• addLinks(Spannable, int, Function)

addLinks

Added in API level 1

public static final void addLinks (TextView text, 
                Pattern pattern, 
                String scheme)

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 29

public static final boolean addLinks (Spannable text, 
                int mask, 
                Function<String, URLSpan> urlSpanFactory)

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 WEB_URLS, EMAIL_ADDRESSES, PHONE_NUMBERS, MAP_ADDRESSES, and ALL
urlSpanFactory	Function: function used to create URLSpans This value may be null.

Returns
boolean	True if at least one link is found and applied.

addLinks

Added in API level 1

public static final boolean addLinks (Spannable spannable, 
                Pattern pattern, 
                String scheme, 
                Linkify.MatchFilter matchFilter, 
                Linkify.TransformFilter transformFilter)

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.

Returns
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 1

public static final boolean addLinks (TextView text, 
                int mask)

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 WEB_URLS, EMAIL_ADDRESSES, PHONE_NUMBERS, MAP_ADDRESSES, and ALL

Returns
boolean	True if at least one link is found and applied.

See also:

• addLinks(Spannable, int, Function)