Added in API level 26
Deprecated in API level 31

FontsContract


open class FontsContract
kotlin.Any
   ↳ android.provider.FontsContract

Utility class to deal with Font ContentProviders.

Summary

Nested classes

Defines the constants used in a response from a Font Provider.

open

Object returned from fetchFonts.

open

Object represent a font entry in the family returned from fetchFonts.

open

Interface used to receive asynchronously fetched typefaces.

Public methods
open static Typeface!
buildTypeface(context: Context, cancellationSignal: CancellationSignal?, fonts: Array<FontsContract.FontInfo!>)

Build a Typeface from an array of FontInfo Results that are marked as not ready will be skipped.

open static FontsContract.FontFamilyResult
fetchFonts(context: Context, cancellationSignal: CancellationSignal?, request: FontRequest)

Fetch fonts given a font request.

open static Unit
requestFonts(context: Context, request: FontRequest, handler: Handler, cancellationSignal: CancellationSignal?, callback: FontsContract.FontRequestCallback)

Create a typeface object given a font request.

Public methods

buildTypeface

Added in API level 26
open static fun buildTypeface(
    context: Context,
    cancellationSignal: CancellationSignal?,
    fonts: Array<FontsContract.FontInfo!>
): Typeface!

Deprecated: Deprecated in Java.

Build a Typeface from an array of FontInfo Results that are marked as not ready will be skipped.

Parameters
context Context: A Context that will be used to fetch the font contents. This value cannot be null.
cancellationSignal CancellationSignal?: A signal to cancel the operation in progress, or null if none. If the operation is canceled, then will be thrown.
fonts Array<FontsContract.FontInfo!>: An array of FontInfo to be used to create a Typeface. This value cannot be null.
Return
Typeface! A Typeface object. Returns null if typeface creation fails.

fetchFonts

Added in API level 26
open static fun fetchFonts(
    context: Context,
    cancellationSignal: CancellationSignal?,
    request: FontRequest
): FontsContract.FontFamilyResult

Deprecated: Deprecated in Java.

Fetch fonts given a font request.

Parameters
context Context: A Context to be used for fetching fonts. This value cannot be null.
cancellationSignal CancellationSignal?: A signal to cancel the operation in progress, or null if none. If the operation is canceled, then will be thrown when the query is executed.
request FontRequest: A FontRequest object that identifies the provider and query for the request. This value cannot be null.
Return
FontsContract.FontFamilyResult FontFamilyResult This value cannot be null.
Exceptions
android.content.pm.PackageManager.NameNotFoundException If requested package or authority was not found in system.

requestFonts

Added in API level 26
open static fun requestFonts(
    context: Context,
    request: FontRequest,
    handler: Handler,
    cancellationSignal: CancellationSignal?,
    callback: FontsContract.FontRequestCallback
): Unit

Deprecated: Deprecated in Java.

Create a typeface object given a font request. The font will be asynchronously fetched, therefore the result is delivered to the given callback. See FontRequest. Only one of the methods in callback will be invoked, depending on whether the request succeeds or fails. These calls will happen on the caller thread. Note that the result Typeface may be cached internally and the same instance will be returned the next time you call this method with the same request. If you want to bypass this cache, use fetchFonts and buildTypeface instead.

Parameters
context Context: A context to be used for fetching from font provider. This value cannot be null.
request FontRequest: A FontRequest object that identifies the provider and query for the request. May not be null.
handler Handler: A handler to be processed the font fetching. This value cannot be null.
cancellationSignal CancellationSignal?: A signal to cancel the operation in progress, or null if none. If the operation is canceled, then will be thrown.
callback FontsContract.FontRequestCallback: A callback that will be triggered when results are obtained. May not be null.