OverlayManagerTransaction
public
final
class
OverlayManagerTransaction
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.content.om.OverlayManagerTransaction |
A container for a batch of requests to the OverlayManager.
An app can get an OverlayManagerTransaction
with the specified OverlayManager
to handle the transaction. The app can register multiple overlays and unregister multiple
registered overlays in one transaction commitment.
The below example is registering a updatingOverlay
and unregistering a deprecatedOverlay
in one transaction commitment.
final OverlayManager overlayManager = ctx.getSystemService(OverlayManager.class);
final OverlayManagerTransaction transaction = new OverlayManagerTransaction(overlayManager);
transaction.registerFabricatedOverlay(updatingOverlay);
transaction.unregisterFabricatedOverlay(deprecatedOverlay)
transaction.commit();
See also:
Summary
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<OverlayManagerTransaction> |
CREATOR
|
Public methods | |
---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
static
OverlayManagerTransaction
|
newInstance()
Get an overlay manager transaction. |
void
|
registerFabricatedOverlay(FabricatedOverlay overlay)
Registers the fabricated overlays with the overlay manager so it can be used to overlay the app resources in runtime. |
void
|
unregisterFabricatedOverlay(OverlayIdentifier overlay)
Unregisters the registered overlays from the overlay manager. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
Fields
Public methods
describeContents
public int describeContents ()
Describe the kinds of special objects contained in this Parcelable
instance's marshaled representation. For example, if the object will
include a file descriptor in the output of writeToParcel(android.os.Parcel, int)
,
the return value of this method must include the
CONTENTS_FILE_DESCRIPTOR
bit.
Returns | |
---|---|
int |
a bitmask indicating the set of special object types marshaled
by this Parcelable object instance.
Value is either 0 or CONTENTS_FILE_DESCRIPTOR |
newInstance
public static OverlayManagerTransaction newInstance ()
Get an overlay manager transaction.
Returns | |
---|---|
OverlayManagerTransaction |
a new OverlayManagerTransaction instance.
This value cannot be null . |
registerFabricatedOverlay
public void registerFabricatedOverlay (FabricatedOverlay overlay)
Registers the fabricated overlays with the overlay manager so it can be used to overlay the app resources in runtime.
If an overlay is re-registered the existing overlay will be replaced by the newly registered overlay. The registered overlay will be left unchanged until the target package or target overlayable is changed.
Parameters | |
---|---|
overlay |
FabricatedOverlay : the overlay to register with the overlay manager
This value cannot be null . |
Returns | |
---|---|
void |
This value cannot be null . |
unregisterFabricatedOverlay
public void unregisterFabricatedOverlay (OverlayIdentifier overlay)
Unregisters the registered overlays from the overlay manager.
Parameters | |
---|---|
overlay |
OverlayIdentifier : the overlay to be unregistered
This value cannot be null . |
Returns | |
---|---|
void |
This value cannot be null . |
writeToParcel
public void writeToParcel (Parcel dest, int flags)
Flatten this object in to a Parcel.
Parameters | |
---|---|
dest |
Parcel : This value cannot be null . |
flags |
int : Additional flags about how the object should be written.
May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE .
Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |