IconCompat

public static final int TYPE_ADAPTIVE_BITMAP = 5

An icon that was created using createWithAdaptiveBitmap.

public static final int TYPE_BITMAP = 1

An icon that was created using createWithBitmap.

public static final int TYPE_DATA = 3

An icon that was created using createWithData.

public static final int TYPE_RESOURCE = 2

An icon that was created using createWithResource.

public static final int TYPE_UNKNOWN = -1

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

public static final int TYPE_URI = 4

An icon that was created using createWithContentUri.

public static final int TYPE_URI_ADAPTIVE_BITMAP = 6

An icon that was created using createWithAdaptiveBitmapContentUri.

public static @Nullable IconCompat createFromBundle(@NonNull Bundle bundle)

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

@RequiresApi(value = 23)
public static @NonNull IconCompat createFromIcon(@NonNull Context context, @NonNull Icon icon)

Creates an IconCompat from an Icon.

public static @NonNull IconCompat createWithAdaptiveBitmap(@NonNull Bitmap bits)

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

public static @NonNull IconCompat createWithAdaptiveBitmapContentUri(@NonNull String uri)

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

public static @NonNull IconCompat createWithAdaptiveBitmapContentUri(@NonNull Uri uri)

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

public static @NonNull IconCompat createWithBitmap(@NonNull Bitmap bits)

Create an Icon pointing to a bitmap in memory.

public static @NonNull IconCompat createWithContentUri(@NonNull String uri)

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

public static @NonNull IconCompat createWithContentUri(@NonNull Uri uri)

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

public static @NonNull IconCompat createWithData(@NonNull byte[] data, int offset, int length)

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

public static @NonNull IconCompat createWithResource(@NonNull Context context, @DrawableRes int resId)

Create an Icon pointing to a drawable resource.

public @DrawableRes int getResId()

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.

public @NonNull String getResPackage()

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.

public int getType()

Gets the type of the icon provided.

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

public @NonNull Uri getUri()

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.

public @Nullable Drawable loadDrawable(@NonNull Context context)

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

public void onPostParceling()

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

public void onPreParceling(boolean isStream)

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

public @NonNull IconCompat setTint(@ColorInt int tint)

Store a color to use whenever this Icon is drawn.

public @NonNull IconCompat setTintList(@Nullable ColorStateList tintList)

Store a color to use whenever this Icon is drawn.

public @NonNull IconCompat setTintMode(@Nullable PorterDuff.Mode mode)

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

public @NonNull Bundle toBundle()

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

@RequiresApi(value = 23)
public @NonNull Icon toIcon(@Nullable Context context)

Convert this compat object to Icon object.