public
final
class
AppWidgetEvent
extends Object
implements
Parcelable
| java.lang.Object | |
| ↳ | android.appwidget.AppWidgetEvent |
An immutable class that describes the event data for an app widget interaction event.
Inherited constants |
|---|
Fields | |
|---|---|
public
static
final
Creator<AppWidgetEvent> |
CREATOR
Parcelable.Creator that instantiates AppWidgetEvent objects |
Public methods | |
|---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
int
|
getAppWidgetId()
The app widget ID of the widget that generated this event. |
int[]
|
getClickedIds()
This returns the set of View IDs of the views which have been clicked during the event time range. |
Instant
|
getEnd()
Describes the end of the time range that this event contains data for. |
Rect
|
getPosition()
This rect with describes the global coordinates of the widget at the end of the event time range. |
int[]
|
getScrolledIds()
This returns the set of View IDs of the views which have been scrolled during the event time range. |
Instant
|
getStart()
Describes the start of the time range that this event contains data for. |
Duration
|
getVisibleDuration()
Describes the total duration of time during which the widget was visible. |
String
|
toString()
Returns a string representation of the object. |
void
|
writeToParcel(Parcel out, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
|---|---|
public static final Creator<AppWidgetEvent> CREATOR
Parcelable.Creator that instantiates AppWidgetEvent objects
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(Parcel,int),
the return value of this method must include the
CONTENTS_FILE_DESCRIPTOR bit.
int0 or
public int getAppWidgetId ()
The app widget ID of the widget that generated this event.
| Returns | |
|---|---|
int |
|
See also:
public int[] getClickedIds ()
This returns the set of View IDs of the views which have been clicked during the event time
range. Use RemoteViews.setAppWidgetEventTag(int, int) to set a custom
integer tag on a view for reporting clicks. If the tag is set, it will be used here instead
of the View ID.
| Returns | |
|---|---|
int[] |
This value may be null. |
public Instant getEnd ()
Describes the end of the time range that this event contains data for.
| Returns | |
|---|---|
Instant |
This value cannot be null. |
public Rect getPosition ()
This rect with describes the global coordinates of the widget at the end of the event time range.
| Returns | |
|---|---|
Rect |
This value may be null. |
public int[] getScrolledIds ()
This returns the set of View IDs of the views which have been scrolled during the event time
range. Use RemoteViews.setAppWidgetEventTag(int, int) to set a custom
integer tag on a view for reporting scrolls. If the tag is set, it will be used here instead
of the View ID.
| Returns | |
|---|---|
int[] |
This value may be null. |
public Instant getStart ()
Describes the start of the time range that this event contains data for.
| Returns | |
|---|---|
Instant |
This value cannot be null. |
public Duration getVisibleDuration ()
Describes the total duration of time during which the widget was visible. This may be
different than the event time range (between getStart() and getEnd() if the
widget was hidden and shown multiple times during the event time range.
| Returns | |
|---|---|
Duration |
This value cannot be null. |
public String toString ()
Returns a string representation of the object.
| Returns | |
|---|---|
String |
a string representation of the object. |
public void writeToParcel (Parcel out,
int flags)Flatten this object in to a Parcel.
outParcel: This value cannot be null.flagsint: Additional flags about how the object should be written.
May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.
0 or a combination of the following:
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2026-02-26 UTC.