Added in API level 26
Deprecated in API level 31

FontsContract.FontRequestCallback


public static class FontsContract.FontRequestCallback
extends Object

java.lang.Object
   ↳ android.provider.FontsContract.FontRequestCallback


This class was deprecated in API level 31.
Use the FontsContractCompat.FontRequestCallback for consistent behavior across all devices

Interface used to receive asynchronously fetched typefaces.

Summary

Constants

int FAIL_REASON_FONT_LOAD_ERROR

Constant returned by onTypefaceRequestFailed(int) signaling that the font returned by the provider was not loaded properly.

int FAIL_REASON_FONT_NOT_FOUND

Constant returned by onTypefaceRequestFailed(int) signaling that the font provider did not return any results for the given query.

int FAIL_REASON_FONT_UNAVAILABLE

Constant returned by onTypefaceRequestFailed(int) signaling that the font provider found the queried font, but it is currently unavailable.

int FAIL_REASON_MALFORMED_QUERY

Constant returned by onTypefaceRequestFailed(int) signaling that the given query was not supported by the provider.

int FAIL_REASON_PROVIDER_NOT_FOUND

Constant returned by onTypefaceRequestFailed(int) signaling that the given provider was not found on the device.

int FAIL_REASON_WRONG_CERTIFICATES

Constant returned by onTypefaceRequestFailed(int) signaling that the given provider must be authenticated and the given certificates do not match its signature.

Public constructors

FontRequestCallback()

Public methods

void onTypefaceRequestFailed(int reason)

Called when a Typeface request done via FontsContract.requestFonts(Context, FontRequest, Handler, CancellationSignal, FontRequestCallback)} fails.

void onTypefaceRetrieved(Typeface typeface)

Called then a Typeface request done via FontsContract.requestFonts(Context, FontRequest, Handler, CancellationSignal, FontRequestCallback) is complete.

Inherited methods

Constants

FAIL_REASON_FONT_LOAD_ERROR

Added in API level 26
public static final int FAIL_REASON_FONT_LOAD_ERROR

Constant returned by onTypefaceRequestFailed(int) signaling that the font returned by the provider was not loaded properly.

Constant Value: -3 (0xfffffffd)

FAIL_REASON_FONT_NOT_FOUND

Added in API level 26
public static final int FAIL_REASON_FONT_NOT_FOUND

Constant returned by onTypefaceRequestFailed(int) signaling that the font provider did not return any results for the given query.

Constant Value: 1 (0x00000001)

FAIL_REASON_FONT_UNAVAILABLE

Added in API level 26
public static final int FAIL_REASON_FONT_UNAVAILABLE

Constant returned by onTypefaceRequestFailed(int) signaling that the font provider found the queried font, but it is currently unavailable.

Constant Value: 2 (0x00000002)

FAIL_REASON_MALFORMED_QUERY

Added in API level 26
public static final int FAIL_REASON_MALFORMED_QUERY

Constant returned by onTypefaceRequestFailed(int) signaling that the given query was not supported by the provider.

Constant Value: 3 (0x00000003)

FAIL_REASON_PROVIDER_NOT_FOUND

Added in API level 26
public static final int FAIL_REASON_PROVIDER_NOT_FOUND

Constant returned by onTypefaceRequestFailed(int) signaling that the given provider was not found on the device.

Constant Value: -1 (0xffffffff)

FAIL_REASON_WRONG_CERTIFICATES

Added in API level 26
public static final int FAIL_REASON_WRONG_CERTIFICATES

Constant returned by onTypefaceRequestFailed(int) signaling that the given provider must be authenticated and the given certificates do not match its signature.

Constant Value: -2 (0xfffffffe)

Public constructors

FontRequestCallback

Added in API level 26
public FontRequestCallback ()

Public methods

onTypefaceRequestFailed

Added in API level 26
public void onTypefaceRequestFailed (int reason)

Called when a Typeface request done via FontsContract.requestFonts(Context, FontRequest, Handler, CancellationSignal, FontRequestCallback)} fails.

Parameters
reason int: One of FAIL_REASON_PROVIDER_NOT_FOUND, FAIL_REASON_FONT_NOT_FOUND, FAIL_REASON_FONT_LOAD_ERROR, FAIL_REASON_FONT_UNAVAILABLE or FAIL_REASON_MALFORMED_QUERY if returned by the system. May also be a positive value greater than 0 defined by the font provider as an additional error code. Refer to the provider's documentation for more information on possible returned error codes. Value is FAIL_REASON_PROVIDER_NOT_FOUND, FAIL_REASON_FONT_LOAD_ERROR, FAIL_REASON_FONT_NOT_FOUND, FAIL_REASON_FONT_UNAVAILABLE, or FAIL_REASON_MALFORMED_QUERY

onTypefaceRetrieved

Added in API level 26
public void onTypefaceRetrieved (Typeface typeface)

Called then a Typeface request done via FontsContract.requestFonts(Context, FontRequest, Handler, CancellationSignal, FontRequestCallback) is complete. Note that this method will not be called if onTypefaceRequestFailed(int) is called instead.

Parameters
typeface Typeface: The Typeface object retrieved.