IconCompat

const val TYPE_ADAPTIVE_BITMAP = 5: Int

An icon that was created using createWithAdaptiveBitmap.

const val TYPE_BITMAP = 1: Int

An icon that was created using createWithBitmap.

const val TYPE_DATA = 3: Int

An icon that was created using createWithData.

const val TYPE_RESOURCE = 2: Int

An icon that was created using createWithResource.

const val TYPE_UNKNOWN = -1: Int

Value returned when the type of an Icon cannot be determined.

const val TYPE_URI = 4: Int

An icon that was created using createWithContentUri.

const val TYPE_URI_ADAPTIVE_BITMAP = 6: Int

An icon that was created using createWithAdaptiveBitmapContentUri.

java-static fun createFromBundle(bundle: Bundle): IconCompat?

Extracts an icon from a bundle that was added using toBundle.

@RequiresApi(value = 23)
java-static fun createFromIcon(context: Context, icon: Icon): IconCompat?

Creates an IconCompat from an Icon.

java-static fun createWithAdaptiveBitmap(bits: Bitmap): IconCompat

Create an Icon pointing to a bitmap in memory that follows the icon design guideline defined by android.graphics.drawable.AdaptiveIconDrawable.

java-static fun createWithAdaptiveBitmapContentUri(uri: String): IconCompat

Create an Icon pointing to an image file specified by URI. Image file should follow the icon design guideline defined by AdaptiveIconDrawable.

java-static fun createWithAdaptiveBitmapContentUri(uri: Uri): IconCompat

Create an Icon pointing to an image file specified by URI. Image file should follow the icon design guideline defined by AdaptiveIconDrawable.

java-static fun createWithBitmap(bits: Bitmap): IconCompat

Create an Icon pointing to a bitmap in memory.

java-static fun createWithContentUri(uri: String): IconCompat

Create an Icon pointing to an image file specified by URI.

java-static fun createWithContentUri(uri: Uri): IconCompat

Create an Icon pointing to an image file specified by URI.

java-static fun createWithData(data: ByteArray, offset: Int, length: Int): IconCompat

Create an Icon pointing to a compressed bitmap stored in a byte array.

java-static fun createWithResource(context: Context, resId: @DrawableRes Int): IconCompat

Create an Icon pointing to a drawable resource.

fun getResId(): @DrawableRes Int

Gets the drawable resource id used to create this icon.

Only valid for icons of type TYPE_RESOURCE. Note: This resource may not be available if the application changes at all, and it is up to the caller to ensure safety if this resource is re-used and/or persisted.

fun getResPackage(): String

Gets the package used to create this icon.

Only valid for icons of type TYPE_RESOURCE. Note: This package may not be available if referenced in the future, and it is up to the caller to ensure safety if this package is re-used and/or persisted.

fun getType(): Int

Gets the type of the icon provided.

Note that new types may be added later, so callers should guard against other types being returned.

fun getUri(): Uri

Gets the uri used to create this icon.

Only valid for icons of type TYPE_URI. Note: This uri may not be available in the future, and it is up to the caller to ensure safety if this uri is re-used and/or persisted.

fun loadDrawable(context: Context): Drawable?

Returns a Drawable that can be used to draw the image inside this Icon, constructing it if necessary.

fun onPostParceling(): Unit

Called immediately after this object has been deserialized, can be used to handle any custom fields that cannot be easily annotated.

fun onPreParceling(isStream: Boolean): Unit

Called immediately before this object is going to be serialized, can be used to handle any custom fields that cannot be easily annotated.

fun setTint(tint: @ColorInt Int): IconCompat

Store a color to use whenever this Icon is drawn.

fun setTintList(tintList: ColorStateList?): IconCompat

Store a color to use whenever this Icon is drawn.

fun setTintMode(mode: PorterDuff.Mode?): IconCompat

Store a blending mode to use whenever this Icon is drawn.

fun toBundle(): Bundle

Adds this Icon to a Bundle that can be read back with the same parameters to createFromBundle.

@RequiresApi(value = 23)
fun toIcon(context: Context?): Icon

Convert this compat object to Icon object.